From b692152d174c14b82c21980f6fbba1650f2146a5 Mon Sep 17 00:00:00 2001 From: Chandan Agrawal <121222832+cagrawal-msft@users.noreply.github.com> Date: Thu, 30 May 2024 02:49:44 +0530 Subject: [PATCH 01/49] Updating Swagger for new xlsAccountServiceMetada EnableExtendedGroups (#29142) --- .../2023-05-01/examples/NfsV3AccountCreate.json | 2 ++ .../2023-05-01/examples/StorageAccountUpdate.json | 2 ++ .../stable/2023-05-01/storage.json | 15 +++++++++++++++ 3 files changed, 19 insertions(+) diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/NfsV3AccountCreate.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/NfsV3AccountCreate.json index 23570b0409d5..927e1675521c 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/NfsV3AccountCreate.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/NfsV3AccountCreate.json @@ -13,6 +13,7 @@ "properties": { "isHnsEnabled": true, "isNfsV3Enabled": true, + "enableExtendedGroups": true, "supportsHttpsTrafficOnly": false, "networkAcls": { "bypass": "AzureServices", @@ -37,6 +38,7 @@ "properties": { "isHnsEnabled": true, "isNfsV3Enabled": true, + "enableExtendedGroups": true, "supportsHttpsTrafficOnly": false, "networkAcls": { "bypass": "AzureServices", diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/StorageAccountUpdate.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/StorageAccountUpdate.json index 86a597eebf4b..dbd1a19b3769 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/StorageAccountUpdate.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/StorageAccountUpdate.json @@ -17,6 +17,7 @@ "allowBlobPublicAccess": false, "isSftpEnabled": true, "isLocalUserEnabled": true, + "enableExtendedGroups": true, "defaultToOAuthAuthentication": false, "minimumTlsVersion": "TLS1_2", "allowSharedKeyAccess": true, @@ -73,6 +74,7 @@ "allowBlobPublicAccess": false, "isSftpEnabled": true, "isLocalUserEnabled": true, + "enableExtendedGroups": true, "minimumTlsVersion": "TLS1_2", "allowSharedKeyAccess": true, "creationTime": "2017-06-01T02:42:41.7633306Z", diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storage.json index ff7a5b6d31c3..11a1214a3c3f 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storage.json @@ -3215,6 +3215,11 @@ "x-ms-client-name": "IsLocalUserEnabled", "description": "Enables local users feature, if set to true" }, + "enableExtendedGroups": { + "type": "boolean", + "x-ms-client-name": "EnableExtendedGroups", + "description": "Enables extended group support with local users feature, if set to true" + }, "isHnsEnabled": { "type": "boolean", "x-ms-client-name": "IsHnsEnabled", @@ -3882,6 +3887,11 @@ "x-ms-client-name": "IsLocalUserEnabled", "description": "Enables local users feature, if set to true" }, + "enableExtendedGroups": { + "type": "boolean", + "x-ms-client-name": "EnableExtendedGroups", + "description": "Enables extended group support with local users feature, if set to true" + }, "isHnsEnabled": { "type": "boolean", "x-ms-client-name": "IsHnsEnabled", @@ -4222,6 +4232,11 @@ "x-ms-client-name": "IsLocalUserEnabled", "description": "Enables local users feature, if set to true" }, + "enableExtendedGroups": { + "type": "boolean", + "x-ms-client-name": "EnableExtendedGroups", + "description": "Enables extended group support with local users feature, if set to true" + }, "networkAcls": { "description": "Network rule set", "x-ms-client-name": "NetworkRuleSet", From 19b66613827a0acf8fbbd0a4c2d9cbef9f2f5899 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Wed, 29 May 2024 14:23:03 -0700 Subject: [PATCH 02/49] [TypeSpecValidation] Add tests for LinterRuleset (#29267) --- .../src/rules/linter-ruleset.ts | 8 +- .../test/linter-ruleset.test.ts | 99 +++++++++++++++++++ 2 files changed, 102 insertions(+), 5 deletions(-) create mode 100644 eng/tools/typespec-validation/test/linter-ruleset.test.ts diff --git a/eng/tools/typespec-validation/src/rules/linter-ruleset.ts b/eng/tools/typespec-validation/src/rules/linter-ruleset.ts index 818245000003..c6aee71db104 100644 --- a/eng/tools/typespec-validation/src/rules/linter-ruleset.ts +++ b/eng/tools/typespec-validation/src/rules/linter-ruleset.ts @@ -1,4 +1,3 @@ -import { readFile } from "fs/promises"; import { join } from "path"; import { parse as yamlParse } from "yaml"; import { Rule } from "../rule.js"; @@ -16,12 +15,11 @@ export class LinterRulesetRule implements Rule { let stdOutput = ""; let errorOutput = ""; - const configFile = join(folder, "tspconfig.yaml"); - const configText = await readFile(configFile, "utf8"); + const configText = await host.readTspConfig(folder); const config = yamlParse(configText); const rpFolder = - config.options?.["@azure-tools/typespec-autorest"]?.["azure-resource-provider-folder"]; + config?.options?.["@azure-tools/typespec-autorest"]?.["azure-resource-provider-folder"]; stdOutput += `azure-resource-provider-folder: ${JSON.stringify(rpFolder)}\n`; const mainTspExists = await host.checkFileExists(join(folder, "main.tsp")); @@ -35,7 +33,7 @@ export class LinterRulesetRule implements Rule { } stdOutput += `files: ${JSON.stringify(files)}\n`; - const linterExtends = config.linter?.extends; + const linterExtends = config?.linter?.extends; stdOutput += `linter.extends: ${JSON.stringify(linterExtends)}`; let requiredRuleset = ""; diff --git a/eng/tools/typespec-validation/test/linter-ruleset.test.ts b/eng/tools/typespec-validation/test/linter-ruleset.test.ts new file mode 100644 index 000000000000..b830b262e8f5 --- /dev/null +++ b/eng/tools/typespec-validation/test/linter-ruleset.test.ts @@ -0,0 +1,99 @@ +import { describe, it } from "vitest"; +import { join } from "path"; +import { LinterRulesetRule } from "../src/rules/linter-ruleset.js"; +import { TsvTestHost } from "./tsv-test-host.js"; +import { strict as assert } from "node:assert"; + +describe("linter-ruleset", function () { + it("succeeds with default config", async function () { + const host = new TsvTestHost(); + const result = await new LinterRulesetRule().execute(host, TsvTestHost.folder); + assert(result.success); + }); + + it("succeeds with resource-manager/resource-manager", async function () { + const host = new TsvTestHost(); + host.readTspConfig = async (_folder: string) => ` +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "resource-manager" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" +`; + const result = await new LinterRulesetRule().execute(host, TsvTestHost.folder); + assert(result.success); + }); + + it("succeeds with data-plane/data-plane", async function () { + const host = new TsvTestHost(); + host.readTspConfig = async (_folder: string) => ` +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/data-plane" +`; + const result = await new LinterRulesetRule().execute(host, TsvTestHost.folder); + assert(result.success); + }); + + it("succeeds with client.tsp/data-plane", async function () { + const host = new TsvTestHost(); + host.checkFileExists = async (file: string) => file === join(TsvTestHost.folder, "client.tsp"); + host.readTspConfig = async (_folder: string) => ` +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/data-plane" +`; + const result = await new LinterRulesetRule().execute(host, TsvTestHost.folder); + assert(result.success); + }); + + it("fails with no-config", async function () { + const host = new TsvTestHost(); + host.readTspConfig = async (_folder: string) => ""; + const result = await new LinterRulesetRule().execute(host, TsvTestHost.folder); + assert(!result.success); + }); + + it("fails with resource-manager/no-linter", async function () { + const host = new TsvTestHost(); + host.readTspConfig = async (_folder: string) => ` +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "resource-manager" +`; + const result = await new LinterRulesetRule().execute(host, TsvTestHost.folder); + assert(!result.success); + }); + + it("fails with resource-manager/data-plane", async function () { + const host = new TsvTestHost(); + host.readTspConfig = async (_folder: string) => ` +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "resource-manager" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/data-plane" +`; + const result = await new LinterRulesetRule().execute(host, TsvTestHost.folder); + assert(!result.success); + }); + + it("fails with data-plane/resource-manager", async function () { + const host = new TsvTestHost(); + host.readTspConfig = async (_folder: string) => ` +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" +`; + const result = await new LinterRulesetRule().execute(host, TsvTestHost.folder); + assert(!result.success); + }); +}); From 34f8f3fa251276229e64680c29abe1d194559661 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Wed, 29 May 2024 17:35:07 -0700 Subject: [PATCH 03/49] [TypeSpecValidation/LinterRuleset] Fail if deprecated rulesets detected (#29270) --- .../src/rules/linter-ruleset.ts | 33 ++++++++++++++++++- .../test/linter-ruleset.test.ts | 31 +++++++++++++++++ 2 files changed, 63 insertions(+), 1 deletion(-) diff --git a/eng/tools/typespec-validation/src/rules/linter-ruleset.ts b/eng/tools/typespec-validation/src/rules/linter-ruleset.ts index c6aee71db104..5bc11f75bbc6 100644 --- a/eng/tools/typespec-validation/src/rules/linter-ruleset.ts +++ b/eng/tools/typespec-validation/src/rules/linter-ruleset.ts @@ -4,6 +4,15 @@ import { Rule } from "../rule.js"; import { RuleResult } from "../rule-result.js"; import { TsvHost } from "../tsv-host.js"; +// Maps deprecated rulesets to the replacement rulesets +const deprecatedRulesets = new Map([ + ["@azure-tools/typespec-azure-core/all", "@azure-tools/typespec-azure-rulesets/data-plane"], + [ + "@azure-tools/typespec-azure-resource-manager/all", + "@azure-tools/typespec-azure-rulesets/resource-manager", + ], +]); + export class LinterRulesetRule implements Rule { readonly name = "LinterRuleset"; @@ -33,7 +42,7 @@ export class LinterRulesetRule implements Rule { } stdOutput += `files: ${JSON.stringify(files)}\n`; - const linterExtends = config?.linter?.extends; + const linterExtends: string[] = config?.linter?.extends; stdOutput += `linter.extends: ${JSON.stringify(linterExtends)}`; let requiredRuleset = ""; @@ -57,6 +66,28 @@ export class LinterRulesetRule implements Rule { ' azure-resource-provider-folder: "data-plane" | "resource-manager"\n'; } + if (linterExtends) { + for (const ruleset of linterExtends) { + if (deprecatedRulesets.has(ruleset)) { + const newRuleset = deprecatedRulesets.get(ruleset); + + success = false; + errorOutput += + "tspconfig.yaml references the following ruleset which is deprecated:\n" + + "\n" + + "linter:\n" + + " extends:\n" + + ` - "${ruleset}"\n` + + "\n" + + "It should be replaced with the following:\n" + + "\n" + + "linter:\n" + + " extends:\n" + + ` - "${newRuleset}"`; + } + } + } + if (requiredRuleset && !linterExtends?.includes(requiredRuleset)) { success = false; errorOutput += diff --git a/eng/tools/typespec-validation/test/linter-ruleset.test.ts b/eng/tools/typespec-validation/test/linter-ruleset.test.ts index b830b262e8f5..83b4ffb2928a 100644 --- a/eng/tools/typespec-validation/test/linter-ruleset.test.ts +++ b/eng/tools/typespec-validation/test/linter-ruleset.test.ts @@ -96,4 +96,35 @@ linter: const result = await new LinterRulesetRule().execute(host, TsvTestHost.folder); assert(!result.success); }); + + it("fails with data-plane/old-and-new", async function () { + const host = new TsvTestHost(); + host.readTspConfig = async (_folder: string) => ` +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" +linter: + extends: + - "@azure-tools/typespec-azure-core/all" + - "@azure-tools/typespec-azure-rulesets/data-plane" +`; + const result = await new LinterRulesetRule().execute(host, TsvTestHost.folder); + assert(!result.success); + }); + + it("fails with resource-manager/old-and-new", async function () { + const host = new TsvTestHost(); + host.readTspConfig = async (_folder: string) => ` +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "resource-manager" +linter: + extends: + - "@azure-tools/typespec-azure-resource-manager/all" + - "@azure-tools/typespec-azure-rulesets/resource-manager" +`; + const result = await new LinterRulesetRule().execute(host, TsvTestHost.folder); + + assert(!result.success); + }); }); From fba917faefdd37873aea9eb998b8f114c5e5b7c5 Mon Sep 17 00:00:00 2001 From: Jingshu918 <138486531+Jingshu918@users.noreply.github.com> Date: Thu, 30 May 2024 11:07:35 +0800 Subject: [PATCH 04/49] Add Credential Property In DynamicsCrm For New Feature (#29238) --- .../stable/2018-06-01/entityTypes/LinkedService.json | 4 ++++ .../stable/2020-12-01/entityTypes/LinkedService.json | 4 ++++ 2 files changed, 8 insertions(+) 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 253337b25372..632413244135 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 @@ -1165,6 +1165,10 @@ "$ref": "../datafactory.json#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." + }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." 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 359379078172..38b9bd7b9079 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 @@ -1040,6 +1040,10 @@ "$ref": "../artifacts.json#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, + "credential": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The credential reference containing authentication information." + }, "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." From 7605afe88e3201dc25ce0881c2e49fe1b6bbdd54 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Thu, 30 May 2024 16:06:44 +0800 Subject: [PATCH 05/49] [mongocluster] update python config (#29259) * update python config * java config --------- Co-authored-by: XiaofeiCao --- .../DocumentDB.MongoCluster.Management/client.tsp | 6 ++++++ .../tspconfig.yaml | 13 +++++++++++++ .../mongocluster/resource-manager/readme.java.md | 8 ++++++++ 3 files changed, 27 insertions(+) create mode 100644 specification/mongocluster/DocumentDB.MongoCluster.Management/client.tsp create mode 100644 specification/mongocluster/resource-manager/readme.java.md diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/client.tsp b/specification/mongocluster/DocumentDB.MongoCluster.Management/client.tsp new file mode 100644 index 000000000000..f83c0d2b10a0 --- /dev/null +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/client.tsp @@ -0,0 +1,6 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(Microsoft.DocumentDB, "MongoClusterMgmtClient", "python"); diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml index 02f18067ec6b..8efab22596a5 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml @@ -1,3 +1,6 @@ +parameters: + "service-dir": + default: "sdk/mongocluster" emit: - "@azure-tools/typespec-autorest" options: @@ -7,6 +10,16 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/mongoCluster.json" examples-directory: "{project-root}/examples" + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-mongocluster" + package-name: "{package-dir}" + flavor: "azure" + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-mongocluster" + flavor: "azure" + namespace: "com.azure.resourcemanager.mongocluster" + service-name: "Mongo Cluster" + examples-directory: "examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/mongocluster/resource-manager/readme.java.md b/specification/mongocluster/resource-manager/readme.java.md new file mode 100644 index 000000000000..f1c6a40aa333 --- /dev/null +++ b/specification/mongocluster/resource-manager/readme.java.md @@ -0,0 +1,8 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +```yaml $(java) +service-name: Mongo Cluster +client-flattened-annotation-target: disabled +``` From ce625c0d7b282e36ed5d0c28e4c23a2fa4f9ddbb Mon Sep 17 00:00:00 2001 From: Udit Sharma Date: Thu, 30 May 2024 07:12:36 -0700 Subject: [PATCH 06/49] Add TLS 1_3 support for storage (#29175) * Add TLS 1_3 support for storage * Add support for account level cold access tier --------- Co-authored-by: Udit Sharma --- .../stable/2023-05-01/storage.json | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storage.json index 11a1214a3c3f..c0064a7b3cc8 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storage.json @@ -3189,7 +3189,8 @@ "enum": [ "Hot", "Cool", - "Premium" + "Premium", + "Cold" ], "x-ms-enum": { "name": "AccessTier", @@ -3252,7 +3253,8 @@ "enum": [ "TLS1_0", "TLS1_1", - "TLS1_2" + "TLS1_2", + "TLS1_3" ], "x-ms-enum": { "name": "MinimumTlsVersion", @@ -3855,7 +3857,8 @@ "enum": [ "Hot", "Cool", - "Premium" + "Premium", + "Cold" ], "x-ms-enum": { "name": "AccessTier", @@ -3950,7 +3953,8 @@ "enum": [ "TLS1_0", "TLS1_1", - "TLS1_2" + "TLS1_2", + "TLS1_3" ], "x-ms-enum": { "name": "MinimumTlsVersion", @@ -4206,7 +4210,8 @@ "enum": [ "Hot", "Cool", - "Premium" + "Premium", + "Cold" ], "x-ms-enum": { "name": "AccessTier", @@ -4269,7 +4274,8 @@ "enum": [ "TLS1_0", "TLS1_1", - "TLS1_2" + "TLS1_2", + "TLS1_3" ], "x-ms-enum": { "name": "MinimumTlsVersion", From 51031c3dc961c33be93afe1f15d35acfe5999861 Mon Sep 17 00:00:00 2001 From: qfai <404630507@qq.com> Date: Thu, 30 May 2024 22:13:12 +0800 Subject: [PATCH 07/49] Qfai developerhub microsoft.dev hub 2024 05 01 preview (#29229) * add iac endpoints * change workflow v3 to v5 * fix module validation error --------- Co-authored-by: qfai --- cSpell.json | 12 + .../examples/GeneratePreviewArtifacts.json | 30 + .../examples/GitHubOAuth.json | 18 + .../examples/GitHubOAuthCallback.json | 21 + .../examples/GitHubOAuth_List.json | 23 + .../examples/IacProfile_CreateOrUpdate.json | 224 ++++ .../examples/IacProfile_Delete.json | 12 + .../examples/IacProfile_ExportTemplate.json | 24 + .../examples/IacProfile_Get.json | 87 ++ .../examples/IacProfile_List.json | 88 ++ .../IacProfile_ListByResourceGroup.json | 90 ++ .../examples/IacProfile_ScaleTemplate.json | 25 + .../examples/IacProfile_SyncTemplate.json | 11 + .../examples/IacProfile_UpdateTags.json | 92 ++ .../examples/Operation_List.json | 23 + .../examples/Workflow_CreateOrUpdate.json | 146 ++ ...rkflow_CreateOrUpdate_WithArtifactGen.json | 159 +++ .../examples/Workflow_Delete.json | 16 + .../examples/Workflow_Get.json | 65 + .../examples/Workflow_List.json | 62 + .../Workflow_ListByResourceGroup.json | 71 + .../examples/Workflow_UpdateTags.json | 73 + .../preview/2024-05-01-preview/iac.json | 763 +++++++++++ .../preview/2024-05-01-preview/workflow.json | 1179 +++++++++++++++++ .../developerhub/resource-manager/readme.md | 13 +- 25 files changed, 3326 insertions(+), 1 deletion(-) create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GeneratePreviewArtifacts.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GitHubOAuth.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GitHubOAuthCallback.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GitHubOAuth_List.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_CreateOrUpdate.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_Delete.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_ExportTemplate.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_Get.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_List.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_ListByResourceGroup.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_ScaleTemplate.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_SyncTemplate.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_UpdateTags.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Operation_List.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_CreateOrUpdate.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_CreateOrUpdate_WithArtifactGen.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_Delete.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_Get.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_List.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_ListByResourceGroup.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_UpdateTags.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/iac.json create mode 100644 specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/workflow.json diff --git a/cSpell.json b/cSpell.json index 0cdfc40ce064..fe4853d587b6 100644 --- a/cSpell.json +++ b/cSpell.json @@ -1285,6 +1285,18 @@ "spoofface" ] }, + { + "filename": "**/specification/developerhub/resource-manager/Microsoft.DevHub/**/*.json", + "words": [ + "iacProfiles", + "iacProfile", + "IacProfiles", + "IacProfile", + "HCI", + "HCIAKS", + "HCIARCVM" + ] + }, { "filename": "**/specification/securityinsights/data-plane/Microsoft.SecurityInsights/**/*.json", "words": [ diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GeneratePreviewArtifacts.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GeneratePreviewArtifacts.json new file mode 100644 index 000000000000..3cabe06f3ed8 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GeneratePreviewArtifacts.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "parameters": { + "generationLanguage": "javascript", + "languageVersion": "14", + "port": "80", + "appName": "my-app", + "dockerfileOutputDirectory": "./", + "manifestOutputDirectory": "./", + "manifestGenerationMode": "enabled", + "dockerfileGenerationMode": "enabled", + "manifestType": "kube", + "imageName": "myimage", + "namespace": "my-namespace", + "imageTag": "latest" + } + }, + "responses": { + "200": { + "body": { + "dockerfiles/example-dockerfile": "dockerfile-content \n including newlines", + "manifests/example-manifest-file-1": "manifest file 1 content \n including newlines", + "manifests/example-manifest-file-2": "manifest file 2 content \n including newlines" + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GitHubOAuth.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GitHubOAuth.json new file mode 100644 index 000000000000..901402d2f507 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GitHubOAuth.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus2euap", + "api-version": "2024-05-01-preview", + "parameters": { + "redirectUrl": "https://ms.portal.azure.com/aks" + } + }, + "responses": { + "200": { + "body": { + "authURL": "https://github.com/login/oauth/authorize?client_id=11111111&redirect_uri=https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevHub/locations/eastus2euap/githuboauth&state=2345678-3456-7890-5678-012345678901&scope=repo,user:email,workflow", + "token": "" + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GitHubOAuthCallback.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GitHubOAuthCallback.json new file mode 100644 index 000000000000..2186acc1f965 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GitHubOAuthCallback.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus2euap", + "api-version": "2024-05-01-preview", + "code": "3584d83530557fdd1f46af8289938c8ef79f9dc5", + "state": "12345678-3456-7890-5678-012345678901" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevHub/locations/eastus2euap/githuboauth/default", + "type": "Microsoft.DevHub/locations/githuboauth", + "name": "default", + "properties": { + "username": "user" + } + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GitHubOAuth_List.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GitHubOAuth_List.json new file mode 100644 index 000000000000..04a7646d14d0 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/GitHubOAuth_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus2euap", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevHub/locations/eastus2euap/githuboauth/default", + "type": "Microsoft.DevHub/locations/githuboauth", + "name": "default", + "properties": { + "username": "user" + } + } + ] + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_CreateOrUpdate.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_CreateOrUpdate.json new file mode 100644 index 000000000000..f17329d853bc --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_CreateOrUpdate.json @@ -0,0 +1,224 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "a0a37f63-7183-4e86-9ac7-ce8036a3ed31", + "resourceGroupName": "resourceGroup1", + "iacProfileName": "profile1", + "parameters": { + "location": "location1", + "tags": { + "appname": "testApp" + }, + "properties": { + "githubProfile": { + "repositoryOwner": "owner", + "repositoryName": "localtest", + "repositoryMainBranch": "main" + }, + "terraformProfile": { + "storageAccountSubscription": "subscription", + "storageAccountResourceGroup": "hybrid-iac", + "storageAccountName": "hybridiac", + "storageContainerName": "hybridiac" + }, + "stages": [ + { + "stageName": "dev", + "dependencies": [], + "gitEnvironment": "Terraform" + }, + { + "stageName": "qa", + "dependencies": [ + "dev" + ], + "gitEnvironment": "Terraform" + }, + { + "stageName": "prod", + "dependencies": [ + "qa" + ], + "gitEnvironment": "Terraform" + } + ], + "templates": [ + { + "templateName": "base", + "sourceResourceId": "/subscriptions/xxxx/resourceGroups/xxxx", + "instanceStage": "dev", + "instanceName": "contoso", + "templateDetails": [ + { + "productName": "HCI", + "count": 1, + "namingConvention": "$sitid-hci" + }, + { + "productName": "AKSarc", + "count": 1, + "namingConvention": "$sitid-aks" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/a0a37f63-7183-4e86-9ac7-ce8036a3ed31/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/iacProfiles/profile1", + "location": "location1", + "name": "profile1", + "type": "Micfosoft.DevHub/iacProfiles", + "tags": { + "appname": "testapp" + }, + "systemData": { + "createdBy": "foo@contoso.com", + "createdByType": "User", + "createdAt": "2024-01-16T09:56:23.933651400Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-16T09:56:30.783361300Z" + }, + "properties": { + "githubProfile": { + "repositoryName": "localtest", + "repositoryMainBranch": "main", + "repositoryOwner": "owner", + "authStatus": "Unspecified", + "pullNumber": 8, + "prStatus": "submitted", + "branchName": "aks-devhub-ybvmw" + }, + "terraformProfile": { + "storageAccountSubscription": "subscription", + "storageAccountResourceGroup": "hybrid-iac", + "storageAccountName": "hybridiac", + "storageContainerName": "hybridiac" + }, + "stages": [ + { + "stageName": "dev", + "dependencies": [], + "gitEnvironment": "Terraform" + }, + { + "stageName": "qa", + "dependencies": [ + "dev" + ], + "gitEnvironment": "Terraform" + }, + { + "stageName": "prod", + "dependencies": [ + "qa" + ], + "gitEnvironment": "Terraform" + } + ], + "templates": [ + { + "templateName": "base", + "sourceResourceId": "/subscriptions/xxxx/resourceGroups/xxxx", + "instanceStage": "dev", + "instanceName": "contoso", + "templateDetails": [ + { + "productName": "HCI", + "count": 1, + "namingConvention": "$sitid-hci" + }, + { + "productName": "AKSarc", + "count": 1, + "namingConvention": "$sitid-aks" + } + ] + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/a0a37f63-7183-4e86-9ac7-ce8036a3ed31/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/iacProfiles/profile1", + "location": "location1", + "name": "profile1", + "type": "Micfosoft.DevHub/iacProfiles", + "tags": { + "appname": "testapp" + }, + "systemData": { + "createdBy": "foo@contoso.com", + "createdByType": "User", + "createdAt": "2024-01-16T09:56:23.933651400Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-16T09:56:30.783361300Z" + }, + "properties": { + "githubProfile": { + "repositoryName": "localtest", + "repositoryMainBranch": "main", + "repositoryOwner": "owner", + "authStatus": "Unspecified", + "pullNumber": 8, + "prStatus": "submitted", + "branchName": "aks-devhub-ybvmw" + }, + "terraformProfile": { + "storageAccountSubscription": "subscription", + "storageAccountResourceGroup": "hybrid-iac", + "storageAccountName": "hybridiac", + "storageContainerName": "hybridiac" + }, + "stages": [ + { + "stageName": "dev", + "dependencies": [], + "gitEnvironment": "Terraform" + }, + { + "stageName": "qa", + "dependencies": [ + "dev" + ], + "gitEnvironment": "Terraform" + }, + { + "stageName": "prod", + "dependencies": [ + "qa" + ], + "gitEnvironment": "Terraform" + } + ], + "templates": [ + { + "templateName": "base", + "sourceResourceId": "/subscriptions/xxxx/resourceGroups/xxxx", + "instanceStage": "dev", + "instanceName": "contoso", + "templateDetails": [ + { + "productName": "HCI", + "count": 1, + "namingConvention": "$sitid-hci" + }, + { + "productName": "AKSarc", + "count": 1, + "namingConvention": "$sitid-aks" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_Delete.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_Delete.json new file mode 100644 index 000000000000..94f89458dfe5 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "a0a37f63-7183-4e86-9ac7-ce8036a3ed31", + "resourceGroupName": "resourceGroup1", + "iacProfileName": "iacprofile" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_ExportTemplate.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_ExportTemplate.json new file mode 100644 index 000000000000..b74e5db888e4 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_ExportTemplate.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "a0a37f63-7183-4e86-9ac7-ce8036a3ed31", + "resourceGroupName": "resourceGroup1", + "iacProfileName": "iacprofile", + "parameters": { + "templateName": "base", + "resourceGroupIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup2" + ], + "instanceName": "sample", + "instanceStage": "dev" + } + }, + "responses": { + "200": { + "body": { + "prLink": "xxxx" + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_Get.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_Get.json new file mode 100644 index 000000000000..9460e88df822 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_Get.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "a0a37f63-7183-4e86-9ac7-ce8036a3ed31", + "resourceGroupName": "resourceGroup1", + "iacProfileName": "iacprofile" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/a0a37f63-7183-4e86-9ac7-ce8036a3ed31/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/iacProfiles/iacprofile", + "location": "location1", + "name": "iacprofile", + "type": "Micfosoft.DevHub/iacProfiles", + "tags": { + "appname": "testapp" + }, + "properties": { + "githubProfile": { + "repositoryName": "localtest", + "repositoryMainBranch": "main", + "repositoryOwner": "owner", + "authStatus": "Authorized", + "pullNumber": 8, + "prStatus": "submitted", + "branchName": "aks-devhub-ybvmw" + }, + "terraformProfile": { + "storageAccountSubscription": "subscriptions", + "storageAccountResourceGroup": "hybrid-iac", + "storageAccountName": "hybridiac", + "storageContainerName": "hybridiac" + }, + "stages": [ + { + "stageName": "dev", + "dependencies": [], + "gitEnvironment": "Terraform" + }, + { + "stageName": "qa", + "dependencies": [ + "dev" + ], + "gitEnvironment": "Terraform" + }, + { + "stageName": "prod", + "dependencies": [ + "qa" + ], + "gitEnvironment": "Terraform" + } + ], + "templates": [ + { + "templateName": "base", + "sourceResourceId": "/subscriptions/xxxx/resourceGroups/xxxx", + "instanceStage": "dev", + "instanceName": "contoso", + "templateDetails": [ + { + "productName": "HCI", + "count": 1, + "namingConvention": "$sitid-hci" + }, + { + "productName": "AKSarc", + "count": 1, + "namingConvention": "$sitid-aks" + } + ] + } + ] + }, + "systemData": { + "createdBy": "", + "createdByType": "User", + "createdAt": "2024-01-16T09:56:23.933651400Z", + "lastModifiedBy": "aks-dev-hub-devhub", + "lastModifiedByType": "Application", + "lastModifiedAt": "2024-01-16T14:35:15.206059900Z" + } + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_List.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_List.json new file mode 100644 index 000000000000..96d7bba63647 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_List.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "a0a37f63-7183-4e86-9ac7-ce8036a3ed31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a0a37f63-7183-4e86-9ac7-ce8036a3ed31/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/iacProfiles/profilename", + "name": "profilename", + "type": "Microsoft.DevHub/iacProfiles", + "location": "", + "tags": {}, + "properties": { + "githubProfile": { + "repositoryName": "localtest", + "repositoryMainBranch": "main", + "repositoryOwner": "owner", + "authStatus": "Authorized", + "pullNumber": 8, + "prStatus": "submitted", + "branchName": "aks-devhub-ybvmw" + }, + "terraformProfile": { + "storageAccountSubscription": "subscription", + "storageAccountResourceGroup": "hybrid-iac", + "storageAccountName": "hybridiac", + "storageContainerName": "hybridiac" + }, + "stages": [ + { + "stageName": "dev", + "dependencies": [], + "gitEnvironment": "Terraform" + }, + { + "stageName": "qa", + "dependencies": [ + "dev" + ], + "gitEnvironment": "Terraform" + }, + { + "stageName": "prod", + "dependencies": [ + "qa" + ], + "gitEnvironment": "Terraform" + } + ], + "templates": [ + { + "templateName": "base", + "sourceResourceId": "/subscriptions/xxxx/resourceGroups/xxxx", + "instanceStage": "dev", + "instanceName": "contoso", + "templateDetails": [ + { + "productName": "HCI", + "count": 1, + "namingConvention": "$sitid-hci" + }, + { + "productName": "AKSarc", + "count": 1, + "namingConvention": "$sitid-aks" + } + ] + } + ] + }, + "systemData": { + "createdBy": "", + "createdByType": "User", + "createdAt": "2024-01-16T09:56:23.933651400Z", + "lastModifiedBy": "aks-dev-hub-devhub", + "lastModifiedByType": "Application", + "lastModifiedAt": "2024-01-16T14:32:00.783994200Z" + } + } + ], + "nextLink": "https://management.azure.com:443/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevHub/iacProfiles?api-version=2018-05-05-preview&timeRange=1&$skipToken=" + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_ListByResourceGroup.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_ListByResourceGroup.json new file mode 100644 index 000000000000..a12366e5a8dc --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_ListByResourceGroup.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "a0a37f63-7183-4e86-9ac7-ce8036a3ed31", + "resourceGroupName": "resourceGroup1", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a0a37f63-7183-4e86-9ac7-ce8036a3ed31/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/iacProfiles/profilename", + "name": "profilename", + "type": "Microsoft.DevHub/iacProfiles", + "location": "", + "tags": {}, + "properties": { + "githubProfile": { + "repositoryName": "localtest", + "repositoryMainBranch": "main", + "repositoryOwner": "owner", + "authStatus": "Authorized", + "pullNumber": 8, + "prStatus": "submitted", + "branchName": "aks-devhub-ybvmw" + }, + "terraformProfile": { + "storageAccountSubscription": "subscription", + "storageAccountResourceGroup": "hybrid-iac", + "storageAccountName": "hybridiac", + "storageContainerName": "hybridiac" + }, + "stages": [ + { + "stageName": "dev", + "dependencies": [], + "gitEnvironment": "Terraform" + }, + { + "stageName": "qa", + "dependencies": [ + "dev" + ], + "gitEnvironment": "Terraform" + }, + { + "stageName": "prod", + "dependencies": [ + "qa" + ], + "gitEnvironment": "Terraform" + } + ], + "templates": [ + { + "templateName": "base", + "sourceResourceId": "/subscriptions/xxxx/resourceGroups/xxxx", + "instanceStage": "dev", + "instanceName": "contoso", + "templateDetails": [ + { + "productName": "HCI", + "count": 1, + "namingConvention": "$sitid-hci" + }, + { + "productName": "AKSarc", + "count": 1, + "namingConvention": "$sitid-aks" + } + ] + } + ] + }, + "systemData": { + "createdBy": "", + "createdByType": "User", + "createdAt": "2024-01-16T09:56:23.933651400Z", + "lastModifiedBy": "aks-dev-hub-devhub", + "lastModifiedByType": "Application", + "lastModifiedAt": "2024-01-16T14:32:00.783994200Z" + } + } + ], + "nextLink": "https://management.azure.com:443/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/iacProfiles?api-version=2018-05-05-preview&timeRange=1&$skipToken=" + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_ScaleTemplate.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_ScaleTemplate.json new file mode 100644 index 000000000000..b96f412db373 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_ScaleTemplate.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "a0a37f63-7183-4e86-9ac7-ce8036a3ed31", + "resourceGroupName": "resourceGroup1", + "iacProfileName": "iacprofile", + "parameters": { + "templateName": "base", + "scaleRequirement": [ + { + "region": "useast", + "numberOfStore": 10, + "stage": "dev" + } + ] + } + }, + "responses": { + "200": { + "body": { + "prLink": "xxxx" + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_SyncTemplate.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_SyncTemplate.json new file mode 100644 index 000000000000..2de0ad6bf623 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_SyncTemplate.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "a0a37f63-7183-4e86-9ac7-ce8036a3ed31", + "resourceGroupName": "resourceGroup1", + "iacProfileName": "iacprofile" + }, + "responses": { + "200": {} + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_UpdateTags.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_UpdateTags.json new file mode 100644 index 000000000000..a811f408236d --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/IacProfile_UpdateTags.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "a0a37f63-7183-4e86-9ac7-ce8036a3ed31", + "resourceGroupName": "resourceGroup1", + "iacProfileName": "iacprofile", + "parameters": { + "tags": { + "resourceEnv": "testing", + "promote": "false" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/a0a37f63-7183-4e86-9ac7-ce8036a3ed31/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/iacProfiles/iacprofile", + "location": "location1", + "name": "iacprofile", + "type": "Micfosoft.DevHub/iacProfiles", + "tags": { + "appname": "testapp", + "resourceEnv": "testing", + "promote": "false" + }, + "properties": { + "githubProfile": { + "repositoryName": "localtest", + "repositoryMainBranch": "main", + "repositoryOwner": "owner", + "authStatus": "Authorized", + "pullNumber": 8, + "prStatus": "submitted", + "branchName": "aks-devhub-ybvmw" + }, + "terraformProfile": { + "storageAccountSubscription": "subscriptions", + "storageAccountResourceGroup": "hybrid-iac", + "storageAccountName": "hybridiac", + "storageContainerName": "hybridiac" + }, + "stages": [ + { + "stageName": "dev", + "dependencies": [], + "gitEnvironment": "Terraform" + }, + { + "stageName": "qa", + "dependencies": [ + "dev" + ], + "gitEnvironment": "Terraform" + }, + { + "stageName": "prod", + "dependencies": [ + "qa" + ], + "gitEnvironment": "Terraform" + } + ], + "templates": [ + { + "templateName": "base", + "templateDetails": [ + { + "productName": "HCI", + "count": 1, + "namingConvention": "$sitid-hci" + }, + { + "productName": "AKSarc", + "count": 1, + "namingConvention": "$sitid-aks" + } + ] + } + ] + }, + "systemData": { + "createdBy": "", + "createdByType": "User", + "createdAt": "2024-01-16T09:56:23.933651400Z", + "lastModifiedBy": "aks-dev-hub-devhub", + "lastModifiedByType": "Application", + "lastModifiedAt": "2024-01-16T14:35:15.206059900Z" + } + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Operation_List.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Operation_List.json new file mode 100644 index 000000000000..3e0780a7a85d --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Operation_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DevHub/workflows/read", + "display": { + "provider": "Microsoft Developer Hub", + "resource": "Workflows", + "operation": "Get workflow", + "description": "Gets workflow" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_CreateOrUpdate.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_CreateOrUpdate.json new file mode 100644 index 000000000000..ab3072b71401 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_CreateOrUpdate.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup1", + "workflowName": "workflow1", + "parameters": { + "location": "location1", + "tags": { + "appname": "testApp" + }, + "properties": { + "githubWorkflowProfile": { + "repositoryOwner": "owner1", + "repositoryName": "repo1", + "branchName": "branch1", + "dockerfile": "repo1/images/Dockerfile", + "dockerBuildContext": "repo1/src/", + "deploymentProperties": { + "manifestType": "kube", + "kubeManifestLocations": [ + "/src/manifests/" + ], + "overrides": { + "key1": "value1" + } + }, + "namespace": "namespace1", + "acr": { + "acrSubscriptionId": "00000000-0000-0000-0000-000000000000", + "acrResourceGroup": "resourceGroup1", + "acrRegistryName": "registry1", + "acrRepositoryName": "repo1" + }, + "oidcCredentials": { + "azureClientId": "12345678-3456-7890-5678-012345678901", + "azureTenantId": "66666666-3456-7890-5678-012345678901" + }, + "aksResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroup1/providers/Microsoft.ContainerService/managedClusters/cluster1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/workflow/workflow1", + "location": "location1", + "name": "workflow1", + "type": "Micfosoft.DevHub/Workflow", + "tags": { + "appname": "testapp" + }, + "systemData": { + "createdBy": "foo@contoso.com", + "createdByType": "User", + "createdAt": "2018-04-24T16:30:55+00:00", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-04-24T16:30:55+00:00" + }, + "properties": { + "githubWorkflowProfile": { + "repositoryOwner": "owner1", + "repositoryName": "repo2", + "branchName": "branch2", + "dockerfile": "repo2/images/Dockerfile", + "dockerBuildContext": "repo2/src/", + "deploymentProperties": { + "manifestType": "helm", + "helmChartPath": "/src/charts", + "helmValues": "/src/chars/values.yaml", + "overrides": { + "key1": "value1" + } + }, + "acr": { + "acrSubscriptionId": "00000000-0000-0000-0000-000000000000", + "acrResourceGroup": "resourceGroup1", + "acrRegistryName": "registry1", + "acrRepositoryName": "repo1" + }, + "oidcCredentials": { + "azureClientId": "12345678-3456-7890-5678-012345678901", + "azureTenantId": "66666666-3456-7890-5678-012345678901" + }, + "aksResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroup1/providers/Microsoft.ContainerService/managedClusters/cluster1", + "prURL": "https://github.com/User/repo2/pull/6567", + "pullNumber": 6567, + "prStatus": "submitted", + "authStatus": "Authorized" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/workflow/workflow1", + "location": "location1", + "name": "workflow1", + "type": "Micfosoft.DevHub/Workflow", + "tags": { + "appname": "testapp" + }, + "systemData": { + "createdBy": "foo@contoso.com", + "createdByType": "User", + "createdAt": "2018-04-24T16:30:55+00:00", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-04-24T16:30:55+00:00" + }, + "properties": { + "githubWorkflowProfile": { + "repositoryOwner": "owner1", + "repositoryName": "repo1", + "branchName": "branch1", + "dockerfile": "repo1/images/Dockerfile", + "dockerBuildContext": "repo1/src/", + "deploymentProperties": { + "manifestType": "kube", + "overrides": { + "key1": "value1" + } + }, + "acr": { + "acrSubscriptionId": "00000000-0000-0000-0000-000000000000", + "acrResourceGroup": "resourceGroup1", + "acrRegistryName": "registry1", + "acrRepositoryName": "repo1" + }, + "oidcCredentials": { + "azureClientId": "12345678-3456-7890-5678-012345678901", + "azureTenantId": "66666666-3456-7890-5678-012345678901" + }, + "aksResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroup1/providers/Microsoft.ContainerService/managedClusters/cluster1", + "prURL": "https://github.com/owner1/repo1/pull/6567", + "pullNumber": 6567, + "prStatus": "submitted", + "authStatus": "Authorized" + } + } + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_CreateOrUpdate_WithArtifactGen.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_CreateOrUpdate_WithArtifactGen.json new file mode 100644 index 000000000000..ec09795652c7 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_CreateOrUpdate_WithArtifactGen.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup1", + "workflowName": "workflow1", + "parameters": { + "location": "location1", + "tags": { + "appname": "testApp" + }, + "properties": { + "githubWorkflowProfile": { + "repositoryOwner": "owner1", + "repositoryName": "repo1", + "branchName": "branch1", + "dockerfile": "repo1/images/Dockerfile", + "dockerBuildContext": "repo1/src/", + "deploymentProperties": { + "manifestType": "kube", + "kubeManifestLocations": [ + "/src/manifests/" + ], + "overrides": { + "key1": "value1" + } + }, + "acr": { + "acrSubscriptionId": "00000000-0000-0000-0000-000000000000", + "acrResourceGroup": "resourceGroup1", + "acrRegistryName": "registry1", + "acrRepositoryName": "repo1" + }, + "oidcCredentials": { + "azureClientId": "12345678-3456-7890-5678-012345678901", + "azureTenantId": "66666666-3456-7890-5678-012345678901" + }, + "aksResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroup1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "artifactGenerationProperties": { + "generationLanguage": "javascript", + "languageVersion": "14", + "port": "80", + "appName": "my-app", + "dockerfileOutputDirectory": "./", + "manifestOutputDirectory": "./", + "manifestGenerationMode": "enabled", + "dockerfileGenerationMode": "enabled", + "manifestType": "kube", + "imageName": "myimage", + "namespace": "my-namespace", + "imageTag": "latest" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/workflow/workflow1", + "location": "location1", + "name": "workflow1", + "type": "Micfosoft.DevHub/Workflow", + "tags": { + "appname": "testapp" + }, + "systemData": { + "createdBy": "foo@contoso.com", + "createdByType": "User", + "createdAt": "2018-04-24T16:30:55+00:00", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-04-24T16:30:55+00:00" + }, + "properties": { + "githubWorkflowProfile": { + "repositoryOwner": "owner1", + "repositoryName": "repo2", + "branchName": "branch2", + "dockerfile": "repo2/images/Dockerfile", + "dockerBuildContext": "repo2/src/", + "deploymentProperties": { + "manifestType": "helm", + "helmChartPath": "/src/charts", + "helmValues": "/src/chars/values.yaml", + "overrides": { + "key1": "value1" + } + }, + "acr": { + "acrSubscriptionId": "00000000-0000-0000-0000-000000000000", + "acrResourceGroup": "resourceGroup1", + "acrRegistryName": "registry1", + "acrRepositoryName": "repo1" + }, + "oidcCredentials": { + "azureClientId": "12345678-3456-7890-5678-012345678901", + "azureTenantId": "66666666-3456-7890-5678-012345678901" + }, + "aksResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroup1/providers/Microsoft.ContainerService/managedClusters/cluster1", + "prURL": "https://github.com/User/repo2/pull/6567", + "pullNumber": 6567, + "prStatus": "submitted", + "authStatus": "Authorized" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/workflow/workflow1", + "location": "location1", + "name": "workflow1", + "type": "Micfosoft.DevHub/Workflow", + "tags": { + "appname": "testapp" + }, + "systemData": { + "createdBy": "foo@contoso.com", + "createdByType": "User", + "createdAt": "2018-04-24T16:30:55+00:00", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-04-24T16:30:55+00:00" + }, + "properties": { + "githubWorkflowProfile": { + "repositoryOwner": "owner1", + "repositoryName": "repo1", + "branchName": "branch1", + "dockerfile": "repo1/images/Dockerfile", + "dockerBuildContext": "repo1/src/", + "deploymentProperties": { + "manifestType": "kube", + "overrides": { + "key1": "value1" + } + }, + "acr": { + "acrSubscriptionId": "00000000-0000-0000-0000-000000000000", + "acrResourceGroup": "resourceGroup1", + "acrRegistryName": "registry1", + "acrRepositoryName": "repo1" + }, + "oidcCredentials": { + "azureClientId": "12345678-3456-7890-5678-012345678901", + "azureTenantId": "66666666-3456-7890-5678-012345678901" + }, + "aksResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroup1/providers/Microsoft.ContainerService/managedClusters/cluster1", + "prURL": "https://github.com/owner1/repo1/pull/6567", + "pullNumber": 6567, + "prStatus": "submitted", + "authStatus": "Authorized" + } + } + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_Delete.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_Delete.json new file mode 100644 index 000000000000..b68c8ead1a9f --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup1", + "workflowName": "workflow1" + }, + "responses": { + "200": { + "body": { + "status": "workflow deleted successfully" + } + }, + "204": {} + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_Get.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_Get.json new file mode 100644 index 000000000000..e240d5b2e882 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup1", + "workflowName": "workflow1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/workflow/workflow1", + "location": "location1", + "name": "workflow1", + "type": "Micfosoft.DevHub/Workflow", + "tags": { + "appname": "testapp" + }, + "systemData": { + "createdBy": "foo@contoso.com", + "createdByType": "User", + "createdAt": "2018-04-24T16:30:55+00:00", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-04-24T16:30:55+00:00" + }, + "properties": { + "githubWorkflowProfile": { + "repositoryOwner": "owner1", + "repositoryName": "repo1", + "branchName": "branch1", + "dockerfile": "repo1/images/Dockerfile", + "dockerBuildContext": "repo1/src/", + "deploymentProperties": { + "manifestType": "kube", + "overrides": { + "key1": "value1" + } + }, + "acr": { + "acrSubscriptionId": "00000000-0000-0000-0000-000000000000", + "acrResourceGroup": "resourceGroup1", + "acrRegistryName": "registry1", + "acrRepositoryName": "repo1" + }, + "oidcCredentials": { + "azureClientId": "12345678-3456-7890-5678-012345678901", + "azureTenantId": "66666666-3456-7890-5678-012345678901" + }, + "aksResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroup1/providers/Microsoft.ContainerService/managedClusters/cluster1", + "prURL": "https://github.com/User/repo1/pull/6567", + "pullNumber": 6567, + "prStatus": "merged", + "lastWorkflowRun": { + "succeeded": true, + "workflowRunURL": "https://github.com/User/repo1/actions/runs/1820640230", + "lastRunAt": "2019-01-01T12:34:56.000Z", + "workflowRunStatus": "completed" + }, + "authStatus": "Authorized" + } + } + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_List.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_List.json new file mode 100644 index 000000000000..ec91f834da64 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_List.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/workflow/workflow1", + "location": "location1", + "name": "workflow1", + "type": "Micfosoft.DevHub/Workflow", + "tags": { + "appname": "testapp" + }, + "systemData": { + "createdBy": "foo@contoso.com", + "createdByType": "User", + "createdAt": "2018-04-24T16:30:55+00:00", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-04-24T16:30:55+00:00" + }, + "properties": { + "githubWorkflowProfile": { + "repositoryOwner": "owner1", + "repositoryName": "repo1", + "branchName": "branch1", + "dockerfile": "repo1/images/Dockerfile", + "dockerBuildContext": "repo1/src/", + "deploymentProperties": { + "manifestType": "kube", + "overrides": { + "key1": "value1" + } + }, + "acr": { + "acrSubscriptionId": "00000000-0000-0000-0000-000000000000", + "acrResourceGroup": "resourceGroup1", + "acrRegistryName": "registry1", + "acrRepositoryName": "repo1" + }, + "oidcCredentials": { + "azureClientId": "12345678-3456-7890-5678-012345678901", + "azureTenantId": "66666666-3456-7890-5678-012345678901" + }, + "aksResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroup1/providers/Microsoft.ContainerService/managedClusters/cluster1", + "prURL": "https://github.com/User/repo1/pull/6567", + "pullNumber": 6567, + "prStatus": "submitted", + "authStatus": "Authorized" + } + } + } + ], + "nextLink": "https://management.azure.com:443/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevHub/workflows?api-version=2018-05-05-preview&timeRange=1&$skipToken=" + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_ListByResourceGroup.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_ListByResourceGroup.json new file mode 100644 index 000000000000..a76ee3a41f5f --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_ListByResourceGroup.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup1", + "location": "location1", + "managedClusterResource": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroup1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/workflow/workflow1", + "location": "location1", + "name": "workflow1", + "type": "Micfosoft.DevHub/Workflow", + "tags": { + "appname": "testapp" + }, + "systemData": { + "createdBy": "foo@contoso.com", + "createdByType": "User", + "createdAt": "2018-04-24T16:30:55+00:00", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-04-24T16:30:55+00:00" + }, + "properties": { + "githubWorkflowProfile": { + "repositoryOwner": "owner1", + "repositoryName": "repo1", + "branchName": "branch1", + "dockerfile": "repo1/images/Dockerfile", + "dockerBuildContext": "repo1/src/", + "deploymentProperties": { + "manifestType": "kube", + "overrides": { + "key1": "value1" + } + }, + "acr": { + "acrSubscriptionId": "00000000-0000-0000-0000-000000000000", + "acrResourceGroup": "resourceGroup1", + "acrRegistryName": "registry1", + "acrRepositoryName": "repo1" + }, + "oidcCredentials": { + "azureClientId": "12345678-3456-7890-5678-012345678901", + "azureTenantId": "66666666-3456-7890-5678-012345678901" + }, + "aksResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroup1/providers/Microsoft.ContainerService/managedClusters/cluster1", + "prURL": "https://github.com/User/repo1/pull/6567", + "pullNumber": 6567, + "prStatus": "merged", + "lastWorkflowRun": { + "succeeded": true, + "workflowRunURL": "https://github.com/User/repo1/actions/runs/1820640230", + "lastRunAt": "2019-01-01T12:34:56.000Z", + "workflowRunStatus": "completed" + }, + "authStatus": "Authorized" + } + } + } + ], + "nextLink": "https://management.azure.com:443/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows?api-version=2018-05-05-preview&timeRange=1&$skipToken=1" + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_UpdateTags.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_UpdateTags.json new file mode 100644 index 000000000000..5382906ed65f --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/examples/Workflow_UpdateTags.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup1", + "workflowName": "workflow1", + "parameters": { + "tags": { + "resourceEnv": "testing", + "promote": "false" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.DevHub/workflow/workflow1", + "location": "location1", + "name": "workflow1", + "type": "Micfosoft.DevHub/Workflow", + "tags": { + "previousValue": "stillExists", + "resourceEnv": "testing", + "promote": "false" + }, + "systemData": { + "createdBy": "foo@contoso.com", + "createdByType": "User", + "createdAt": "2018-04-24T16:30:55+00:00", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-04-24T16:30:55+00:00" + }, + "properties": { + "githubWorkflowProfile": { + "repositoryOwner": "owner1", + "repositoryName": "repo1", + "branchName": "branch1", + "dockerfile": "repo1/images/Dockerfile", + "dockerBuildContext": "repo1/src/", + "deploymentProperties": { + "manifestType": "kube", + "overrides": { + "key1": "value1" + } + }, + "acr": { + "acrSubscriptionId": "00000000-0000-0000-0000-000000000000", + "acrResourceGroup": "resourceGroup1", + "acrRegistryName": "registry1", + "acrRepositoryName": "repo1" + }, + "oidcCredentials": { + "azureClientId": "12345678-3456-7890-5678-012345678901", + "azureTenantId": "66666666-3456-7890-5678-012345678901" + }, + "aksResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroup1/providers/Microsoft.ContainerService/managedClusters/cluster1", + "prURL": "https://github.com/owner1/repo1/pull/6567", + "pullNumber": 6567, + "prStatus": "merged", + "lastWorkflowRun": { + "succeeded": true, + "workflowRunURL": "https://github.com/User/repo1/actions/runs/1820640230", + "lastRunAt": "2019-01-01T12:34:56.000Z", + "workflowRunStatus": "completed" + }, + "authStatus": "Authorized" + } + } + } + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/iac.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/iac.json new file mode 100644 index 000000000000..ce852daf7dbd --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/iac.json @@ -0,0 +1,763 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "DeveloperHubServiceClient", + "description": "The AKS Developer Hub Service Client" + }, + "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.DevHub/iacProfiles": { + "get": { + "tags": [ + "IacProfile" + ], + "operationId": "IacProfiles_List", + "summary": "Gets a list of IacProfiles associated with the specified 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": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/IacProfileListResult" + } + }, + "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": { + "List IacProfiles": { + "$ref": "./examples/IacProfile_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/iacProfiles": { + "get": { + "tags": [ + "IacProfile" + ], + "operationId": "IacProfiles_ListByResourceGroup", + "summary": "Gets a list of iacProfiles 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": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/IacProfileListResult" + } + }, + "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": { + "List IacProfiles": { + "$ref": "./examples/IacProfile_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/iacProfiles/{iacProfileName}": { + "get": { + "tags": [ + "IacProfile" + ], + "operationId": "IacProfiles_Get", + "summary": "Gets a IacProfile.", + "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": "#/parameters/IacProfileParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IacProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get IacProfile": { + "$ref": "./examples/IacProfile_Get.json" + } + } + }, + "put": { + "tags": [ + "IacProfile" + ], + "operationId": "IacProfiles_CreateOrUpdate", + "summary": "Creates or updates a IacProfile", + "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": "#/parameters/IacProfileParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IacProfile" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IacProfile" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IacProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create IacProfile": { + "$ref": "./examples/IacProfile_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "IacProfile" + ], + "operationId": "IacProfiles_Delete", + "summary": "Deletes a IacProfile", + "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": "#/parameters/IacProfileParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "Successfully deleted the resource" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete IacProfile": { + "$ref": "./examples/IacProfile_Delete.json" + } + } + }, + "patch": { + "tags": [ + "IacProfile" + ], + "operationId": "IacProfiles_UpdateTags", + "summary": "Updates tags on a IacProfile.", + "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": "#/parameters/IacProfileParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "workflow.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update TagsObject Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IacProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update IacProfile Tags": { + "$ref": "./examples/IacProfile_UpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/iacProfiles/{iacProfileName}/export": { + "post": { + "tags": [ + "IacProfile" + ], + "operationId": "IacProfiles_Export", + "summary": "Export a template", + "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": "#/parameters/IacProfileParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExportTemplateRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/prLinkResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create IacProfile": { + "$ref": "./examples/IacProfile_ExportTemplate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/iacProfiles/{iacProfileName}/scale": { + "post": { + "tags": [ + "IacProfile" + ], + "operationId": "IacProfiles_Scale", + "summary": "Scale by template", + "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": "#/parameters/IacProfileParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScaleTemplateRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/prLinkResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create IacProfile": { + "$ref": "./examples/IacProfile_ScaleTemplate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/iacProfiles/{iacProfileName}/sync": { + "post": { + "tags": [ + "IacProfile" + ], + "operationId": "IacProfiles_Sync", + "summary": "Sync template", + "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": "#/parameters/IacProfileParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create IacProfile": { + "$ref": "./examples/IacProfile_SyncTemplate.json" + } + } + } + } + }, + "definitions": { + "IacProfile": { + "title": "IacProfile", + "description": "Resource representation of a IacProfile.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Properties of a IacProfile.", + "$ref": "#/definitions/IacProfileProperties", + "x-ms-client-flatten": true + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + } + }, + "IacProfileProperties": { + "type": "object", + "description": "Properties of a IacProfile.", + "properties": { + "githubProfile": { + "description": "GitHub Profile of a IacProfile", + "$ref": "#/definitions/IacGitHubProfile", + "x-ms-client-flatten": true + }, + "terraformProfile": { + "description": "Terraform Profile of a IacProfile", + "$ref": "#/definitions/TerraformProfile", + "x-ms-client-flatten": true + }, + "stages": { + "type": "array", + "items": { + "$ref": "#/definitions/StageProperties" + } + }, + "templates": { + "type": "array", + "items": { + "$ref": "#/definitions/IacTemplateProperties" + } + } + } + }, + "StageProperties": { + "type": "object", + "description": "Properties of a Stage.", + "properties": { + "stageName": { + "type": "string", + "title": "The name of the stage.", + "description": "Stage Name" + }, + "dependencies": { + "type": "array", + "items": { + "type": "string" + } + }, + "gitEnvironment": { + "type": "string" + } + } + }, + "IacGitHubProfile": { + "type": "object", + "description": "GitHub Profile of a IacProfile.", + "properties": { + "repositoryName": { + "type": "string", + "title": "The name of the repository the IacProfile is associated with.", + "description": "Repository Name" + }, + "repositoryMainBranch": { + "type": "string", + "title": "The name of the main branch of the repository the IacProfile is associated with.", + "description": "Repository Main Branch" + }, + "repositoryOwner": { + "type": "string", + "title": "The owner of the repository the IacProfile is associated with.", + "description": "Repository Owner" + }, + "authStatus": { + "$ref": "workflow.json#/definitions/AuthorizationStatus" + }, + "pullNumber": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The number associated with the submitted pull request." + }, + "prStatus": { + "$ref": "workflow.json#/definitions/PullRequestStatus" + }, + "branchName": { + "type": "string", + "title": "The name of the branch current operation is associated with.", + "description": "Repository Branch Name" + } + } + }, + "TerraformProfile": { + "type": "object", + "description": "Terraform backend profile.", + "properties": { + "storageAccountSubscription": { + "type": "string", + "title": "The subscription id of the storage account that save terraform state.", + "description": "Terraform Storage Account Subscription" + }, + "storageAccountResourceGroup": { + "type": "string", + "title": "The resource group of the storage account that save terraform state.", + "description": "Terraform Storage Account Resource Group" + }, + "storageAccountName": { + "type": "string", + "title": "The name of the storage account that save terraform state.", + "description": "Terraform Storage Account Name" + }, + "storageContainerName": { + "type": "string", + "title": "The name of the container that save terraform state.", + "description": "Terraform Container Name" + } + } + }, + "IacProfileListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IacProfile" + }, + "description": "The list of IacProfiles." + }, + "nextLink": { + "type": "string", + "description": "The URL to the next set of IacProfile results.", + "readOnly": true + } + } + }, + "IacTemplateProperties": { + "type": "object", + "description": "Properties of a IacTemplate.", + "properties": { + "templateName": { + "type": "string", + "title": "The name of the template.", + "description": "Template Name" + }, + "sourceResourceId": { + "type": "string", + "title": "The source resource Id of the template.", + "description": "the source store of the template" + }, + "instanceStage": { + "type": "string", + "title": "The sample instance stage of the template.", + "description": "the source stage of the template" + }, + "instanceName": { + "type": "string", + "title": "The sample instance name of the template.", + "description": "the sample instance name of the template" + }, + "templateDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/IacTemplateDetails" + } + }, + "quickStartTemplateType": { + "$ref": "#/definitions/QuickStartTemplateType" + } + } + }, + "QuickStartTemplateType": { + "type": "string", + "enum": [ + "None", + "HCI", + "HCIAKS", + "HCIARCVM" + ], + "readOnly": true, + "x-ms-enum": { + "name": "QuickStartTemplateType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "The template has not use quick start template" + }, + { + "value": "HCI", + "description": "The template use quick start template of HCI" + }, + { + "value": "HCIAKS", + "description": "The template use quick start template of HCI and AKS" + }, + { + "value": "HCIARCVM", + "description": "The template use quick start template of HCI and ArcVM" + } + ] + }, + "description": "Determines the authorization status of requests." + }, + "IacTemplateDetails": { + "type": "object", + "properties": { + "productName": { + "type": "string", + "description": "The name of the products." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Count of the product" + }, + "namingConvention": { + "type": "string", + "description": "Naming convention of this product" + } + } + }, + "ExportTemplateRequest": { + "type": "object", + "properties": { + "templateName": { + "type": "string", + "title": "The name of the template.", + "description": "Template Name" + }, + "resourceGroupIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "siteId": { + "type": "string" + }, + "instanceName": { + "type": "string" + }, + "instanceStage": { + "type": "string" + } + } + }, + "ScaleTemplateRequest": { + "type": "object", + "properties": { + "templateName": { + "type": "string", + "title": "The name of the template.", + "description": "Template Name" + }, + "scaleRequirement": { + "type": "array", + "items": { + "$ref": "#/definitions/ScaleProperty" + } + } + } + }, + "ScaleProperty": { + "type": "object", + "properties": { + "region": { + "type": "string", + "description": "The region of the store" + }, + "stage": { + "type": "string", + "description": "The stage of the store" + }, + "numberOfStore": { + "type": "integer", + "format": "int32", + "description": "Number of the store" + } + } + }, + "prLinkResponse": { + "type": "object", + "properties": { + "prLink": { + "type": "string", + "description": "The link of the pull request." + } + } + } + }, + "parameters": { + "IacProfileParameter": { + "name": "iacProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IacProfile.", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/workflow.json b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/workflow.json new file mode 100644 index 000000000000..6f073e672c95 --- /dev/null +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2024-05-01-preview/workflow.json @@ -0,0 +1,1179 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "DeveloperHubServiceClient", + "description": "The AKS Developer Hub Service Client" + }, + "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.DevHub/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Returns list of operations.", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation details.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "List available operations for the container service resource provider": { + "$ref": "./examples/Operation_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/githuboauth/default/getGitHubOAuthInfo": { + "post": { + "tags": [ + "GitHubOAuth" + ], + "operationId": "GitHubOAuth", + "summary": "Gets GitHubOAuth info used to authenticate users with the Developer Hub GitHub App.", + "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/LocationParameter" + }, + { + "name": "parameters", + "required": false, + "in": "body", + "schema": { + "$ref": "#/definitions/GitHubOAuthCallRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GitHubOAuthInfoResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GitHub OAuth": { + "$ref": "./examples/GitHubOAuth.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/githuboauth/default": { + "get": { + "tags": [ + "GitHubOAuth" + ], + "operationId": "GitHubOAuthCallback", + "summary": "Callback URL to hit once authenticated with GitHub App to have the service store the OAuth token.", + "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/LocationParameter" + }, + { + "$ref": "#/parameters/GitHubOAuthCodeParameter" + }, + { + "$ref": "#/parameters/GitHubOAuthStateParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GitHubOAuthResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GitHub OAuth Callback": { + "$ref": "./examples/GitHubOAuthCallback.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/githuboauth": { + "get": { + "tags": [ + "GitHubOAuth" + ], + "operationId": "ListGitHubOAuth", + "summary": "Callback URL to hit once authenticated with GitHub App to have the service store the OAuth token.", + "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/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GitHubOAuthListResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List GitHub OAuth": { + "$ref": "./examples/GitHubOAuth_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/workflows": { + "get": { + "tags": [ + "Workflow" + ], + "operationId": "Workflow_List", + "summary": "Gets a list of workflows associated with the specified 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": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/WorkflowListResult" + } + }, + "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": { + "List Workflows": { + "$ref": "./examples/Workflow_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows": { + "get": { + "tags": [ + "Workflow" + ], + "operationId": "Workflow_ListByResourceGroup", + "summary": "Gets a list of workflows 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" + }, + { + "$ref": "#/parameters/ManagedClusterParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/WorkflowListResult" + } + }, + "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": { + "List Workflows": { + "$ref": "./examples/Workflow_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows/{workflowName}": { + "get": { + "tags": [ + "Workflow" + ], + "operationId": "Workflow_Get", + "summary": "Gets a workflow.", + "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": "#/parameters/WorkflowNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Workflow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workflow": { + "$ref": "./examples/Workflow_Get.json" + } + } + }, + "put": { + "tags": [ + "Workflow" + ], + "operationId": "Workflow_CreateOrUpdate", + "summary": "Creates or updates a workflow", + "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": "#/parameters/WorkflowNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workflow" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Workflow" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Workflow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Workflow": { + "$ref": "./examples/Workflow_CreateOrUpdate.json" + }, + "Create Workflow With Artifact Generation": { + "$ref": "./examples/Workflow_CreateOrUpdate_WithArtifactGen.json" + } + } + }, + "delete": { + "tags": [ + "Workflow" + ], + "operationId": "Workflow_Delete", + "summary": "Deletes a workflow", + "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": "#/parameters/WorkflowNameParameter" + } + ], + "responses": { + "200": { + "description": "successful delete with response", + "schema": { + "$ref": "#/definitions/DeleteWorkflowResponse" + } + }, + "204": { + "description": "Successfully deleted the resource" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workflow": { + "$ref": "./examples/Workflow_Delete.json" + } + } + }, + "patch": { + "tags": [ + "Workflow" + ], + "operationId": "Workflow_UpdateTags", + "summary": "Updates tags on a workflow.", + "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": "#/parameters/WorkflowNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Workflow Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Workflow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/Workflow_UpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/generatePreviewArtifacts": { + "post": { + "tags": [ + "Artifacts" + ], + "operationId": "GeneratePreviewArtifacts", + "summary": "Generate preview dockerfile and manifests.", + "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/LocationParameter" + }, + { + "name": "parameters", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ArtifactGenerationProperties" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GeneratePreviewArtifactsResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Artifact Generation Properties": { + "$ref": "./examples/GeneratePreviewArtifacts.json" + } + } + } + } + }, + "definitions": { + "Workflow": { + "title": "Workflow", + "description": "Resource representation of a workflow", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Properties of a workflow.", + "$ref": "#/definitions/WorkflowProperties", + "x-ms-client-flatten": true + } + } + }, + "WorkflowProperties": { + "type": "object", + "description": "Workflow properties", + "properties": { + "githubWorkflowProfile": { + "description": "Profile of a github workflow.", + "$ref": "#/definitions/GitHubWorkflowProfile", + "x-ms-client-flatten": true + }, + "artifactGenerationProperties": { + "description": "Properties for generating artifacts like dockerfile and manifests.", + "$ref": "#/definitions/ArtifactGenerationProperties", + "x-ms-client-flatten": true + } + } + }, + "GitHubWorkflowProfile": { + "type": "object", + "description": "GitHub Workflow Profile", + "properties": { + "repositoryOwner": { + "type": "string", + "title": "The owner of the repository the workflow is associated with.", + "description": "Repository Owner" + }, + "repositoryName": { + "type": "string", + "title": "The name of the repository the workflow is associated with.", + "description": "Repository Name" + }, + "branchName": { + "type": "string", + "title": "The name of the branch the workflow is associated with.", + "description": "Repository Branch Name" + }, + "dockerfile": { + "type": "string", + "title": "Path to Dockerfile within the repository.", + "description": "Path to the Dockerfile within the repository." + }, + "dockerBuildContext": { + "type": "string", + "title": "Path to Dockerfile Build Context within the repository.", + "description": "Path to Dockerfile Build Context within the repository." + }, + "deploymentProperties": { + "$ref": "#/definitions/DeploymentProperties" + }, + "namespace": { + "type": "string", + "description": "Kubernetes namespace the application is deployed to.", + "title": "The Kubernetes namespace the application is deployed to" + }, + "acr": { + "$ref": "#/definitions/ACR" + }, + "oidcCredentials": { + "type": "object", + "description": "The fields needed for OIDC with GitHub.", + "properties": { + "azureClientId": { + "type": "string", + "description": "Azure Application Client ID" + }, + "azureTenantId": { + "type": "string", + "description": "Azure Directory (tenant) ID" + } + } + }, + "aksResourceId": { + "type": "string", + "description": "The Azure Kubernetes Cluster Resource the application will be deployed to.", + "title": "The Azure Kubernetes Managed Cluster resource." + }, + "prURL": { + "type": "string", + "description": "The URL to the Pull Request submitted against the users repository.", + "readOnly": true + }, + "pullNumber": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The number associated with the submitted pull request." + }, + "prStatus": { + "$ref": "#/definitions/PullRequestStatus" + }, + "lastWorkflowRun": { + "$ref": "#/definitions/WorkflowRun" + }, + "authStatus": { + "$ref": "#/definitions/AuthorizationStatus" + } + } + }, + "WorkflowListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Workflow" + }, + "description": "The list of workflows." + }, + "nextLink": { + "type": "string", + "description": "The URL to the next set of workflow results.", + "readOnly": true + } + }, + "description": "The response from List Workflows operation." + }, + "PullRequestStatus": { + "type": "string", + "readOnly": true, + "enum": [ + "unknown", + "submitted", + "merged", + "removed" + ], + "x-ms-enum": { + "name": "PullRequestStatus", + "modelAsString": true, + "values": [ + { + "value": "unknown", + "description": "Pull Request state unknown." + }, + { + "value": "submitted", + "description": "Pull Request submitted to repository." + }, + { + "value": "merged", + "description": "Pull Request merged into repository." + }, + { + "value": "removed", + "description": "Workflow no longer found within repository." + } + ] + }, + "description": "The status of the Pull Request submitted against the users repository." + }, + "DeploymentProperties": { + "type": "object", + "properties": { + "manifestType": { + "$ref": "#/definitions/ManifestType" + }, + "kubeManifestLocations": { + "type": "array", + "items": { + "type": "string" + } + }, + "helmChartPath": { + "type": "string", + "description": "Helm chart directory path in repository." + }, + "helmValues": { + "type": "string", + "description": "Helm Values.yaml file location in repository." + }, + "overrides": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "Manifest override values.", + "description": "Manifest override values." + } + } + }, + "ArtifactGenerationProperties": { + "description": "Properties used for generating artifacts such as Dockerfiles and manifests.", + "title": "Artifact Generation Properties", + "type": "object", + "properties": { + "generationLanguage": { + "$ref": "#/definitions/GenerationLanguage" + }, + "languageVersion": { + "type": "string", + "description": "The version of the language image used for execution in the generated dockerfile." + }, + "builderVersion": { + "type": "string", + "description": "The version of the language image used for building the code in the generated dockerfile." + }, + "port": { + "type": "string", + "description": "The port the application is exposed on." + }, + "appName": { + "type": "string", + "description": "The name of the app." + }, + "dockerfileOutputDirectory": { + "type": "string", + "description": "The directory to output the generated Dockerfile to." + }, + "manifestOutputDirectory": { + "type": "string", + "description": "The directory to output the generated manifests to." + }, + "dockerfileGenerationMode": { + "$ref": "#/definitions/DockerfileGenerationMode" + }, + "manifestGenerationMode": { + "$ref": "#/definitions/ManifestGenerationMode" + }, + "manifestType": { + "$ref": "#/definitions/GenerationManifestType" + }, + "imageName": { + "type": "string", + "description": "The name of the image to be generated." + }, + "namespace": { + "type": "string", + "description": "The namespace to deploy the application to." + }, + "imageTag": { + "type": "string", + "description": "The tag to apply to the generated image." + } + } + }, + "ManifestType": { + "type": "string", + "enum": [ + "helm", + "kube", + "kustomize" + ], + "x-ms-enum": { + "name": "ManifestType", + "modelAsString": true, + "values": [ + { + "value": "helm", + "description": "Repositories using helm" + }, + { + "value": "kube", + "description": "Repositories using kubernetes manifests" + } + ] + }, + "description": "Determines the type of manifests within the repository." + }, + "AuthorizationStatus": { + "type": "string", + "enum": [ + "Authorized", + "NotFound", + "Error" + ], + "readOnly": true, + "x-ms-enum": { + "name": "AuthorizationStatus", + "modelAsString": true, + "values": [ + { + "value": "Authorized", + "description": "Requests authorized successfully" + }, + { + "value": "NotFound", + "description": "Requests returned NotFound response" + }, + { + "value": "Error", + "description": "Requests returned other error response" + } + ] + }, + "description": "Determines the authorization status of requests." + }, + "GenerationLanguage": { + "type": "string", + "enum": [ + "clojure", + "csharp", + "erlang", + "go", + "gomodule", + "gradle", + "java", + "javascript", + "php", + "python", + "ruby", + "rust", + "swift" + ], + "x-ms-enum": { + "name": "GenerationLanguage", + "modelAsString": true, + "values": [ + { + "value": "clojure", + "description": "clojure language" + }, + { + "value": "csharp", + "description": "csharp language" + }, + { + "value": "erlang", + "description": "erlang language" + }, + { + "value": "go", + "description": "go language" + }, + { + "value": "gomodule", + "description": "gomodule language" + }, + { + "value": "gradle", + "description": "gradle language" + }, + { + "value": "java", + "description": "java language" + }, + { + "value": "javascript", + "description": "javascript language" + }, + { + "value": "php", + "description": "php language" + }, + { + "value": "python", + "description": "python language" + }, + { + "value": "ruby", + "description": "ruby language" + }, + { + "value": "rust", + "description": "rust language" + }, + { + "value": "swift", + "description": "swift language" + } + ] + }, + "description": "The programming language used." + }, + "ManifestGenerationMode": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "ManifestGenerationMode", + "modelAsString": true, + "values": [ + { + "value": "enabled", + "description": "Manifests will be generated" + }, + { + "value": "disabled", + "description": "Manifests will not be generated" + } + ] + }, + "description": "The mode of generation to be used for generating Manifest." + }, + "DockerfileGenerationMode": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "DockerfileGenerationMode", + "modelAsString": true, + "values": [ + { + "value": "enabled", + "description": "Dockerfiles will be generated" + }, + { + "value": "disabled", + "description": "Dockerfiles will not be generated" + } + ] + }, + "description": "The mode of generation to be used for generating Dockerfiles." + }, + "GenerationManifestType": { + "type": "string", + "enum": [ + "helm", + "kube" + ], + "x-ms-enum": { + "name": "GenerationManifestType", + "modelAsString": true, + "values": [ + { + "value": "helm", + "description": "Helm manifests" + }, + { + "value": "kube", + "description": "Kubernetes manifests" + } + ] + }, + "description": "Determines the type of manifests to be generated." + }, + "WorkflowRun": { + "type": "object", + "properties": { + "succeeded": { + "type": "boolean", + "readOnly": true, + "description": "Describes if the workflow run succeeded." + }, + "workflowRunURL": { + "type": "string", + "readOnly": true, + "description": "URL to the run of the workflow." + }, + "lastRunAt": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The timestamp of the last workflow run." + }, + "workflowRunStatus": { + "$ref": "#/definitions/WorkflowRunStatus" + } + } + }, + "WorkflowRunStatus": { + "type": "string", + "enum": [ + "queued", + "inprogress", + "completed" + ], + "x-ms-enum": { + "name": "WorkflowRunStatus", + "modelAsString": true, + "values": [ + { + "value": "queued", + "description": "Workflow run is queued" + }, + { + "value": "inprogress", + "description": "Workflow run is inprogress" + }, + { + "value": "completed", + "description": "Workflow run is completed" + } + ] + }, + "description": "Describes the status of the workflow run" + }, + "ACR": { + "type": "object", + "description": "Information on the azure container registry", + "properties": { + "acrSubscriptionId": { + "type": "string", + "description": "ACR subscription id" + }, + "acrResourceGroup": { + "type": "string", + "description": "ACR resource group" + }, + "acrRegistryName": { + "type": "string", + "description": "ACR registry" + }, + "acrRepositoryName": { + "type": "string", + "description": "ACR repository" + } + } + }, + "GeneratePreviewArtifactsResponse": { + "type": "object", + "description": "Dockerfile and manifest artifacts generated as a preview are returned as a map", + "additionalProperties": { + "type": "string" + } + }, + "GitHubOAuthInfoResponse": { + "type": "object", + "description": "URL used to authorize the Developer Hub GitHub App", + "properties": { + "authURL": { + "type": "string", + "description": "URL for authorizing the Developer Hub GitHub App" + }, + "token": { + "type": "string", + "description": "OAuth token used to make calls to GitHub" + } + } + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "DeleteWorkflowResponse": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "delete status message" + } + }, + "description": "delete response if content must be provided on delete operation" + }, + "GitHubOAuthCallRequest": { + "type": "object", + "properties": { + "redirectUrl": { + "type": "string", + "description": "The URL the client will redirect to on successful authentication. If empty, no redirect will occur." + } + }, + "description": "GitHubOAuth request object" + }, + "GitHubOAuthResponse": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Properties of a workflow.", + "$ref": "#/definitions/GitHubOAuthProperties", + "x-ms-client-flatten": true + } + }, + "description": "Singleton response of GitHubOAuth containing " + }, + "GitHubOAuthProperties": { + "type": "object", + "properties": { + "username": { + "type": "string", + "description": "user making request" + } + }, + "description": "The response from List GitHubOAuth operation." + }, + "GitHubOAuthListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GitHubOAuthResponse" + }, + "description": "Singleton list response containing one GitHubOAuthResponse response" + } + }, + "description": "The response from List GitHubOAuth operation." + } + }, + "parameters": { + "ManagedClusterParameter": { + "name": "managedClusterResource", + "in": "query", + "required": false, + "type": "string", + "description": "The ManagedCluster resource associated with the workflows.", + "x-ms-parameter-location": "method" + }, + "WorkflowNameParameter": { + "name": "workflowName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the workflow resource.", + "x-ms-parameter-location": "method" + }, + "GitHubOAuthCodeParameter": { + "name": "code", + "in": "query", + "required": true, + "type": "string", + "description": "The code response from authenticating the GitHub App.", + "x-ms-parameter-location": "method" + }, + "GitHubOAuthStateParameter": { + "name": "state", + "in": "query", + "required": true, + "type": "string", + "description": "The state response from authenticating the GitHub App.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/developerhub/resource-manager/readme.md b/specification/developerhub/resource-manager/readme.md index a03b754593f4..65643f6f520c 100644 --- a/specification/developerhub/resource-manager/readme.md +++ b/specification/developerhub/resource-manager/readme.md @@ -26,10 +26,20 @@ These are the global settings for the DeveloperHub API. ``` yaml openapi-type: arm -tag: package-2023-08 +tag: package-preview-2024-05 ``` +### 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.DevHub/preview/2024-05-01-preview/workflow.json + - Microsoft.DevHub/preview/2024-05-01-preview/iac.json +``` + ### Tag: package-2023-08 These settings apply only when `--tag=package-2023-08` is specified on the command line. @@ -70,6 +80,7 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-js + - repo: azure-sdk-for-java ``` ## Python From dc27f9b32787533cd4d07fe0de5245f2f8354dbe Mon Sep 17 00:00:00 2001 From: jonathanserbent <34686049+jonathanserbent@users.noreply.github.com> Date: Thu, 30 May 2024 15:09:34 -0500 Subject: [PATCH 08/49] Azure Search DataPlane 2024-07-01 (#29058) * Copy over old spec * Update version to 07-01 * Add feature spec changes * Update docs.microsoft.com to learn.microsoft.com * Use common error response instead of our own model * Make skillsetCount required * Add additional feature changes * update readme tags * Fix error in readme * Update Examples * Running Prettier * Running Prettier * Addition feature change * Applying Feedback * Apply feedback to update Description Co-authored-by: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com> * Applying feedback on vectorizerName description change Co-authored-by: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com> * Adding x-ms-client-name to RawVectorQuery --------- Co-authored-by: Jonathan Serbent Co-authored-by: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com> --- .../search/data-plane/Azure.Search/readme.md | 30 +- .../SearchIndexAutocompleteDocumentsGet.json | 38 + .../SearchIndexAutocompleteDocumentsPost.json | 36 + .../examples/SearchIndexCountDocuments.json | 12 + .../examples/SearchIndexGetDocument.json | 25 + .../examples/SearchIndexIndexDocuments.json | 96 + .../SearchIndexSearchDocumentsGet.json | 86 + .../SearchIndexSearchDocumentsPost.json | 119 + ...SearchIndexSearchDocumentsSemanticGet.json | 52 + ...earchIndexSearchDocumentsSemanticPost.json | 69 + .../SearchIndexSuggestDocumentsGet.json | 47 + .../SearchIndexSuggestDocumentsPost.json | 39 + .../SearchServiceCreateDataSource.json | 70 + .../examples/SearchServiceCreateIndex.json | 700 + .../examples/SearchServiceCreateIndexer.json | 58 + ...SearchServiceCreateOrUpdateDataSource.json | 95 + .../SearchServiceCreateOrUpdateIndex.json | 863 ++ .../SearchServiceCreateOrUpdateIndexer.json | 78 + .../SearchServiceCreateOrUpdateSkillset.json | 387 + ...SearchServiceCreateOrUpdateSynonymMap.json | 47 + .../examples/SearchServiceCreateSkillset.json | 307 + .../SearchServiceCreateSynonymMap.json | 38 + .../SearchServiceDeleteDataSource.json | 11 + .../examples/SearchServiceDeleteIndex.json | 11 + .../examples/SearchServiceDeleteIndexer.json | 11 + .../examples/SearchServiceDeleteSkillset.json | 11 + .../SearchServiceDeleteSynonymMap.json | 11 + .../examples/SearchServiceGetDataSource.json | 41 + .../examples/SearchServiceGetIndex.json | 344 + .../SearchServiceGetIndexStatistics.json | 16 + .../examples/SearchServiceGetIndexer.json | 36 + .../SearchServiceGetIndexerStatus.json | 89 + .../SearchServiceGetServiceStatistics.json | 52 + .../examples/SearchServiceGetSkillset.json | 144 + .../examples/SearchServiceGetSynonymMap.json | 25 + .../examples/SearchServiceIndexAnalyze.json | 37 + .../SearchServiceListDataSources.json | 45 + .../examples/SearchServiceListIndexers.json | 76 + .../examples/SearchServiceListIndexes.json | 315 + .../examples/SearchServiceListSkillsets.json | 148 + .../SearchServiceListSynonymMaps.json | 31 + .../examples/SearchServiceResetIndexer.json | 10 + .../examples/SearchServiceRunIndexer.json | 10 + .../stable/2024-07-01/searchindex.json | 2112 +++ .../stable/2024-07-01/searchservice.json | 11522 ++++++++++++++++ 45 files changed, 18399 insertions(+), 1 deletion(-) create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexAutocompleteDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexAutocompleteDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexCountDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexGetDocument.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexIndexDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsSemanticGet.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsSemanticPost.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSuggestDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSuggestDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteIndex.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndex.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndexStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndexerStatus.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetServiceStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceIndexAnalyze.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListDataSources.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListIndexers.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListIndexes.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListSkillsets.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListSynonymMaps.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceResetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceRunIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/searchindex.json create mode 100644 specification/search/data-plane/Azure.Search/stable/2024-07-01/searchservice.json diff --git a/specification/search/data-plane/Azure.Search/readme.md b/specification/search/data-plane/Azure.Search/readme.md index fa796e4f2369..cd37e39af29f 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-05-01-preview +tag: package-2024-07-01 directive: - where: @@ -167,6 +167,34 @@ directive: - RequiredReadOnlyProperties ``` +### Tag: package-2024-07-01 + +These settings apply only when `--tag=package-2024-07-01` is specified on the command line. + +``` yaml $(tag) == 'package-2024-07-01' +input-file: +- stable/2024-07-01/searchservice.json +- stable/2024-07-01/searchindex.json +``` + +### Tag: package-2024-07-searchservice + +These settings apply only when `--tag=package-2024-07-searchservice` is specified on the command line. + +``` yaml $(tag) == 'package-2024-07-searchservice' +input-file: +- stable/2024-07-01/searchservice.json +``` + +### Tag: package-2024-07-searchindex + +These settings apply only when `--tag=package-2024-07-searchindex` is specified on the command line. + +``` yaml $(tag) == 'package-2024-07-searchindex' +input-file: +- stable/2024-07-01/searchindex.json +``` + ### Tag: package-2024-05-01-preview These settings apply only when `--tag=package-2024-05-01-preview` is specified on the command line. diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexAutocompleteDocumentsGet.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexAutocompleteDocumentsGet.json new file mode 100644 index 000000000000..ba6cc8e52fe2 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexAutocompleteDocumentsGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-07-01", + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "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/stable/2024-07-01/examples/SearchIndexAutocompleteDocumentsPost.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexAutocompleteDocumentsPost.json new file mode 100644 index 000000000000..859afde5d944 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexAutocompleteDocumentsPost.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-07-01", + "autocompleteRequest": { + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "highlightPostTag": "", + "highlightPreTag": "", + "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/stable/2024-07-01/examples/SearchIndexCountDocuments.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexCountDocuments.json new file mode 100644 index 000000000000..1b29fbd19012 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexCountDocuments.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": 427 + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexGetDocument.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexGetDocument.json new file mode 100644 index 000000000000..64cf2c3e326b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexGetDocument.json @@ -0,0 +1,25 @@ +{ + "operationId": "Documents_Get", + "title": "SearchIndexGetDocument", + "parameters": { + "endpoint": "https://exampleservice.search.windows.net", + "indexName": "getdocumentexample", + "key": "1", + "$select": [ + "docId", + "title", + "description" + ], + "api-version": "2024-07-01", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "docId": "1", + "title": "Nice Hotel", + "description": "Cheapest hotel in town" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexIndexDocuments.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexIndexDocuments.json new file mode 100644 index 000000000000..6f976253c7ca --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexIndexDocuments.json @@ -0,0 +1,96 @@ +{ + "operationId": "Documents_Index", + "title": "SearchIndexIndexDocuments", + "parameters": { + "endpoint": "https://exampleservice.search.windows.net", + "indexName": "indexdocumentsexample", + "api-version": "2024-07-01", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "batch": { + "value": [ + { + "@search.action": "upload", + "docId": "1", + "title": "Fancy Stay", + "description": "Best hotel in town" + }, + { + "@search.action": "merge", + "docId": "2", + "title": "Roach Motel" + }, + { + "@search.action": "mergeOrUpload", + "docId": "3", + "title": "Econo Motel" + }, + { + "@search.action": "delete", + "docId": "4" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "1", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "2", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "3", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "4", + "status": true, + "errorMessage": null, + "statusCode": 200 + } + ] + } + }, + "207": { + "body": { + "value": [ + { + "key": "1", + "status": true, + "errorMessage": null, + "statusCode": 201 + }, + { + "key": "2", + "status": false, + "errorMessage": "Document not found.", + "statusCode": 404 + }, + { + "key": "3", + "status": true, + "errorMessage": null, + "statusCode": 201 + }, + { + "key": "4", + "status": true, + "errorMessage": null, + "statusCode": 200 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsGet.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsGet.json new file mode 100644 index 000000000000..9701cbfe9947 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsGet.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-07-01", + "$count": true, + "facet": [ + "category,count:10,sort:count" + ], + "$filter": "rating gt 10", + "highlight": [ + "title" + ], + "highlightPostTag": "", + "highlightPreTag": "", + "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": [ + "Nice Hotel" + ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ + "Fancy Hotel" + ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsPost.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsPost.json new file mode 100644 index 000000000000..7ecedecf6fad --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsPost.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-07-01", + "searchRequest": { + "count": true, + "facets": [ + "category,count:10,sort:count" + ], + "filter": "rating gt 4.0", + "highlight": "description", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "orderby": "rating desc", + "queryType": "simple", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": "category,description", + "searchMode": "any", + "sessionId": "mysessionid", + "scoringStatistics": "global", + "select": "hotelId,category,description", + "skip": 0, + "top": 10, + "vectorQueries": [ + { + "kind": "vector", + "vector": [ + 0.103, + 0.0712, + 0.0852, + 0.1547, + 0.1183 + ], + "fields": "descriptionEmbedding", + "k": 5, + "exhaustive": true, + "oversampling": 20.0, + "weight": 2.0 + } + ], + "vectorFilterMode": "preFilter" + } + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "@search.nextPageParameters": { + "count": true, + "facets": [ + "category,count:10,sort:count" + ], + "filter": "rating gt 4.0", + "highlight": "title", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "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": 2, + "top": 8 + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ + "Nice Hotel" + ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ + "Fancy Hotel" + ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ], + "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-01" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsSemanticGet.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsSemanticGet.json new file mode 100644 index 000000000000..2fa8b5a0c902 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsSemanticGet.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-07-01", + "$count": true, + "highlightPostTag": "", + "highlightPreTag": "", + "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 where air is ascending (over land in this case), but not where it is descending (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 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." + } + ], + "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/stable/2024-07-01/examples/SearchIndexSearchDocumentsSemanticPost.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsSemanticPost.json new file mode 100644 index 000000000000..e74b21e83c67 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsSemanticPost.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-07-01", + "searchRequest": { + "count": true, + "highlightPostTag": "", + "highlightPreTag": "", + "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 where air is ascending (over land in this case), but not where it is descending (over the river).", + "score": 0.94639826 + } + ], + "@search.nextPageParameters": { + "count": true, + "highlightPostTag": "", + "highlightPreTag": "", + "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 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." + } + ], + "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-07-01" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSuggestDocumentsGet.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSuggestDocumentsGet.json new file mode 100644 index 000000000000..24cf118118d0 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSuggestDocumentsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-07-01", + "$filter": "rating gt 10", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "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 Hotel", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy Hotel", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSuggestDocumentsPost.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSuggestDocumentsPost.json new file mode 100644 index 000000000000..8008dbc517f3 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSuggestDocumentsPost.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-07-01", + "suggestRequest": { + "filter": "rating gt 4.0", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "orderby": "rating desc", + "search": "hote", + "searchFields": "title", + "select": "docId,title,description", + "suggesterName": "sg", + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice Hotel", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy Hotel", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateDataSource.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateDataSource.json new file mode 100644 index 000000000000..3ebba14f4e49 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateDataSource.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-07-01", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "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": "" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "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": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateIndex.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateIndex.json new file mode 100644 index 000000000000..5591bedf4097 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateIndex.json @@ -0,0 +1,700 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-07-01", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "descriptionEmbedding", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myHnswSQProfile" + }, + { + "name": "descriptionEmbedding_notstored", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": false, + "stored": false, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myHnswSQProfile" + }, + { + "name": "descriptionEmbedding_forBQ", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myHnswBQProfile" + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "nameEmbedding", + "type": "Collection(Edm.Half)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myHnswProfile" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "" + } + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity", + "b": 0.5, + "k1": 1.3 + }, + "semantic": { + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + }, + "vectorSearch": { + "profiles": [ + { + "name": "myHnswProfile", + "algorithm": "myHnsw" + }, + { + "name": "myHnswSQProfile", + "algorithm": "myHnsw", + "compression": "mySQ8" + }, + { + "name": "myHnswBQProfile", + "algorithm": "myHnsw", + "compression": "myBQ" + }, + { + "name": "myAlgorithm", + "algorithm": "myExhaustive" + } + ], + "algorithms": [ + { + "name": "myHnsw", + "kind": "hnsw", + "hnswParameters": { + "m": 4, + "metric": "cosine" + } + }, + { + "name": "myExhaustive", + "kind": "exhaustiveKnn", + "exhaustiveKnnParameters": { + "metric": "cosine" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rerankWithOriginalVectors": true, + "defaultOversampling": 10.0 + }, + { + "name": "myBQ", + "kind": "binaryQuantization", + "rerankWithOriginalVectors": true, + "defaultOversampling": 10.0 + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": 1536, + "vectorSearchProfile": "myHnswSQProfile", + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding_notstored", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": false, + "stored": false, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myHnswSQProfile" + }, + { + "name": "descriptionEmbedding_forBQ", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": 1536, + "vectorSearchProfile": "myHnswBQProfile", + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "nameEmbedding", + "type": "Collection(Edm.Half)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": 1536, + "vectorSearchProfile": "myHnswProfile", + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "functionAggregation": "sum", + "text": { + "weights": { + "hotelName": 5.0 + } + }, + "functions": [ + { + "fieldName": "location", + "interpolation": "logarithmic", + "type": "distance", + "boost": 5.0, + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10.0 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenFilters": [], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity", + "b": 0.5, + "k1": 1.3 + }, + "semantic": { + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "myHnsw", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "myExhaustive", + "kind": "exhaustiveKnn", + "exhaustiveKnnParameters": { + "metric": "cosine" + } + } + ], + "profiles": [ + { + "name": "myHnswProfile", + "algorithm": "myHnsw" + }, + { + "name": "myHnswSQProfile", + "algorithm": "myHnsw", + "compression": "mySQ8" + }, + { + "name": "myHnswBQProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi", + "compression": "myBQ" + }, + { + "name": "myAlgorithm", + "algorithm": "myExhaustive" + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rerankWithOriginalVectors": true, + "defaultOversampling": 10.0 + }, + { + "name": "myBQ", + "kind": "binaryQuantization", + "rerankWithOriginalVectors": true, + "defaultOversampling": 10.0 + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateIndexer.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateIndexer.json new file mode 100644 index 000000000000..8d15452eb354 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateIndexer.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-07-01", + "indexer": { + "name": "myindexer", + "description": "an indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myindexer", + "description": "an indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateDataSource.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateDataSource.json new file mode 100644 index 000000000000..5b27ebdb0a55 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateDataSource.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2024-07-01", + "Prefer": "return=representation", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "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": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "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": null + } + } + }, + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "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": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateIndex.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateIndex.json new file mode 100644 index 000000000000..72dfe8bb9d81 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateIndex.json @@ -0,0 +1,863 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "allowIndexDowntime": false, + "api-version": "2024-07-01", + "Prefer": "return=representation", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "descriptionEmbedding", + "type": "Collection(Edm.Single)", + "dimensions": 1536, + "vectorSearchProfile": "myHnswProfile", + "searchable": true, + "retrievable": true + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.ClassicSimilarity" + }, + "semantic": { + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + }, + "vectorSearch": { + "profiles": [ + { + "name": "myHnswProfile", + "algorithm": "myHnsw" + }, + { + "name": "myAlgorithm", + "algorithm": "myExhaustive" + } + ], + "algorithms": [ + { + "name": "myHnsw", + "kind": "hnsw", + "hnswParameters": { + "m": 4, + "metric": "cosine" + } + }, + { + "name": "myExhaustive", + "kind": "exhaustiveKnn", + "exhaustiveKnnParameters": { + "metric": "cosine" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": 1536, + "vectorSearchProfile": "myHnswProfile", + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "functionAggregation": "sum", + "text": { + "weights": { + "hotelName": 5.0 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5.0, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10.0 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.ClassicSimilarity" + }, + "semantic": { + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "myHnsw", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "myExhaustive", + "kind": "exhaustiveKnn", + "exhaustiveKnnParameters": { + "metric": "cosine" + } + } + ], + "profiles": [ + { + "name": "myHnswProfile", + "algorithm": "myHnsw" + }, + { + "name": "myAlgorithm", + "algorithm": "myExhaustive" + } + ] + } + } + }, + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": 1536, + "vectorSearchProfile": "myHnswProfile", + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "functionAggregation": "sum", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "semantic": { + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "myHnsw", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "myExhaustive", + "kind": "exhaustiveKnn", + "exhaustiveKnnParameters": { + "metric": "cosine" + } + } + ], + "profiles": [ + { + "name": "myHnswProfile", + "algorithm": "myHnsw" + }, + { + "name": "myAlgorithm", + "algorithm": "myExhaustive" + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateIndexer.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateIndexer.json new file mode 100644 index 000000000000..dfcdc9fd148b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateIndexer.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-07-01", + "Prefer": "return=representation", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateSkillset.json new file mode 100644 index 000000000000..1acf71dc07ab --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateSkillset.json @@ -0,0 +1,387 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2024-07-01", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateSynonymMap.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateSynonymMap.json new file mode 100644 index 000000000000..8d7c9e29a646 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateOrUpdateSynonymMap.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2024-07-01", + "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": null + } + } + }, + "responses": { + "200": { + "body": { + "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": null + } + } + }, + "201": { + "body": { + "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": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateSkillset.json new file mode 100644 index 000000000000..4769c919ccdf --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateSkillset.json @@ -0,0 +1,307 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2024-07-01", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "knowledgeStore": { + "storageConnectionString": "DefaultEndpointsProtocol=https;AccountName=myStorage;AccountKey=myStorageKey;EndpointSuffix=core.windows.net", + "projections": [ + { + "tables": [ + { + "tableName": "Reviews", + "generatedKeyName": "ReviewId", + "source": "/document/Review", + "sourceContext": null, + "inputs": [] + }, + { + "tableName": "Sentences", + "generatedKeyName": "SentenceId", + "source": "/document/Review/Sentences/*", + "sourceContext": null, + "inputs": [] + }, + { + "tableName": "KeyPhrases", + "generatedKeyName": "KeyPhraseId", + "source": "/document/Review/Sentences/*/KeyPhrases", + "sourceContext": null, + "inputs": [] + }, + { + "tableName": "Entities", + "generatedKeyName": "EntityId", + "source": "/document/Review/Sentences/*/Entities/*", + "sourceContext": null, + "inputs": [] + } + ] + }, + { + "objects": [ + { + "storageContainer": "Reviews", + "source": "/document/Review", + "generatedKeyName": "/document/Review/Id" + } + ] + } + ] + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateSynonymMap.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateSynonymMap.json new file mode 100644 index 000000000000..5928314232fc --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceCreateSynonymMap.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-07-01", + "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": "myApplicationSecret" + } + } + } + }, + "responses": { + "201": { + "body": { + "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": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteDataSource.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteDataSource.json new file mode 100644 index 000000000000..a0a88ff02612 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteDataSource.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteIndex.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteIndex.json new file mode 100644 index 000000000000..5ab2bfb51a69 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteIndex.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteIndexer.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteIndexer.json new file mode 100644 index 000000000000..ce97fbb336f5 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteIndexer.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteSkillset.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteSkillset.json new file mode 100644 index 000000000000..a54e05711829 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteSkillset.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteSynonymMap.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteSynonymMap.json new file mode 100644 index 000000000000..0ce61b4b9aca --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceDeleteSynonymMap.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetDataSource.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetDataSource.json new file mode 100644 index 000000000000..4ed8bf94cb93 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetDataSource.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndex.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndex.json new file mode 100644 index 000000000000..bce8ace8241e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndex.json @@ -0,0 +1,344 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": 1536, + "vectorSearchProfile": "myHnswProfile", + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "functionAggregation": "sum", + "text": { + "weights": { + "hotelName": 5.0 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5.0, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10.0 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + }, + "semantic": { + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "myHnsw", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "myExhaustive", + "kind": "exhaustiveKnn", + "exhaustiveKnnParameters": { + "metric": "cosine" + } + } + ], + "profiles": [ + { + "name": "myHnswProfile", + "algorithm": "myHnsw" + }, + { + "name": "myAlgorithm", + "algorithm": "myExhaustive" + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndexStatistics.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndexStatistics.json new file mode 100644 index 000000000000..488b6594ea37 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndexStatistics.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "documentCount": 239572, + "storageSize": 72375920, + "vectorIndexSize": 123456 + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndexer.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndexer.json new file mode 100644 index 000000000000..36284505e003 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndexer.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndexerStatus.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndexerStatus.json new file mode 100644 index 000000000000..10f679024a3c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetIndexerStatus.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-07-01" + }, + "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/stable/2024-07-01/examples/SearchServiceGetServiceStatistics.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetServiceStatistics.json new file mode 100644 index 000000000000..68b3c18500bb --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetServiceStatistics.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "counters": { + "documentCount": { + "usage": 7093, + "quota": 10000 + }, + "indexesCount": { + "usage": 3, + "quota": 3 + }, + "indexersCount": { + "usage": 3, + "quota": 3 + }, + "dataSourcesCount": { + "usage": 1, + "quota": 3 + }, + "storageSize": { + "usage": 914529, + "quota": 52428800 + }, + "synonymMaps": { + "usage": 2, + "quota": 3 + }, + "skillsetCount": { + "usage": 1, + "quota": 3 + }, + "vectorIndexSize": { + "usage": 123456, + "quota": 26214400 + } + }, + "limits": { + "maxFieldsPerIndex": 1000, + "maxFieldNestingDepthPerIndex": 10, + "maxComplexCollectionFieldsPerIndex": 100, + "maxComplexObjectsInCollectionsPerDocument": 3000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetSkillset.json new file mode 100644 index 000000000000..3224713ed5cf --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetSkillset.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetSynonymMap.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetSynonymMap.json new file mode 100644 index 000000000000..31a9754f84ed --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceGetSynonymMap.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceIndexAnalyze.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceIndexAnalyze.json new file mode 100644 index 000000000000..ca3e97ad91f0 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceIndexAnalyze.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2024-07-01", + "request": { + "text": "Text to analyze", + "analyzer": "standard.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/stable/2024-07-01/examples/SearchServiceListDataSources.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListDataSources.json new file mode 100644 index 000000000000..ba4a2ed04626 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListDataSources.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListIndexers.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListIndexers.json new file mode 100644 index 000000000000..bd39f0576aa3 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListIndexers.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydocdbdatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + }, + { + "name": "myotherindexer", + "description": "another cool indexer", + "dataSourceName": "myblobdatasource", + "targetIndexName": "orders", + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "batchSize": 15 + }, + "fieldMappings": [ + { + "sourceFieldName": "PersonName", + "targetFieldName": "FirstName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 0 + } + } + }, + { + "sourceFieldName": "PersonName", + "targetFieldName": "LastName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 1 + } + } + } + ], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListIndexes.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListIndexes.json new file mode 100644 index 000000000000..8bbbf44a33cb --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListIndexes.json @@ -0,0 +1,315 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "semantic": { + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + } + }, + { + "name": "testindex", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": false, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "hidden", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": false, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [], + "defaultScoringProfile": null, + "suggesters": [], + "analyzers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": null, + "encryptionKey": null + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListSkillsets.json new file mode 100644 index 000000000000..4790a21afbe9 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListSkillsets.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListSynonymMaps.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListSynonymMaps.json new file mode 100644 index 000000000000..a749fa1edbc9 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceListSynonymMaps.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + }, + { + "name": "myothersynonymmap", + "format": "solr", + "synonyms": "couch, sofa, chesterfield\npop, soda\ntoque, hat", + "encryptionKey": null + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceResetIndexer.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceResetIndexer.json new file mode 100644 index 000000000000..7bd2d1f2b8d3 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceResetIndexer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-07-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceRunIndexer.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceRunIndexer.json new file mode 100644 index 000000000000..48924939dfbb --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchServiceRunIndexer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-07-01" + }, + "responses": { + "202": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/stable/2024-07-01/searchindex.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/searchindex.json new file mode 100644 index 000000000000..0ef09404dfef --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/searchindex.json @@ -0,0 +1,2112 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchIndexClient", + "description": "Client that can be used to query an index and upload, merge, or delete documents.", + "version": "2024-07-01", + "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-` 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-` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7.", + "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-` option, such as `extractive|highlight-true`. Defaults to `None`.", + "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" + } + } + ], + "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." + }, + "FacetResult": { + "properties": { + "count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The approximate count of documents falling within the bucket described by this facet." + } + }, + "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": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/FacetResult" + } + }, + "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.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." + } + }, + "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'." + } + }, + "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." + }, + "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." + }, + "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. " + } + }, + "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." + } + }, + "required": [ + "text" + ], + "description": "The query parameters to use for vector search when a text value that needs to be vectorized is provided." + }, + "VectorQueryKind": { + "type": "string", + "enum": [ + "vector", + "text" + ], + "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." + } + ] + }, + "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." + }, + "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." + }, + "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." + }, + "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." + }, + "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." + } + }, + "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." + }, + "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-` 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-` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7." + }, + "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-` option, such as `extractive|highlight-true`. Defaults to `None`." + } + }, + "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/stable/2024-07-01/searchservice.json b/specification/search/data-plane/Azure.Search/stable/2024-07-01/searchservice.json new file mode 100644 index 000000000000..1963fef0f568 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/stable/2024-07-01/searchservice.json @@ -0,0 +1,11522 @@ +{ + "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-07-01", + "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" + } + ], + "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.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" + } + ], + "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" + } + ], + "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" + } + } + } + } + }, + "/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" + } + } + } + } + }, + "/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." + }, + "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" + } + }, + "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" + } + }, + "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 + } + }, + "required": [ + "name", + "kind" + ], + "description": "Contains configuration options specific to the compression method used during indexing or querying." + }, + "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." + }, + "VectorSearchVectorizer": { + "type": "object", + "discriminator": "kind", + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.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." + }, + "VectorSearchVectorizerKind": { + "type": "string", + "enum": [ + "azureOpenAI", + "customWebApi" + ], + "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." + } + ] + }, + "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 `` (with brackets) if you don't want the connection string updated. Set to `` 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." + } + } + }, + "SearchIndexerDataSourceType": { + "type": "string", + "enum": [ + "azuresql", + "cosmosdb", + "azureblob", + "azuretable", + "mysql", + "adlsgen2" + ], + "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." + } + ] + }, + "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." + }, + "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." + }, + "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" + ], + "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." + } + ] + }, + "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." + }, + "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 + } + }, + "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." + }, + "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." + }, + "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 + }, + "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" + } + }, + "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." + }, + "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." + }, + "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." + } + }, + "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" + ] + }, + "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." + } + }, + "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." + }, + "WebApiSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + }, + { + "$ref": "#/definitions/WebApiParameters" + } + ], + "properties": { + "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." + } + }, + "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." + }, + "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." + }, + "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." + }, + "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" + } + } + }, + "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." + }, + "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": { + "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": [ + "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" + } + } +} From 9582151c5dddde96f2b2c4e3a533c278115140ce Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Fri, 31 May 2024 06:46:37 +0800 Subject: [PATCH 09/49] radiologyinsights, tsp-config, java on final-type of LRO (#29273) Co-authored-by: catalinaperalta --- .../HealthInsights.RadiologyInsights/tspconfig.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml index 52377bdf6bf5..c6cbe823a1bd 100644 --- a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml @@ -40,6 +40,9 @@ options: emitter-output-dir: "{java-sdk-folder}/sdk/{service-directory-name}/azure-health-insights-radiologyinsights" flavor: azure stream-style-serialization: false + polling: + inferRadiologyInsights: + final-type: com.azure.health.insights.radiologyinsights.models.RadiologyInsightsInferenceResult "@azure-tools/typespec-csharp": save-inputs: false clear-output-folder: true From bc06df2282fe4d29f42dce56a930fac14ea0f6c4 Mon Sep 17 00:00:00 2001 From: Saurabh Chugh Date: Thu, 30 May 2024 19:03:03 -0700 Subject: [PATCH 10/49] Getting rid of redundant credential resources in dotnet sdk (#29093) Co-authored-by: Saurabh Chugh Co-authored-by: Heng Lu <79895375+ms-henglu@users.noreply.github.com> --- .../stable/2018-06-01/datafactory.json | 36 ------------------- 1 file changed, 36 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json index b6a0482a6dab..12cf1c733b0b 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json @@ -7671,42 +7671,6 @@ "properties" ] }, - "ManagedIdentityCredentialResource": { - "description": "Credential resource type.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CredentialResource" - } - ], - "properties": { - "properties": { - "$ref": "./entityTypes/Credential.json#/definitions/ManagedIdentityCredential", - "description": "Managed Identity Credential properties." - } - }, - "required": [ - "properties" - ] - }, - "ServicePrincipalCredentialResource": { - "description": "Credential resource type.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CredentialResource" - } - ], - "properties": { - "properties": { - "$ref": "./entityTypes/Credential.json#/definitions/ServicePrincipalCredential", - "description": "Service Principal Credential properties." - } - }, - "required": [ - "properties" - ] - }, "ManagedVirtualNetworkListResponse": { "description": "A list of managed Virtual Network resources.", "type": "object", From 775b4ba0f29803f20821f1c3a63cdcf34f6944d2 Mon Sep 17 00:00:00 2001 From: mmorr-msft <51933005+mmorr-msft@users.noreply.github.com> Date: Fri, 31 May 2024 07:02:17 -0700 Subject: [PATCH 11/49] Create Mircosoft.VerifiedId Resource Provider public preview (#28933) * copy verifiedid from private * fix latest style rules * rerun validate * change key name * re-run local validation * update examples * manually fix generated docs * trying to make it pass validation, local validation won't run * maybe fixed? * fix lists? --- .../Authorities_CreateOrUpdate.json | 36 ++ .../Authorities_Delete.json | 14 + .../2024-01-26-preview/Authorities_Get.json | 22 + .../Authorities_ListByResourceGroup.json | 31 ++ .../Authorities_ListBySubscription.json | 30 ++ .../Authorities_Update.json | 23 + .../2024-01-26-preview/Operations_List.json | 28 + .../verifiedid/Microsoft.VerifiedId/main.tsp | 79 +++ .../Microsoft.VerifiedId/tspconfig.yaml | 12 + .../examples/Authorities_CreateOrUpdate.json | 36 ++ .../examples/Authorities_Delete.json | 14 + .../examples/Authorities_Get.json | 22 + .../Authorities_ListByResourceGroup.json | 31 ++ .../Authorities_ListBySubscription.json | 30 ++ .../examples/Authorities_Update.json | 23 + .../examples/Operations_List.json | 28 + .../2024-01-26-preview/verifiedid.json | 508 ++++++++++++++++++ .../verifiedid/resource-manager/readme.az.md | 28 + .../verifiedid/resource-manager/readme.cli.md | 1 + .../resource-manager/readme.csharp.md | 15 + .../verifiedid/resource-manager/readme.go.md | 11 + .../verifiedid/resource-manager/readme.md | 79 +++ .../resource-manager/readme.python.md | 23 + .../resource-manager/readme.typescript.md | 14 + 24 files changed, 1138 insertions(+) create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Delete.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Get.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListBySubscription.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Update.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Operations_List.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/main.tsp create mode 100644 specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_CreateOrUpdate.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Delete.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Get.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListByResourceGroup.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListBySubscription.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Update.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Operations_List.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json create mode 100644 specification/verifiedid/resource-manager/readme.az.md create mode 100644 specification/verifiedid/resource-manager/readme.cli.md create mode 100644 specification/verifiedid/resource-manager/readme.csharp.md create mode 100644 specification/verifiedid/resource-manager/readme.go.md create mode 100644 specification/verifiedid/resource-manager/readme.md create mode 100644 specification/verifiedid/resource-manager/readme.python.md create mode 100644 specification/verifiedid/resource-manager/readme.typescript.md diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json new file mode 100644 index 000000000000..778cb01894ee --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "operationId": "Authorities_CreateOrUpdate", + "title": "CreateAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111", + "resource": { + "properties": {}, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/aurthorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/aurthorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + } + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Delete.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Delete.json new file mode 100644 index 000000000000..bd8155a9c921 --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Delete.json @@ -0,0 +1,14 @@ +{ + "operationId": "Authorities_Delete", + "title": "DeleteAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Get.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Get.json new file mode 100644 index 000000000000..2d8394e5862f --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Get.json @@ -0,0 +1,22 @@ +{ + "operationId": "Authorities_Get", + "title": "GetAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + } + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json new file mode 100644 index 000000000000..181c8986ac08 --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "title": "Authorities_ListByResourceGroup", + "operationId": "Authorities_ListByResourceGroup", + "parameters": { + "api-version": "2024-01-26-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "centralus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "systemData": { + "createdBy": "ypsrynjsvwvcooacwzwb", + "createdByType": "User", + "createdAt": "2023-12-28T17:24:15.284Z", + "lastModifiedBy": "qlojlakxwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-12-28T17:24:15.284Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities?api-version=2024-01-26-preview&$skiptoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" + } + } + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListBySubscription.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListBySubscription.json new file mode 100644 index 000000000000..61840f59931f --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListBySubscription.json @@ -0,0 +1,30 @@ +{ + "title": "Authorities_ListBySubscription", + "operationId": "Authorities_ListBySubscription", + "parameters": { + "api-version": "2024-01-26-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "centralus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "systemData": { + "createdBy": "ypsrynjsvwvcooacwzwb", + "createdByType": "User", + "createdAt": "2023-12-28T17:24:15.284Z", + "lastModifiedBy": "qlojlakxwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-12-28T17:24:15.284Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities?api-version=2024-01-26-preview&$skiptoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" + } + } + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Update.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Update.json new file mode 100644 index 000000000000..91403cf95deb --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Update.json @@ -0,0 +1,23 @@ +{ + "operationId": "Authorities_Update", + "title": "UpdateAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/aurthorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + } + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Operations_List.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Operations_List.json new file mode 100644 index 000000000000..09854063c45a --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-01-26-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.VerifiedId/Authorities/read", + "isDataAction": true, + "display": { + "provider": "Microsoft.VerifiedId", + "resource": "Authorities", + "operation": "read", + "description": "Read the Authority resources for the Verified ID service." + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/operations?api-version=2024-01-26-preview" + } + } + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/main.tsp b/specification/verifiedid/Microsoft.VerifiedId/main.tsp new file mode 100644 index 000000000000..01f85aabab69 --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/main.tsp @@ -0,0 +1,79 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; + +@armProviderNamespace("Microsoft.VerifiedId") +@service({ + title: "VerifiedIdMgmtClient", +}) +@versioned(Microsoft.VerifiedId.Versions) +@doc("VerifiedId Resource Provider management API.") +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.VerifiedId; + +/** + * Supported versions for Microsoft.VerifiedId. + */ +enum Versions { + /** + * The 2024-01-26-preview version of the Microsoft.VerifiedId resource provider. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + v2024_01_26_preview: "2024-01-26-preview", +} + +interface Operations extends Azure.ResourceManager.Operations {} + +@doc("A VerifiedId authority resource") +model Authority is TrackedResource { + @doc("The ID of the authority") + @pattern("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$") + @key("authorityName") + @segment("authorities") + @path + name: string; +} + +@doc("The status of the current operation.") +@Azure.Core.lroStatus +union ProvisioningState { + string, + ResourceProvisioningState, + + @doc("Initial provisioning in progress") + Provisioning: "Provisioning", + + @doc("Update in progress") + Updating: "Updating", + + @doc("Deletion in progress") + Deleting: "Deleting", + + @doc("Change accepted for processing") + Accepted: "Accepted", +} + +@doc("Details of the VerifiedId Authority.") +model AuthorityProperties { + @visibility("read") + @doc("The status of the last operation.") + provisioningState?: ProvisioningState; +} + +@armResourceOperations(Authority) +interface Authorities { + get is ArmResourceRead; + createOrUpdate is ArmResourceCreateOrReplaceAsync; + update is ArmResourcePatchSync; + delete is ArmResourceDeleteSync; + listByResourceGroup is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml b/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml new file mode 100644 index 000000000000..055df028743e --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml @@ -0,0 +1,12 @@ +linter: + extends: + - "@azure-tools/typespec-azure-resource-manager/all" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "resource-manager" + emitter-output-dir: "{project-root}/.." + examples-directory: "examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/verifiedid.json" + use-read-only-status-schema: true diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_CreateOrUpdate.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_CreateOrUpdate.json new file mode 100644 index 000000000000..778cb01894ee --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "operationId": "Authorities_CreateOrUpdate", + "title": "CreateAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111", + "resource": { + "properties": {}, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/aurthorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/aurthorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + } + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Delete.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Delete.json new file mode 100644 index 000000000000..bd8155a9c921 --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Delete.json @@ -0,0 +1,14 @@ +{ + "operationId": "Authorities_Delete", + "title": "DeleteAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Get.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Get.json new file mode 100644 index 000000000000..2d8394e5862f --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Get.json @@ -0,0 +1,22 @@ +{ + "operationId": "Authorities_Get", + "title": "GetAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + } + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListByResourceGroup.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListByResourceGroup.json new file mode 100644 index 000000000000..181c8986ac08 --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "title": "Authorities_ListByResourceGroup", + "operationId": "Authorities_ListByResourceGroup", + "parameters": { + "api-version": "2024-01-26-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "centralus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "systemData": { + "createdBy": "ypsrynjsvwvcooacwzwb", + "createdByType": "User", + "createdAt": "2023-12-28T17:24:15.284Z", + "lastModifiedBy": "qlojlakxwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-12-28T17:24:15.284Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities?api-version=2024-01-26-preview&$skiptoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" + } + } + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListBySubscription.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListBySubscription.json new file mode 100644 index 000000000000..61840f59931f --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListBySubscription.json @@ -0,0 +1,30 @@ +{ + "title": "Authorities_ListBySubscription", + "operationId": "Authorities_ListBySubscription", + "parameters": { + "api-version": "2024-01-26-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "centralus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "systemData": { + "createdBy": "ypsrynjsvwvcooacwzwb", + "createdByType": "User", + "createdAt": "2023-12-28T17:24:15.284Z", + "lastModifiedBy": "qlojlakxwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-12-28T17:24:15.284Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities?api-version=2024-01-26-preview&$skiptoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" + } + } + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Update.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Update.json new file mode 100644 index 000000000000..91403cf95deb --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Update.json @@ -0,0 +1,23 @@ +{ + "operationId": "Authorities_Update", + "title": "UpdateAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/aurthorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + } + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Operations_List.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Operations_List.json new file mode 100644 index 000000000000..09854063c45a --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-01-26-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.VerifiedId/Authorities/read", + "isDataAction": true, + "display": { + "provider": "Microsoft.VerifiedId", + "resource": "Authorities", + "operation": "read", + "description": "Read the Authority resources for the Verified ID service." + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/operations?api-version=2024-01-26-preview" + } + } + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json new file mode 100644 index 000000000000..a97a1e596f5e --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json @@ -0,0 +1,508 @@ +{ + "swagger": "2.0", + "info": { + "title": "VerifiedIdMgmtClient", + "version": "2024-01-26-preview", + "description": "VerifiedId 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": "Authorities" + } + ], + "paths": { + "/providers/Microsoft.VerifiedId/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.VerifiedId/authorities": { + "get": { + "operationId": "Authorities_ListBySubscription", + "tags": [ + "Authorities" + ], + "description": "List Authority 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/AuthorityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Authorities_ListBySubscription": { + "$ref": "./examples/Authorities_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VerifiedId/authorities": { + "get": { + "operationId": "Authorities_ListByResourceGroup", + "tags": [ + "Authorities" + ], + "description": "List Authority 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/AuthorityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Authorities_ListByResourceGroup": { + "$ref": "./examples/Authorities_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VerifiedId/authorities/{authorityName}": { + "get": { + "operationId": "Authorities_Get", + "tags": [ + "Authorities" + ], + "description": "Get a Authority", + "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": "authorityName", + "in": "path", + "description": "The ID of the authority", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Authority" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAuthority": { + "$ref": "./examples/Authorities_Get.json" + } + } + }, + "put": { + "operationId": "Authorities_CreateOrUpdate", + "tags": [ + "Authorities" + ], + "description": "Create a Authority", + "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": "authorityName", + "in": "path", + "description": "The ID of the authority", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Authority" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Authority' update operation succeeded", + "schema": { + "$ref": "#/definitions/Authority" + } + }, + "201": { + "description": "Resource 'Authority' create operation succeeded", + "schema": { + "$ref": "#/definitions/Authority" + }, + "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": { + "CreateAuthority": { + "$ref": "./examples/Authorities_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Authorities_Update", + "tags": [ + "Authorities" + ], + "description": "Update a Authority", + "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": "authorityName", + "in": "path", + "description": "The ID of the authority", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorityUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Authority" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateAuthority": { + "$ref": "./examples/Authorities_Update.json" + } + } + }, + "delete": { + "operationId": "Authorities_Delete", + "tags": [ + "Authorities" + ], + "description": "Delete a Authority", + "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": "authorityName", + "in": "path", + "description": "The ID of the authority", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "DeleteAuthority": { + "$ref": "./examples/Authorities_Delete.json" + } + } + } + } + }, + "definitions": { + "Authority": { + "type": "object", + "description": "A VerifiedId authority resource", + "properties": { + "properties": { + "$ref": "#/definitions/AuthorityProperties", + "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" + } + ] + }, + "AuthorityListResult": { + "type": "object", + "description": "The response of a Authority list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Authority items on this page", + "items": { + "$ref": "#/definitions/Authority" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AuthorityProperties": { + "type": "object", + "description": "Details of the VerifiedId Authority.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AuthorityUpdate": { + "type": "object", + "description": "The type used for update operations of the Authority.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "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": "Initial provisioning in progress" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Update in progress" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion in progress" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Change accepted for processing" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/verifiedid/resource-manager/readme.az.md b/specification/verifiedid/resource-manager/readme.az.md new file mode 100644 index 000000000000..57b0d9bc4e2d --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.az.md @@ -0,0 +1,28 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +For new Resource Provider. It is highly recommended to onboard Azure CLI extensions. There's no differences in terms of customer usage. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: verifiedid + namespace: azure.mgmt.verifiedid + package-name: azure-mgmt-verifiedid +az-output-folder: $(azure-cli-extension-folder)/src/verifiedid +python-sdk-output-folder: "$(az-output-folder)/azext_verifiedid/vendored_sdks/verifiedid" +# add additional configuration here specific for Azure CLI +# 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: + extensions: verifiedid + namespace: azure.mgmt.verifiedid + package-name: azure-mgmt-verifiedid +az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/verifiedid +python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/verifiedid" +``` \ No newline at end of file diff --git a/specification/verifiedid/resource-manager/readme.cli.md b/specification/verifiedid/resource-manager/readme.cli.md new file mode 100644 index 000000000000..c6cf6ad37ea4 --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.cli.md @@ -0,0 +1 @@ +## CLI Common Settings for all the command line tools \ No newline at end of file diff --git a/specification/verifiedid/resource-manager/readme.csharp.md b/specification/verifiedid/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..d69bdba6773b --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.VerifiedId + output-folder: $(csharp-sdks-folder)/verifiedid/management/Microsoft.VerifiedId/GeneratedProtocol +``` diff --git a/specification/verifiedid/resource-manager/readme.go.md b/specification/verifiedid/resource-manager/readme.go.md new file mode 100644 index 000000000000..aab65128a6cb --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/verifiedid/armverifiedid +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +``` diff --git a/specification/verifiedid/resource-manager/readme.md b/specification/verifiedid/resource-manager/readme.md new file mode 100644 index 000000000000..1070721e810e --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.md @@ -0,0 +1,79 @@ +# verifiedid + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for verifiedid. + +## 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 verifiedid. + +```yaml +openapi-type: arm +openapi-subtype: rpaas +tag: package-2024-01-26-preview +``` + +### Tag: package-2024-01-26-preview + +These settings apply only when `--tag=package-2024-01-26-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-01-26-preview' +input-file: + - Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-resource-manager-schemas + - repo: azure-cli-extensions + - repo: azure-powershell +``` +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/verifiedid/resource-manager/readme.python.md b/specification/verifiedid/resource-manager/readme.python.md new file mode 100644 index 000000000000..b3819bde88e2 --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-verifiedid +namespace: azure.mgmt.verifiedid +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/verifiedid/azure-mgmt-verifiedid/azure/mgmt/verifiedid +``` + +``` yaml $(python) +modelerfour: + flatten-models: false +``` diff --git a/specification/verifiedid/resource-manager/readme.typescript.md b/specification/verifiedid/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..ad0cb1832ee1 --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-verifiedid" + output-folder: "$(typescript-sdks-folder)/sdk/verifiedid/arm-verifiedid" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +``` From 061b617969b6e2e2b598461c3131c5befcc6d6df Mon Sep 17 00:00:00 2001 From: Akshit Goyal Date: Fri, 31 May 2024 07:20:59 -0700 Subject: [PATCH 12/49] Add NSP API to multiple services under Microsoft.Insights RP (#28680) * Add API and examples for NSP in ScheduledQueryRules * Add API and examples for NSP in DataCollectionEndpoints * Minor fixes for the api specs for ScheduledQueryRules and DCE * Add NSP API for Action Groups * Add new API to README.md * Fix examples to include right param names * Fix styling errors * Include old version in default package tag * Fix Swagger LintDiff validation issues * Resolve resource name pattern restriction for configName in NSP * Fix typo in param name * Fix LintDiff warnings and errors * Update spec title * Update README with the correct package ver * Rever back to original NSP swagger model * Update README * Replace 200 with 202 for reconcile * Update reconcile examples with 202 response * Fix 202 response headers for reconcile * Update error object ref for LintDiff validation * Fix LintDiff Warnings: Update swagger to use v5 types * Fix LintDiff warnings * Fix LintDiff warnings * Fix Prettier check * Resolve comments and update Data models * Resolve merge conflicts for README * Fix README * Create sdk-suppressions.yaml * Refactor NSP definitions into a common file * Resolve merge conflicts * Refactor code to use NSP Common types * update API paths with nsp param name * Fix param declaration in paths and add parameter definition * Change str to int accross all API examples for accessRule ver property --------- Co-authored-by: Akshit Goyal Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> --- ...onGroups_NetworkSecurityPerimeter_API.json | 205 +++ ...ndpoints_NetworkSecurityPerimeter_API.json | 215 +++ .../examples/NSPForActionGroups_Get.json | 45 + .../examples/NSPForActionGroups_List.json | 48 + .../NSPForActionGroups_Reconcile.json | 16 + .../NSPForDataCollectionEndpoints_Get.json | 45 + .../NSPForDataCollectionEndpoints_List.json | 48 + ...PForDataCollectionEndpoints_Reconcile.json | 16 + .../NSPForScheduledQueryRule_Get.json | 45 + .../NSPForScheduledQueryRule_List.json | 48 + .../NSPForScheduledQueryRule_Reconcile.json | 16 + ...ueryRule_NetworkSecurityPerimeter_API.json | 203 +++ .../monitor/resource-manager/readme.md | 1412 +++++++++-------- .../resource-manager/sdk-suppressions.yaml | 52 + 14 files changed, 1726 insertions(+), 688 deletions(-) create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/actionGroups_NetworkSecurityPerimeter_API.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/dataCollectionEndpoints_NetworkSecurityPerimeter_API.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForActionGroups_Get.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForActionGroups_List.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForActionGroups_Reconcile.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForDataCollectionEndpoints_Get.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForDataCollectionEndpoints_List.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForDataCollectionEndpoints_Reconcile.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForScheduledQueryRule_Get.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForScheduledQueryRule_List.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForScheduledQueryRule_Reconcile.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/scheduledQueryRule_NetworkSecurityPerimeter_API.json create mode 100644 specification/monitor/resource-manager/sdk-suppressions.yaml diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/actionGroups_NetworkSecurityPerimeter_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/actionGroups_NetworkSecurityPerimeter_API.json new file mode 100644 index 000000000000..6fcd3b04874f --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/actionGroups_NetworkSecurityPerimeter_API.json @@ -0,0 +1,205 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Action Groups Network Security Perimeter APIs", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "version": "2021-10-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.Insights/actionGroups/{actionGroupName}/networkSecurityPerimeterConfigurations": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "description": "Gets a list of NSP configurations for specified action group.", + "operationId": "ActionGroups_ListNSP", + "x-ms-examples": { + "Get an action group": { + "$ref": "./examples/NSPForActionGroups_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of configs.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfigurationListResult" + } + }, + "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.Insights/actionGroups/{actionGroupName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "description": "Gets a specified NSP configuration for specified action group.", + "operationId": "ActionGroups_GetNSP", + "x-ms-examples": { + "Get NSP config by name for an action group": { + "$ref": "./examples/NSPForActionGroups_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterConfigurationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the NSP config.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "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.Insights/actionGroups/{actionGroupName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile": { + "post": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "description": "Reconciles a specified NSP configuration for specified action group.", + "operationId": "ActionGroups_ReconcileNSP", + "x-ms-examples": { + "Reconcile NSP config by name for an action group": { + "$ref": "./examples/NSPForActionGroups_Reconcile.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterConfigurationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Request to reconcile the association accepted.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "BadRequest", + "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": {}, + "parameters": { + "ActionGroupNameParameter": { + "name": "actionGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the action group.", + "x-ms-parameter-location": "method", + "pattern": "^.*$", + "maxLength": 43 + }, + "NetworkSecurityPerimeterConfigurationNameParameter": { + "name": "networkSecurityPerimeterConfigurationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^.*$", + "minLength": 1, + "maxLength": 512, + "x-ms-parameter-location": "method", + "description": "The name for a network security perimeter configuration" + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/dataCollectionEndpoints_NetworkSecurityPerimeter_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/dataCollectionEndpoints_NetworkSecurityPerimeter_API.json new file mode 100644 index 000000000000..d340651c7a16 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/dataCollectionEndpoints_NetworkSecurityPerimeter_API.json @@ -0,0 +1,215 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Monitor Data Collection Endpoints Network Security Perimeter APIs", + "description": "Provides NSP operations for working with Azure Monitor data collection endpoints", + "version": "2021-10-01", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}/networkSecurityPerimeterConfigurations": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "summary": "Gets a list of NSP configurations for the specified data collection endpoint.", + "operationId": "DataCollectionEndpoints_ListNSP", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DataCollectionEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of configs.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List NSP configs by data collection endpoint": { + "$ref": "./examples/NSPForDataCollectionEndpoints_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "summary": "Gets the specified NSP configuration for the specified data collection endpoint.", + "operationId": "DataCollectionEndpoints_GetNSP", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DataCollectionEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the config.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get NSP configs by name for data collection endpoint": { + "$ref": "./examples/NSPForDataCollectionEndpoints_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile": { + "post": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "summary": "Reconciles the specified NSP configuration for the specified data collection endpoint.", + "operationId": "DataCollectionEndpoints_ReconcileNSP", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DataCollectionEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterConfigurationNameParameter" + } + ], + "responses": { + "202": { + "description": "Request to reconcile the association 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" + }, + "x-ms-examples": { + "Reconcile NSP config for data collection endpoint": { + "$ref": "./examples/NSPForDataCollectionEndpoints_Reconcile.json" + } + } + } + } + }, + "definitions": {}, + "parameters": { + "DataCollectionEndpointNameParameter": { + "in": "path", + "name": "dataCollectionEndpointName", + "description": "The name of the data collection endpoint. The name is case insensitive.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^.*$", + "maxLength": 43 + }, + "NetworkSecurityPerimeterConfigurationNameParameter": { + "name": "networkSecurityPerimeterConfigurationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^.*$", + "minLength": 1, + "maxLength": 512, + "x-ms-parameter-location": "method", + "description": "The name for a network security perimeter configuration" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForActionGroups_Get.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForActionGroups_Get.json new file mode 100644 index 000000000000..e650d12b3594 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForActionGroups_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "exampleRG", + "actionGroupName": "someActionGroup", + "networkSecurityPerimeterConfigurationName": "somePerimeterConfiguration", + "api-version": "2021-10-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/exampleRG/providers/Microsoft.Insights/actionGroups/someActionGroup/networkSecurityPerimeterConfigurations/somePerimeterConfiguration", + "name": "somePerimeterConfiguration", + "type": "Microsoft.Insights/actionGroups/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Accepted", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1", + "location": "japaneast" + }, + "resourceAssociation": { + "name": "assoc1", + "accessMode": "Enforced" + }, + "profile": { + "name": "profile1", + "accessRulesVersion": 0, + "accessRules": [ + { + "name": "rule1", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForActionGroups_List.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForActionGroups_List.json new file mode 100644 index 000000000000..9d5c917a6fd6 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForActionGroups_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "exampleRG", + "actionGroupName": "someActionGroup", + "api-version": "2021-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/exampleRG/providers/Microsoft.Insights/actionGroups/someActionGroup/networkSecurityPerimeterConfigurations/somePerimeterConfiguration", + "name": "somePerimeterConfiguration", + "type": "Microsoft.Insights/actionGroups/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Accepted", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1", + "location": "japaneast" + }, + "resourceAssociation": { + "name": "assoc1", + "accessMode": "Enforced" + }, + "profile": { + "name": "profile1", + "accessRulesVersion": 0, + "accessRules": [ + { + "name": "rule1", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForActionGroups_Reconcile.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForActionGroups_Reconcile.json new file mode 100644 index 000000000000..dbb18371e35c --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForActionGroups_Reconcile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "exampleRG", + "actionGroupName": "someActionGroup", + "networkSecurityPerimeterConfigurationName": "somePerimeterConfiguration", + "api-version": "2021-10-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://endpoint:port/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Insights/locations/{location}/asyncoperations&api-version=2021-10-01" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForDataCollectionEndpoints_Get.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForDataCollectionEndpoints_Get.json new file mode 100644 index 000000000000..8b8db6f4a916 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForDataCollectionEndpoints_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "exampleRG", + "dataCollectionEndpointName": "someDataCollectionEndpoint", + "networkSecurityPerimeterConfigurationName": "somePerimeterConfiguration", + "api-version": "2021-10-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/exampleRG/providers/Microsoft.Insights/dataCollectionEndpoints/someDataCollectionEndpoint/networkSecurityPerimeterConfigurations/somePerimeterConfiguration", + "name": "somePerimeterConfiguration", + "type": "Microsoft.Insights/dataCollectionEndpoints/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Accepted", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1", + "location": "japaneast" + }, + "resourceAssociation": { + "name": "assoc1", + "accessMode": "Enforced" + }, + "profile": { + "name": "profile1", + "accessRulesVersion": 0, + "accessRules": [ + { + "name": "rule1", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForDataCollectionEndpoints_List.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForDataCollectionEndpoints_List.json new file mode 100644 index 000000000000..ec327fff41dc --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForDataCollectionEndpoints_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "exampleRG", + "dataCollectionEndpointName": "someDataCollectionEndpoint", + "api-version": "2021-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/exampleRG/providers/Microsoft.Insights/dataCollectionEndpoints/someDataCollectionEndpoint/networkSecurityPerimeterConfigurations/somePerimeterConfiguration", + "name": "somePerimeterConfiguration", + "type": "Microsoft.Insights/dataCollectionEndpoints/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Accepted", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1", + "location": "japaneast" + }, + "resourceAssociation": { + "name": "assoc1", + "accessMode": "Enforced" + }, + "profile": { + "name": "profile1", + "accessRulesVersion": 0, + "accessRules": [ + { + "name": "rule1", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForDataCollectionEndpoints_Reconcile.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForDataCollectionEndpoints_Reconcile.json new file mode 100644 index 000000000000..371292bf16e5 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForDataCollectionEndpoints_Reconcile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "exampleRG", + "dataCollectionEndpointName": "someDataCollectionEndpoint", + "networkSecurityPerimeterConfigurationName": "somePerimeterConfiguration", + "api-version": "2021-10-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://endpoint:port/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Insights/locations/{location}/asyncoperations&api-version=2021-10-01" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForScheduledQueryRule_Get.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForScheduledQueryRule_Get.json new file mode 100644 index 000000000000..16b46e3ce975 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForScheduledQueryRule_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "exampleRG", + "ruleName": "someRule", + "networkSecurityPerimeterConfigurationName": "somePerimeterConfiguration", + "api-version": "2021-10-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/exampleRG/providers/Microsoft.Insights/scheduledQueryRules/someRule/networkSecurityPerimeterConfigurations/somePerimeterConfiguration", + "name": "somePerimeterConfiguration", + "type": "Microsoft.Insights/scheduledQueryRules/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Accepted", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1", + "location": "japaneast" + }, + "resourceAssociation": { + "name": "assoc1", + "accessMode": "Enforced" + }, + "profile": { + "name": "profile1", + "accessRulesVersion": 0, + "accessRules": [ + { + "name": "rule1", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForScheduledQueryRule_List.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForScheduledQueryRule_List.json new file mode 100644 index 000000000000..ff1f66f71eff --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForScheduledQueryRule_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "exampleRG", + "ruleName": "someRule", + "api-version": "2021-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/exampleRG/providers/Microsoft.Insights/scheduledQueryRules/someRule/networkSecurityPerimeterConfigurations/somePerimeterConfiguration", + "name": "somePerimeterConfiguration", + "type": "Microsoft.Insights/scheduledQueryRules/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Accepted", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1", + "location": "japaneast" + }, + "resourceAssociation": { + "name": "assoc1", + "accessMode": "Enforced" + }, + "profile": { + "name": "profile1", + "accessRulesVersion": 0, + "accessRules": [ + { + "name": "rule1", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForScheduledQueryRule_Reconcile.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForScheduledQueryRule_Reconcile.json new file mode 100644 index 000000000000..0de5ccc7d947 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/examples/NSPForScheduledQueryRule_Reconcile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "exampleRG", + "ruleName": "someRule", + "networkSecurityPerimeterConfigurationName": "somePerimeterConfiguration", + "api-version": "2021-10-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://endpoint:port/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Insights/locations/{location}/asyncoperations&api-version=2021-10-01" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/scheduledQueryRule_NetworkSecurityPerimeter_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/scheduledQueryRule_NetworkSecurityPerimeter_API.json new file mode 100644 index 000000000000..f873f5f8c2ec --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-10-01/scheduledQueryRule_NetworkSecurityPerimeter_API.json @@ -0,0 +1,203 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-10-01", + "title": "Scheduled Query Rules API", + "description": "Provides NSP operations for working with Scheduled Query Rules." + }, + "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.Insights/scheduledQueryRules/{ruleName}/networkSecurityPerimeterConfigurations": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "description": "Gets a list of NSP configurations for specified scheduled query rule.", + "operationId": "ScheduledQueryRule_ListNSP", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of configs.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfigurationListResult" + } + }, + "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": { + "List NSP configs by Scheduled Query Rule": { + "$ref": "./examples/NSPForScheduledQueryRule_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "description": "Gets a network security perimeter configuration.", + "operationId": "ScheduledQueryRule_GetNSP", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the config.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get NSP config by name for Scheduled Query Rule": { + "$ref": "./examples/NSPForScheduledQueryRule_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile": { + "post": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "description": "Reconcile network security perimeter configuration for ScheduledQueryRule resource.", + "operationId": "ScheduledQueryRule_ReconcileNSP", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterConfigurationNameParameter" + } + ], + "responses": { + "202": { + "description": "Request to reconcile the association 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" + }, + "x-ms-examples": { + "Reconcile NSP config for Scheduled Query Rule": { + "$ref": "./examples/NSPForScheduledQueryRule_Reconcile.json" + } + } + } + } + }, + "definitions": {}, + "parameters": { + "RuleNameParameter": { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule.", + "x-ms-parameter-location": "method", + "pattern": "^.*$", + "maxLength": 43 + }, + "NetworkSecurityPerimeterConfigurationNameParameter": { + "name": "networkSecurityPerimeterConfigurationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^.*$", + "minLength": 1, + "maxLength": 512, + "x-ms-parameter-location": "method", + "description": "The name for a network security perimeter configuration" + } + } +} diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index 47d35d1b95b2..8b1dff6ec11e 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -24,18 +24,54 @@ To see additional help and options, run: These are the global settings for the MonitorClient API. -``` yaml !$(python) || !$(track2) +```yaml !$(python) || !$(track2) title: MonitorClient ``` -``` yaml +```yaml description: Monitor Management Client openapi-type: arm openapi-subtype: rpaas -tag: package-preview-2023-09 +tag: package-2024-04 directive: - suppress: Example Validations - reason: 'There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off.' + reason: "There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off." +``` +### Tag: package-2024-04 + +These settings apply only when `--tag=package-2024-04` is specified on the command line. + +```yaml $(tag) == 'package-2024-04' +input-file: + - Microsoft.Insights/stable/2021-10-01/actionGroups_NetworkSecurityPerimeter_API.json + - Microsoft.Insights/stable/2021-10-01/dataCollectionEndpoints_NetworkSecurityPerimeter_API.json + - Microsoft.Insights/stable/2021-10-01/scheduledQueryRule_NetworkSecurityPerimeter_API.json + - Microsoft.Insights/preview/2023-09-01-preview/actionGroups_API.json + - Microsoft.Insights/stable/2024-02-01/metricNamespaces_API.json + - Microsoft.Insights/stable/2024-02-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2024-02-01/metrics_API.json + - Microsoft.Monitor/stable/2023-04-03/monitoringAccounts_API.json + - Microsoft.Monitor/stable/2023-04-03/operations_API.json + - Microsoft.Insights/stable/2022-10-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2023-03-11/dataCollectionEndpoints_API.json + - Microsoft.Insights/stable/2023-03-11/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/stable/2023-03-11/dataCollectionRules_API.json ``` ### Tag: package-preview-2023-09 @@ -153,7 +189,7 @@ input-file: These settings apply only when `--tag=package-2023-10` is specified on the command line. -``` yaml $(tag) == 'package-2023-10' +```yaml $(tag) == 'package-2023-10' input-file: - Microsoft.Monitor/stable/2023-04-03/monitoringAccounts_API.json - Microsoft.Monitor/stable/2023-04-03/operations_API.json @@ -187,16 +223,16 @@ input-file: These settings apply only when `--tag=package-2023-05-01-preview-only` is specified on the command line -``` yaml $(tag) == 'package-2023-05-01-preview-only' +```yaml $(tag) == 'package-2023-05-01-preview-only' input-file: -- Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json + - Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json ``` ### Tag: package-2023-04 These settings apply only when `--tag=package-2023-04` is specified on the command line. -``` yaml $(tag) == 'package-2023-04' +```yaml $(tag) == 'package-2023-04' input-file: - Microsoft.Monitor/stable/2023-04-03/monitoringAccounts_API.json - Microsoft.Monitor/stable/2023-04-03/operations_API.json @@ -230,61 +266,61 @@ input-file: These settings apply only when `--tag=package-preview-2023-04` is specified on the command line. -``` yaml $(tag) == 'package-preview-2023-04' -input-file: -- Microsoft.Insights/stable/2022-10-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2023-01-01/actionGroups_API.json -- Microsoft.Insights/preview/2023-03-01-preview/tenantActionGroups_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2021-05-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/preview/2023-03-15-preview/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -- Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json -- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json -- Microsoft.Insights/stable/2022-06-01/dataCollectionRuleAssociations_API.json -- Microsoft.Insights/stable/2022-06-01/dataCollectionRules_API.json -- Microsoft.Monitor/preview/2021-06-03-preview/monitoringAccounts_API.json -- Microsoft.Monitor/preview/2021-06-03-preview/operations_API.json +```yaml $(tag) == 'package-preview-2023-04' +input-file: + - Microsoft.Insights/stable/2022-10-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2023-01-01/actionGroups_API.json + - Microsoft.Insights/preview/2023-03-01-preview/tenantActionGroups_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2021-05-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/preview/2023-03-15-preview/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json + - Microsoft.Insights/stable/2022-06-01/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/stable/2022-06-01/dataCollectionRules_API.json + - Microsoft.Monitor/preview/2021-06-03-preview/monitoringAccounts_API.json + - Microsoft.Monitor/preview/2021-06-03-preview/operations_API.json ``` ### Tag: package-datacollection-2022-06-01-only These settings apply only when `--tag=package-datacollection-2022-06-01-only` is specified on the command line -``` yaml $(tag) == 'package-datacollection-2022-06-01-only' +```yaml $(tag) == 'package-datacollection-2022-06-01-only' input-file: -- Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json -- Microsoft.Insights/stable/2022-06-01/dataCollectionRuleAssociations_API.json -- Microsoft.Insights/stable/2022-06-01/dataCollectionRules_API.json + - Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json + - Microsoft.Insights/stable/2022-06-01/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/stable/2022-06-01/dataCollectionRules_API.json ``` ### Tag: package-2023-03-01-preview-only These settings apply only when `--tag=package-2023-03-01-preview-only` is specified on the command line -``` yaml $(tag) == 'package-2023-03-01-preview-only' +```yaml $(tag) == 'package-2023-03-01-preview-only' input-file: -- Microsoft.Insights/preview/2023-03-01-preview/tenantActionGroups_API.json + - Microsoft.Insights/preview/2023-03-01-preview/tenantActionGroups_API.json ``` ### Tag: package-2023-01-only These settings apply only when `--tag=package-2023-01-only` is specified on the command line -``` yaml $(tag) == 'package-2023-01-only' +```yaml $(tag) == 'package-2023-01-only' input-file: - Microsoft.Insights/stable/2023-01-01/actionGroups_API.json ``` @@ -293,7 +329,7 @@ input-file: These settings apply only when `--tag=package-preview-2023-01` is specified on the command line. -``` yaml $(tag) == 'package-preview-2023-01' +```yaml $(tag) == 'package-preview-2023-01' input-file: - Microsoft.Insights/preview/2023-01-01-preview/activityLogAlerts_API.json ``` @@ -302,376 +338,376 @@ input-file: These settings apply only when `--tag=package-2022-08-01-preview-only` is specified on the command line -``` yaml $(tag) == 'package-2022-08-01-preview-only' +```yaml $(tag) == 'package-2022-08-01-preview-only' input-file: -- Microsoft.Insights/preview/2022-08-01-preview/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2022-08-01-preview/scheduledQueryRule_API.json ``` ### Tag: package-preview-2023-03 These settings apply only when `--tag=package-preview-2023-03` is specified on the command line. -``` yaml $(tag) == 'package-preview-2023-03' -input-file: -- Microsoft.Insights/stable/2022-10-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2023-01-01/actionGroups_API.json -- Microsoft.Insights/preview/2023-03-01-preview/tenantActionGroups_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2021-05-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/preview/2023-03-15-preview/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -- Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json -- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json -- Microsoft.Monitor/preview/2021-06-03-preview/monitoringAccounts_API.json -- Microsoft.Monitor/preview/2021-06-03-preview/operations_API.json +```yaml $(tag) == 'package-preview-2023-03' +input-file: + - Microsoft.Insights/stable/2022-10-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2023-01-01/actionGroups_API.json + - Microsoft.Insights/preview/2023-03-01-preview/tenantActionGroups_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2021-05-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/preview/2023-03-15-preview/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json + - Microsoft.Monitor/preview/2021-06-03-preview/monitoringAccounts_API.json + - Microsoft.Monitor/preview/2021-06-03-preview/operations_API.json ``` ### Tag: package-preview-2022-08 These settings apply only when `--tag=package-preview-2022-08` is specified on the command line. -``` yaml $(tag) == 'package-preview-2022-08' -input-file: -- Microsoft.Insights/stable/2022-10-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2023-01-01/actionGroups_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2021-05-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/preview/2022-08-01-preview/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -- Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json -- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json -- Microsoft.Monitor/preview/2021-06-03-preview/monitoringAccounts_API.json -- Microsoft.Monitor/preview/2021-06-03-preview/operations_API.json +```yaml $(tag) == 'package-preview-2022-08' +input-file: + - Microsoft.Insights/stable/2022-10-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2023-01-01/actionGroups_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2021-05-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/preview/2022-08-01-preview/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json + - Microsoft.Monitor/preview/2021-06-03-preview/monitoringAccounts_API.json + - Microsoft.Monitor/preview/2021-06-03-preview/operations_API.json ``` ### Tag: package-composite-v1 These settings apply only when `--tag=package-composite-v1` is specified on the command line. -``` yaml $(tag) == 'package-composite-v1' -input-file: -- Microsoft.Insights/stable/2022-10-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2023-01-01/actionGroups_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2021-05-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -- Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json -- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json -- Microsoft.Monitor/preview/2021-06-03-preview/monitoringAccounts_API.json -- Microsoft.Monitor/preview/2021-06-03-preview/operations_API.json +```yaml $(tag) == 'package-composite-v1' +input-file: + - Microsoft.Insights/stable/2022-10-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2023-01-01/actionGroups_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2021-05-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json + - Microsoft.Monitor/preview/2021-06-03-preview/monitoringAccounts_API.json + - Microsoft.Monitor/preview/2021-06-03-preview/operations_API.json ``` ### Tag: package-2023-01 These settings apply only when `--tag=package-2023-01` is specified on the command line -``` yaml $(tag) == 'package-2023-01' -input-file: -- Microsoft.Insights/stable/2022-10-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2023-01-01/actionGroups_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -- Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json -- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json +```yaml $(tag) == 'package-2023-01' +input-file: + - Microsoft.Insights/stable/2022-10-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2023-01-01/actionGroups_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json ``` ### Tag: package-2022-10 These settings apply only when `--tag=package-2022-10` is specified on the command line -``` yaml $(tag) == 'package-2022-10' -input-file: -- Microsoft.Insights/stable/2022-10-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2022-06-01/actionGroups_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -- Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json -- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json +```yaml $(tag) == 'package-2022-10' +input-file: + - Microsoft.Insights/stable/2022-10-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2022-06-01/actionGroups_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json ``` ### Tag: package-2022-10-01-only These settings apply only when `--tag=package-2022-10-01-only` is specified on the command line -``` yaml $(tag) == 'package-2022-10-01-only' +```yaml $(tag) == 'package-2022-10-01-only' input-file: -- Microsoft.Insights/stable/2022-10-01/autoscale_API.json + - Microsoft.Insights/stable/2022-10-01/autoscale_API.json ``` ### Tag: package-2022-06 These settings apply only when `--tag=package-2022-06` is specified on the command line -``` yaml $(tag) == 'package-2022-06' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2022-06-01/actionGroups_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -- Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json -- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json -- Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json +```yaml $(tag) == 'package-2022-06' +input-file: + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2022-06-01/actionGroups_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json ``` ### Tag: package-2022-06-01-only These settings apply only when `--tag=package-2022-06-01-only` is specified on the command line -``` yaml $(tag) == 'package-2022-06-01-only' +```yaml $(tag) == 'package-2022-06-01-only' input-file: -- Microsoft.Insights/stable/2022-06-01/actionGroups_API.json -- Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json -- Microsoft.Insights/stable/2022-06-01/dataCollectionRuleAssociations_API.json -- Microsoft.Insights/stable/2022-06-01/dataCollectionRules_API.json + - Microsoft.Insights/stable/2022-06-01/actionGroups_API.json + - Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json + - Microsoft.Insights/stable/2022-06-01/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/stable/2022-06-01/dataCollectionRules_API.json ``` ### Tag: package-2022-04-01-only These settings apply only when `--tag=package-2022-04-01-only` is specified on the command line -``` yaml $(tag) == 'package-2022-04-01-only' +```yaml $(tag) == 'package-2022-04-01-only' input-file: -- Microsoft.Insights/stable/2022-04-01/actionGroups_API.json + - Microsoft.Insights/stable/2022-04-01/actionGroups_API.json ``` ### Tag: package-2021-06-03-preview-only These settings apply only when `--tag=package-2021-06-03-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2021-06-03-preview-only' +```yaml $(tag) == 'package-2021-06-03-preview-only' input-file: -- Microsoft.Monitor/preview/2021-06-03-preview/monitoringAccounts_API.json -- Microsoft.Monitor/preview/2021-06-03-preview/operations_API.json + - Microsoft.Monitor/preview/2021-06-03-preview/monitoringAccounts_API.json + - Microsoft.Monitor/preview/2021-06-03-preview/operations_API.json ``` ### Tag: package-2016-03-preview-monitorlegacy These settings apply only when `--tag=package-2016-03-preview-monitorlegacy` is specified on the command line -``` yaml $(tag) == 'package-2016-03-preview-monitorlegacy' +```yaml $(tag) == 'package-2016-03-preview-monitorlegacy' input-file: -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json ``` ### Tag: package-2021-05-preview-diagnostics These settings apply only when `--tag=package-2021-05-preview-diagnostics` is specified on the command line -``` yaml $(tag) == 'package-2021-05-preview-diagnostics' +```yaml $(tag) == 'package-2021-05-preview-diagnostics' input-file: -- Microsoft.Insights/preview/2021-05-01-preview/autoscale_API.json -- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json -- Microsoft.Insights/preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json -- Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json -- Microsoft.Insights/stable/2021-09-01/actionGroups_API.json + - Microsoft.Insights/preview/2021-05-01-preview/autoscale_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json + - Microsoft.Insights/preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json + - Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2021-09-01/actionGroups_API.json ``` ### Tag: package-2020-10-activityLogs These settings apply only when `--tag=package-2020-10-activityLogs` is specified on the command line -``` yaml $(tag) == 'package-2020-10-activityLogs' +```yaml $(tag) == 'package-2020-10-activityLogs' input-file: -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json directive: -- from: activityLogAlerts_API.json - where: $.definitions - transform: delete $["ErrorResponse"] - reason: Description doesn't match, the definition will be "inherit" from activityLogs_API.json + - from: activityLogAlerts_API.json + where: $.definitions + transform: delete $["ErrorResponse"] + reason: Description doesn't match, the definition will be "inherit" from activityLogs_API.json ``` ### Tag: package-2021-05-metrics These settings apply only when `--tag=package-2021-05-metrics` is specified on the command line -``` yaml $(tag) == 'package-2021-05-metrics' +```yaml $(tag) == 'package-2021-05-metrics' input-file: -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2021-05-01/metrics_API.json -- Microsoft.Insights/stable/2021-05-01/operations_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2021-05-01/metrics_API.json + - Microsoft.Insights/stable/2021-05-01/operations_API.json directive: -- from: metricBaselines_API.json - where: $.parameters - transform: delete $["MetricNamespaceParameter"] - reason: Description doesn't match, the definition will be "inherit" from metrics_API.json -- from: metricBaselines_API.json - where: $.parameters - transform: delete $["MetricNamesParameter"] - reason: Description doesn't match, the definition will be "inherit" from metrics_API.json + - from: metricBaselines_API.json + where: $.parameters + transform: delete $["MetricNamespaceParameter"] + reason: Description doesn't match, the definition will be "inherit" from metrics_API.json + - from: metricBaselines_API.json + where: $.parameters + transform: delete $["MetricNamesParameter"] + reason: Description doesn't match, the definition will be "inherit" from metrics_API.json ``` ### Tag: package-2021-08-scheduledqueryrules These settings apply only when `--tag=package-2021-08-scheduledqueryrules` is specified on the command line -``` yaml $(tag) == 'package-2021-08-scheduledqueryrules' +```yaml $(tag) == 'package-2021-08-scheduledqueryrules' input-file: -- Microsoft.Insights/stable/2021-08-01/scheduledQueryRule_API.json + - Microsoft.Insights/stable/2021-08-01/scheduledQueryRule_API.json ``` ### Tag: package-2022-02-01-preview-only These settings apply only when `--tag=package-2022-02-01-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2022-02-01-preview-only' +```yaml $(tag) == 'package-2022-02-01-preview-only' input-file: - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRuleAssociations_API.json - - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json + - Microsoft.Insights/preview/2021-09-01-preview/dataCollectionRules_API.json ``` ### Tag: package-2021-09 These settings apply only when `--tag=package-2021-09` is specified on the command line -``` yaml $(tag) == 'package-2021-09' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2021-09-01/actionGroups_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -- Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json -- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json -- Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json -- Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json +```yaml $(tag) == 'package-2021-09' +input-file: + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2021-09-01/actionGroups_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json + - Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json ``` ### Tag: package-2021-09-01-only These settings apply only when `--tag=package-2021-09-01-only` is specified on the command line. -``` yaml $(tag) == 'package-2021-09-01-only' +```yaml $(tag) == 'package-2021-09-01-only' input-file: -- Microsoft.Insights/stable/2021-09-01/actionGroups_API.json + - Microsoft.Insights/stable/2021-09-01/actionGroups_API.json ``` ### Tag: package-2021-08 These settings apply only when `--tag=package-2021-08` is specified on the command line. -``` yaml $(tag) == 'package-2021-08' +```yaml $(tag) == 'package-2021-08' input-file: - Microsoft.Insights/stable/2021-08-01/scheduledQueryRule_API.json ``` @@ -680,78 +716,78 @@ input-file: These settings apply only when `--tag=package-2021-07` is specified on the command line -``` yaml $(tag) == 'package-2021-07' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2019-06-01/actionGroups_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -- Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json -- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json -- Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json -- Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json +```yaml $(tag) == 'package-2021-07' +input-file: + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2019-06-01/actionGroups_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json + - Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json ``` ### Tag: package-2021-07-01-preview-only These settings apply only when `--tag=package-2021-07-01-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2021-07-01-preview-only' +```yaml $(tag) == 'package-2021-07-01-preview-only' input-file: -- Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json + - Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json ``` ### Tag: package-2021-04 These settings apply only when `--tag=package-2021-04` is specified on the command line. -``` yaml $(tag) == 'package-2021-04' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2019-06-01/actionGroups_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -- Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json -- Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json -- Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json +```yaml $(tag) == 'package-2021-04' +input-file: + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2019-06-01/actionGroups_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json + - Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json ``` ### Tag: package-2021-05-only These settings apply only when `--tag=package-2021-05-only` is specified on the command line. -``` yaml $(tag) == 'package-2021-05-only' +```yaml $(tag) == 'package-2021-05-only' input-file: - Microsoft.Insights/stable/2021-05-01/metrics_API.json - Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json @@ -762,18 +798,18 @@ input-file: These settings apply only when `--tag=package-2021-05-01-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2021-05-01-preview-only' +```yaml $(tag) == 'package-2021-05-01-preview-only' input-file: -- Microsoft.Insights/preview/2021-05-01-preview/autoscale_API.json -- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json -- Microsoft.Insights/preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json + - Microsoft.Insights/preview/2021-05-01-preview/autoscale_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json + - Microsoft.Insights/preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json ``` ### Tag: package-2021-04-only -``` yaml $(tag) == 'package-2021-04-only' +```yaml $(tag) == 'package-2021-04-only' input-file: - Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json - Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json @@ -784,109 +820,109 @@ input-file: These settings apply only when `--tag=package-2021-02-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2021-02-preview-only' +```yaml $(tag) == 'package-2021-02-preview-only' input-file: -- Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json ``` ### Tag: package-2020-10-only These settings apply only when `--tag=package-2020-10-only` is specified on the command line. -``` yaml $(tag) == 'package-2020-10-only' +```yaml $(tag) == 'package-2020-10-only' input-file: -- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json ``` ### Tag: package-2020-05-preview-only These settings apply only when `--tag=package-2020-05-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2020-05-preview-only' +```yaml $(tag) == 'package-2020-05-preview-only' input-file: -- Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json ``` ### Tag: package-2020-01-01-preview-only These settings apply only when `--tag=package-2020-01-01-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2020-01-01-preview-only' +```yaml $(tag) == 'package-2020-01-01-preview-only' input-file: -- Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json + - Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json ``` ### Tag: package-2020-03 These settings apply only when `--tag=package-2020-03` is specified on the command line. -``` yaml $(tag) == 'package-2020-03' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2019-06-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -- Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json +```yaml $(tag) == 'package-2020-03' +input-file: + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2019-06-01/actionGroups_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json ``` ### Tag: package-2019-11 These settings apply only when `--tag=package-2019-11` is specified on the command line. -``` yaml $(tag) == 'package-2019-11' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/subscriptionDiagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2019-06-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -- Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json +```yaml $(tag) == 'package-2019-11' +input-file: + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/subscriptionDiagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2019-06-01/actionGroups_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json ``` ### Tag: package-2019-10-17-preview-only These settings apply only when `--tag=package-2019-10-17-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2019-10-17-preview-only' +```yaml $(tag) == 'package-2019-10-17-preview-only' input-file: -- Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json + - Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json ``` ### Tag: package-2019-07-only These settings apply only when `--tag=package-2019-07-only` is specified on the command line. -``` yaml $(tag) == 'package-2019-07-only' +```yaml $(tag) == 'package-2019-07-only' input-file: - Microsoft.Insights/stable/2019-07-01/metrics_API.json - Microsoft.Insights/stable/2019-07-01/operations_API.json @@ -896,202 +932,202 @@ input-file: These settings apply only when `--tag=package-2019-06` is specified on the command line. -``` yaml $(tag) == 'package-2019-06' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2019-06-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json +```yaml $(tag) == 'package-2019-06' +input-file: + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2019-06-01/actionGroups_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json ``` ### Tag: package-2019-03 These settings apply only when `--tag=package-2019-03` is specified on the command line. -``` yaml $(tag) == 'package-2019-03' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2019-03-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json +```yaml $(tag) == 'package-2019-03' +input-file: + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2019-03-01/actionGroups_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json ``` ### Tag: package-2018-11-preview These settings apply only when `--tag=package-2018-11-preview` is specified on the command line. -``` yaml $(tag) == 'package-2018-11-preview' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json +```yaml $(tag) == 'package-2018-11-preview' +input-file: + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2018-09-01/actionGroups_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json ``` ### Tag: package-2018-09 These settings apply only when `--tag=package-2018-09` is specified on the command line. -``` yaml $(tag) == 'package-2018-09' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -- Microsoft.Insights/stable/2018-09-01/metricBaselines_API.json +```yaml $(tag) == 'package-2018-09' +input-file: + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2018-09-01/actionGroups_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json + - Microsoft.Insights/stable/2018-09-01/metricBaselines_API.json ``` ### Tag: package-2018-03 These settings apply only when `--tag=package-2018-03` is specified on the command line. -``` yaml $(tag) == 'package-2018-03' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2018-03-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json +```yaml $(tag) == 'package-2018-03' +input-file: + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2018-03-01/actionGroups_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json ``` ### Tag: package-2018-02-preview These settings apply only when `--tag=package-2018-02-preview` is specified on the command line. -``` yaml $(tag) == 'package-2018-02-preview' +```yaml $(tag) == 'package-2018-02-preview' input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2017-04-01/actionGroups_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json ``` ### Tag: package-2017-12 These settings apply only when `--tag=package-2017-12` is specified on the command line. -``` yaml $(tag) == 'package-2017-12' +```yaml $(tag) == 'package-2017-12' input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json -- Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2017-04-01/actionGroups_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json + - Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json ``` ### Tag: package-2017-09 These settings apply only when `--tag=package-2017-09` is specified on the command line. -``` yaml $(tag) == 'package-2017-09' +```yaml $(tag) == 'package-2017-09' input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json -- Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2018-09-01/actionGroups_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json + - Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json ``` ### Tag: package-2017-09-preview-only These settings apply only when `--tag=package-2017-09-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2017-09-preview-only' +```yaml $(tag) == 'package-2017-09-preview-only' input-file: - Microsoft.Insights/preview/2017-09-01-preview/operations_API.json - Microsoft.Insights/preview/2017-09-01-preview/metricDefinitions_API.json @@ -1102,24 +1138,24 @@ input-file: These settings apply only when `--tag=package-2017-08` is specified on the command line. -``` yaml $(tag) == 'package-2017-08' +```yaml $(tag) == 'package-2017-08' input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2017-04-01/actionGroups_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json ``` ### Tag: package-2019-11-01-preview-only These settings apply only when `--tag=package-2019-11-01-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2019-11-01-preview-only' +```yaml $(tag) == 'package-2019-11-01-preview-only' input-file: - Microsoft.Insights/preview/2019-11-01-preview/dataCollectionRuleAssociations_API.json - Microsoft.Insights/preview/2019-11-01-preview/dataCollectionRules_API.json @@ -1129,144 +1165,144 @@ input-file: These settings apply only when `--tag=package-2019-06-01-only` is specified on the command line. -``` yaml $(tag) == 'package-2019-06-01-only' +```yaml $(tag) == 'package-2019-06-01-only' input-file: -- Microsoft.Insights/stable/2019-06-01/actionGroups_API.json + - Microsoft.Insights/stable/2019-06-01/actionGroups_API.json ``` ### Tag: package-2019-03-01-only These settings apply only when `--tag=package-2019-03-01-only` is specified on the command line. -``` yaml $(tag) == 'package-2019-03-01-only' +```yaml $(tag) == 'package-2019-03-01-only' input-file: -- Microsoft.Insights/stable/2019-03-01/actionGroups_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/stable/2019-03-01/actionGroups_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json ``` ### Tag: package-2018-11-27-preview-only These settings apply only when `--tag=package-2018-11-27-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2018-11-27-preview-only' +```yaml $(tag) == 'package-2018-11-27-preview-only' input-file: -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json ``` ### Tag: package-2018-09-01-only These settings apply only when `--tag=package-2018-09-01-only` is specified on the command line. -``` yaml $(tag) == 'package-2018-09-01-only' +```yaml $(tag) == 'package-2018-09-01-only' input-file: -- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json + - Microsoft.Insights/stable/2018-09-01/actionGroups_API.json ``` ### Tag: package-2018-09-01-python-only These settings apply only when `--tag=package-2018-09-01-python-only` is specified on the command line. -``` yaml $(tag) == 'package-2018-09-01-python-only' +```yaml $(tag) == 'package-2018-09-01-python-only' input-file: -- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json -- Microsoft.Insights/stable/2018-09-01/metricBaselines_API.json + - Microsoft.Insights/stable/2018-09-01/actionGroups_API.json + - Microsoft.Insights/stable/2018-09-01/metricBaselines_API.json ``` ### Tag: package-2018-06-01-preview-only These settings apply only when `--tag=package-2018-06-01-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2018-06-01-preview-only' +```yaml $(tag) == 'package-2018-06-01-preview-only' input-file: -- Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json -- Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettings_API.json + - Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json + - Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettings_API.json ``` ### Tag: package-2018-04-16-only These settings apply only when `--tag=package-2018-04-16-only` is specified on the command line. -``` yaml $(tag) == 'package-2018-04-16-only' +```yaml $(tag) == 'package-2018-04-16-only' input-file: -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json + - Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json ``` ### Tag: package-2018-03-01-only These settings apply only when `--tag=package-2018-03-01-only` is specified on the command line. -``` yaml $(tag) == 'package-2018-03-01-only' +```yaml $(tag) == 'package-2018-03-01-only' input-file: -- Microsoft.Insights/stable/2018-03-01/actionGroups_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/stable/2018-03-01/actionGroups_API.json + - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json ``` ### Tag: package-2018-01-01-only These settings apply only when `--tag=package-2018-01-01-only` is specified on the command line. -``` yaml $(tag) == 'package-2018-01-01-only' +```yaml $(tag) == 'package-2018-01-01-only' input-file: -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json ``` ### Tag: package-2017-12-01-preview-only These settings apply only when `--tag=package-2017-12-01-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2017-12-01-preview-only' +```yaml $(tag) == 'package-2017-12-01-preview-only' input-file: -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json ``` ### Tag: package-2017-05-01-preview-only These settings apply only when `--tag=package-2017-05-01-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2017-05-01-preview-only' +```yaml $(tag) == 'package-2017-05-01-preview-only' input-file: -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json -- Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json -- Microsoft.Insights/preview/2017-05-01-preview/subscriptionDiagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json + - Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json + - Microsoft.Insights/preview/2017-05-01-preview/subscriptionDiagnosticsSettings_API.json ``` ### Tag: package-2017-04-01-only These settings apply only when `--tag=package-2017-04-01-only` is specified on the command line. -``` yaml $(tag) == 'package-2017-04-01-only' +```yaml $(tag) == 'package-2017-04-01-only' input-file: -- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2017-04-01/actionGroups_API.json + - Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json ``` ### Tag: package-2017-03-01-preview-only These settings apply only when `--tag=package-2017-03-01-preview-only` is specified on the command line. -``` yaml $(tag) == 'package-2017-03-01-preview-only' +```yaml $(tag) == 'package-2017-03-01-preview-only' input-file: -- Microsoft.Insights/preview/2017-03-01-preview/activityLogAlerts_API.json + - Microsoft.Insights/preview/2017-03-01-preview/activityLogAlerts_API.json ``` ### Tag: package-2016-09-01-only These settings apply only when `--tag=package-2016-09-01-only` is specified on the command line. -``` yaml $(tag) == 'package-2016-09-01-only' +```yaml $(tag) == 'package-2016-09-01-only' input-file: -- Microsoft.Insights/stable/2016-09-01/metrics_API.json -- Microsoft.Insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json + - Microsoft.Insights/stable/2016-09-01/metrics_API.json + - Microsoft.Insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json ``` ### Tag: package-2016-06-only These settings apply only when `--tag=package-2016-06-only` is specified on the command line. -``` yaml $(tag) == 'package-2016-06-only' +```yaml $(tag) == 'package-2016-06-only' input-file: - Microsoft.Insights/stable/2016-06-01/metrics_API.json - Microsoft.Insights/stable/2016-06-01/operations_API.json @@ -1276,72 +1312,72 @@ input-file: These settings apply only when `--tag=package-2016-03-01-only` is specified on the command line. -``` yaml $(tag) == 'package-2016-03-01-only' +```yaml $(tag) == 'package-2016-03-01-only' input-file: -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/stable/2016-03-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/stable/2016-03-01/metricDefinitions_API.json ``` ### Tag: package-2015-07-01-only These settings apply only when `--tag=package-2015-07-01-only` is specified on the command line. -``` yaml $(tag) == 'package-2015-07-01-only' +```yaml $(tag) == 'package-2015-07-01-only' input-file: -- Microsoft.Insights/stable/2015-07-01/serviceDiagnosticsSettings_API.json -- Microsoft.Insights/stable/2015-07-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2014-04-01/alertRules_API.json -- Microsoft.Insights/stable/2015-07-01/operations_API.json + - Microsoft.Insights/stable/2015-07-01/serviceDiagnosticsSettings_API.json + - Microsoft.Insights/stable/2015-07-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2014-04-01/alertRules_API.json + - Microsoft.Insights/stable/2015-07-01/operations_API.json ``` ### Tag: package-2015-07-01-python-only These settings apply only when `--tag=package-2015-07-01-python-only` is specified on the command line. -``` yaml $(tag) == 'package-2015-07-01-python-only' +```yaml $(tag) == 'package-2015-07-01-python-only' input-file: -- Microsoft.Insights/stable/2015-07-01/serviceDiagnosticsSettings_API.json -- Microsoft.Insights/stable/2015-07-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2015-07-01/operations_API.json + - Microsoft.Insights/stable/2015-07-01/serviceDiagnosticsSettings_API.json + - Microsoft.Insights/stable/2015-07-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2015-07-01/operations_API.json ``` ### Tag: package-2015-04-01-only These settings apply only when `--tag=package-2015-04-01-only` is specified on the command line. -``` yaml $(tag) == 'package-2015-04-01-only' +```yaml $(tag) == 'package-2015-04-01-only' input-file: -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2014-04-01/alertRules_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2014-04-01/alertRules_API.json ``` ### Tag: package-2015-04-01-python-only These settings apply only when `--tag=package-2015-04-01-python-only` is specified on the command line. -``` yaml $(tag) == 'package-2015-04-01-python-only' +```yaml $(tag) == 'package-2015-04-01-python-only' input-file: -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json ``` ### Tag: package-2014-04-01-only These settings apply only when `--tag=package-2014-04-01-only` is specified on the command line. -``` yaml $(tag) == 'package-2014-04-01-only' +```yaml $(tag) == 'package-2014-04-01-only' input-file: -- Microsoft.Insights/stable/2014-04-01/alertRules_API.json -- Microsoft.Insights/stable/2014-04-01/autoscale_API.json + - Microsoft.Insights/stable/2014-04-01/alertRules_API.json + - Microsoft.Insights/stable/2014-04-01/autoscale_API.json ``` --- @@ -1353,7 +1389,7 @@ input-file: This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself. -``` yaml $(swagger-to-sdk) +```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net-track2 - repo: azure-sdk-for-python @@ -1384,138 +1420,138 @@ See configuration in [readme.java.md](./readme.java.md) ## Suppression -``` yaml +```yaml directive: - suppress: R4009 from: privateLinkScopes_API.json - reason: 'Contract is defined in the Network RP private endpoint spec, can be updated by internal calls from Network RP. ' + reason: "Contract is defined in the Network RP private endpoint spec, can be updated by internal calls from Network RP. " - suppress: R3018 from: privateLinkScopes_API.json where: $.definitions.PrivateEndpointConnectionProperties.properties.queryOnlyPrivateLinkResources - reason: 'This property indicates whether data coming through this private endpoint should restrict itself only to resources in the scope - it has only ''''true'''' or ''''false'''' options, so it fits boolean type.' + reason: "This property indicates whether data coming through this private endpoint should restrict itself only to resources in the scope - it has only ''true'' or ''false'' options, so it fits boolean type." - suppress: R3018 from: privateLinkScopes_API.json where: $.definitions.PrivateEndpointConnectionProperties.properties.ingestOnlyToPrivateLinkResources - reason: 'This property indicates whether data coming through this private endpoint should restrict itself only to resources in the scope - it has only ''''true'''' or ''''false'''' options, so it fits boolean type.' + reason: "This property indicates whether data coming through this private endpoint should restrict itself only to resources in the scope - it has only ''true'' or ''false'' options, so it fits boolean type." - suppress: OperationsAPIImplementation from: privateLinkScopes_API.json where: $.paths - reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + reason: "Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)" - suppress: R3016 reason: The feature (polymorphic types) is in the process of deprecation and fixing this will require changes in the backend. - suppress: OperationsAPIImplementation from: dataCollectionEndpoints_API.json where: $.paths - reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + reason: "Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)" - suppress: OperationsAPIImplementation from: dataCollectionRules_API.json where: $.paths - reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + reason: "Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)" - suppress: OperationsAPIImplementation from: dataCollectionRuleAssociations_API.json where: $.paths - reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + reason: "Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)" - suppress: MissingTypeObject from: metrics_API.json where: $.definitions.LocalizableString - reason: 'LocalizableString exists in other swaggers my team can not modify' + reason: "LocalizableString exists in other swaggers my team can not modify" - suppress: MissingTypeObject from: metricDefinitions_API.json where: $.definitions.LocalizableString - reason: 'LocalizableString exists in other swaggers my team can not modify' + reason: "LocalizableString exists in other swaggers my team can not modify" - suppress: OperationsAPIImplementation where: $.paths from: activityLogAlerts_API.json - reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + reason: "Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)" - suppress: OperationsAPIImplementation where: $.paths from: scheduledQueryRule_API.json - reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + reason: "Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)" - suppress: R4005 where: $.definitions.Dimension.properties.operator from: scheduledQueryRule_API.json - reason: 'The discrepancy in the enum values is with an enum which is defined for a different service of a different team' + reason: "The discrepancy in the enum values is with an enum which is defined for a different service of a different team" - suppress: R3016 where: $.definitions.Action.properties["odata.type"] - reason: 'This is an old field in a stable api version which is not camel cased' + reason: "This is an old field in a stable api version which is not camel cased" - suppress: EnumInsteadOfBoolean where: $.definitions.AlertRuleProperties.properties.enabled from: activityLogAlerts_API.json - reason: 'This property indicates whether the alert rule is enabled or not - it has only ''''true'''' or ''''false'''' options, so it fits boolean type.' + reason: "This property indicates whether the alert rule is enabled or not - it has only ''true'' or ''false'' options, so it fits boolean type." - suppress: EnumInsteadOfBoolean where: $.definitions.AlertRulePatchProperties.properties.enabled from: activityLogAlerts_API.json - reason: 'This property indicates whether the alert rule is enabled or not - it has only ''''true'''' or ''''false'''' options, so it fits boolean type.' + reason: "This property indicates whether the alert rule is enabled or not - it has only ''true'' or ''false'' options, so it fits boolean type." - suppress: DefaultErrorResponseSchema from: activityLogAlerts_API.json - reason: 'Updating the error response to the new format would be a breaking change.' + reason: "Updating the error response to the new format would be a breaking change." - suppress: DefaultErrorResponseSchema from: metricNamespaces_API.json - reason: 'Updating the error response to the new format would be a breaking change.' + reason: "Updating the error response to the new format would be a breaking change." - suppress: DefaultErrorResponseSchema from: metrics_API.json - reason: 'Updating the error response to the new format would be a breaking change.' + reason: "Updating the error response to the new format would be a breaking change." - suppress: DefaultErrorResponseSchema from: metricDefinitions_API.json - reason: 'Updating the error response to the new format would be a breaking change.' + reason: "Updating the error response to the new format would be a breaking change." - suppress: DefaultErrorResponseSchema from: actionGroups_API.json - reason: 'Updating the error response to the new format would be a breaking change.' + reason: "Updating the error response to the new format would be a breaking change." - suppress: OperationsAPIImplementation from: operations_API.json where: $.paths - reason: 'The operations API is implemented however the tool is still firing due to the casing being different' + reason: "The operations API is implemented however the tool is still firing due to the casing being different" - suppress: OperationsAPIImplementation from: serviceDiagnosticsSettings_API.json where: $.paths - reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + reason: "Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)" - suppress: OperationsAPIImplementation from: subscriptionDiagnosticsSettings_API.json where: $.paths - reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + reason: "Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)" - suppress: OperationsAPIImplementation from: autoscale_API.json where: $.paths - reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + reason: "Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)" - suppress: OperationsAPIImplementation from: actionGroups_API.json where: $.paths - reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + reason: "Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)" - suppress: GetCollectionOnlyHasValueAndNextLink from: metricDefinitions_API.json - reason: 'Breaking change to modify metricDefinitions now' + reason: "Breaking change to modify metricDefinitions now" - suppress: GetCollectionOnlyHasValueAndNextLink from: metrics_API.json - reason: 'Due to the ability to sort and order the list, this is incompatible with paging. It would also be a breaking change to modify this now' + reason: "Due to the ability to sort and order the list, this is incompatible with paging. It would also be a breaking change to modify this now" - suppress: ParametersInPost from: metrics_API.json - reason: 'metrics API is really a GET action that allows some parameters to be in the body due to length concerns. It would also be a breaking change to modify this now' + reason: "metrics API is really a GET action that allows some parameters to be in the body due to length concerns. It would also be a breaking change to modify this now" - suppress: AvoidAdditionalProperties from: scheduledQueryRule_API.json where: $.definitions.Actions.properties.actionProperties - reason: 'This is a key-value collection which we do not validate and just pass as-is to a service which is several hops down the pipe where they are interpreted. Unknown keys are ignored and there are no invalid values.' + reason: "This is a key-value collection which we do not validate and just pass as-is to a service which is several hops down the pipe where they are interpreted. Unknown keys are ignored and there are no invalid values." ``` This section is a temporary solution to resolve the failure in those pipeline that is still using modeler v1. -``` yaml ($(go) && !$(track2) && ($(tag) == 'package-2021-07' || $(tag) == 'package-2021-09') || $(csharp) || $(validation) +```yaml ($(go) && !$(track2) && ($(tag) == 'package-2021-07' || $(tag) == 'package-2021-09') || $(csharp) || $(validation) directive: -- from: activityLogAlerts_API.json - where: $.definitions - transform: delete $["Resource"] - reason: Missing kind, etag -- from: activityLogAlerts_API.json - where: $.definitions - transform: delete $["ErrorResponse"] - reason: Incompatible values (2020-10-01) -- from: activityLogAlerts_API.json - where: $.definitions - transform: delete $["AzureResource"] - reason: Incompatible values (2020-10-01) -- from: activityLogAlerts_API.json - where: $.definitions - transform: delete $["ActionGroup"] - reason: Incompatible values (2020-10-01) + - from: activityLogAlerts_API.json + where: $.definitions + transform: delete $["Resource"] + reason: Missing kind, etag + - from: activityLogAlerts_API.json + where: $.definitions + transform: delete $["ErrorResponse"] + reason: Incompatible values (2020-10-01) + - from: activityLogAlerts_API.json + where: $.definitions + transform: delete $["AzureResource"] + reason: Incompatible values (2020-10-01) + - from: activityLogAlerts_API.json + where: $.definitions + transform: delete $["ActionGroup"] + reason: Incompatible values (2020-10-01) ``` ### Tag: profile-hybrid-2019-03-01 @@ -1523,14 +1559,14 @@ directive: These settings apply only when `--tag=profile-hybrid-2019-03-01` is specified on the command line. Creating this tag to pick proper resources from the hybrid profile. -``` yaml $(tag) == 'profile-hybrid-2019-03-01' +```yaml $(tag) == 'profile-hybrid-2019-03-01' input-file: -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json ``` ### Tag: profile-hybrid-2020-09-01 @@ -1538,12 +1574,12 @@ input-file: These settings apply only when `--tag=profile-hybrid-2020-09-01` is specified on the command line. Creating this tag to pick proper resources from the hybrid profile. -``` yaml $(tag) == 'profile-hybrid-2020-09-01' +```yaml $(tag) == 'profile-hybrid-2020-09-01' input-file: -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2018-01-01/metrics_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json ``` diff --git a/specification/monitor/resource-manager/sdk-suppressions.yaml b/specification/monitor/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..81b7da868136 --- /dev/null +++ b/specification/monitor/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,52 @@ +suppressions: + azure-sdk-for-js: + - package: '@azure/arm-monitor' + breaking-changes: + - Removed operation group Metrics + - Removed operation ActionGroups.beginPostTestNotifications + - Removed operation ActionGroups.beginPostTestNotificationsAndWait + - Removed operation ActionGroups.getTestNotifications + - Operation ActivityLogAlerts.update has a new signature + - Operation PrivateEndpointConnections.beginCreateOrUpdate has a new signature + - Operation PrivateEndpointConnections.beginCreateOrUpdateAndWait has a new signature + - Operation ScheduledQueryRules.createOrUpdate has a new signature + - Operation ScheduledQueryRules.update has a new signature + - Class MonitorClient has a new signature + - Interface ActivityLogsListNextOptionalParams no longer has parameter select + - Interface AzureResource no longer has parameter identity + - Interface AzureResource no longer has parameter kind + - Interface ErrorResponse no longer has parameter code + - Interface ErrorResponse no longer has parameter message + - Interface PrivateEndpointConnectionListResult no longer has parameter nextLink + - Interface PrivateLinkResourceListResult no longer has parameter nextLink + - Interface Resource no longer has parameter location + - Interface Resource no longer has parameter tags + - Interface ResourceAutoGenerated no longer has parameter etag + - Interface ResourceAutoGenerated no longer has parameter kind + - Interface ResourceAutoGenerated no longer has parameter location + - Interface ResourceAutoGenerated no longer has parameter tags + - Interface ScheduledQueryRulesListByResourceGroupOptionalParams no longer has parameter filter + - Interface ScheduledQueryRulesListBySubscriptionOptionalParams no longer has parameter filter + - Interface TenantActivityLogsListNextOptionalParams no longer has parameter filter + - Interface TenantActivityLogsListNextOptionalParams no longer has parameter select + - Type of parameter operator of interface Dimension is changed from Operator to DimensionOperator + - Type of parameter error of interface ErrorContract is changed from ErrorResponse to ErrorResponseAutoGenerated2 + - Type of parameter error of interface ErrorResponseCommonV2 is changed from ErrorDetail to ErrorDetailAutoGenerated2 + - Type of parameter value of interface EventCategoryCollection is changed from LocalizableString[] to LocalizableStringAutoGenerated[] + - Type of parameter category of interface EventData is changed from LocalizableString to LocalizableStringAutoGenerated + - Type of parameter eventName of interface EventData is changed from LocalizableString to LocalizableStringAutoGenerated + - Type of parameter operationName of interface EventData is changed from LocalizableString to LocalizableStringAutoGenerated + - Type of parameter resourceProviderName of interface EventData is changed from LocalizableString to LocalizableStringAutoGenerated + - Type of parameter resourceType of interface EventData is changed from LocalizableString to LocalizableStringAutoGenerated + - Type of parameter status of interface EventData is changed from LocalizableString to LocalizableStringAutoGenerated + - Type of parameter subStatus of interface EventData is changed from LocalizableString to LocalizableStringAutoGenerated + - Type of parameter error of interface OperationStatus is changed from ErrorResponseCommon to ErrorDetailAutoGenerated2 + - Type of parameter value of interface PrivateEndpointConnectionListResult is changed from PrivateEndpointConnection[] to PrivateEndpointConnectionAutoGenerated[] + - Class MonitorClient no longer has parameter metrics + - Removed Enum KnownConditionalOperator + - Removed Enum KnownEnabled + - Removed Enum KnownMetricTriggerType + - Removed Enum KnownQueryType + - Enum KnownOperator no longer has value Include + - Enum KnownProvisioningState no longer has value Deploying + From 432838208e52bdf6267b8a566331ba10893c2076 Mon Sep 17 00:00:00 2001 From: zhejiao <145073190+zhejiao@users.noreply.github.com> Date: Fri, 31 May 2024 07:22:49 -0700 Subject: [PATCH 13/49] Review request for Microsoft.HybridCompute to add version preview/2024-05-20-preview (#29070) * Copy files from preview/2024-03-31-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-05-20-preview Updated the API version from preview/2024-03-31-preview to preview/2024-05-20-preview. * Added tag for 2024-05-20-preview in readme file * Add more SubscriptionStatus values, ErrorDetails, BillingEndDate and Hotpatch Management Properties * Make prettier happy --- cSpell.json | 6 + .../2024-05-20-preview/HybridCompute.json | 5445 +++++++++++++++++ .../examples/AgentVersion_GetLatest.json | 16 + .../examples/AgentVersions_Get.json | 24 + .../examples/HybridIdentityMetadata_Get.json | 27 + ...dentityMetadata_ListByVirtualMachines.json | 30 + .../examples/NetworkProfile_Get.json | 38 + .../examples/Operations_List.json | 35 + .../extension/ExtensionMetadata_Get.json | 22 + .../extension/ExtensionMetadata_List.json | 33 + .../extension/Extension_CreateOrUpdate.json | 53 + .../examples/extension/Extension_Delete.json | 20 + .../examples/extension/Extension_Get.json | 42 + .../examples/extension/Extension_List.json | 64 + .../examples/extension/Extension_Update.json | 60 + .../extension/Extensions_Upgrade.json | 28 + .../gateway/Gateway_CreateOrUpdate.json | 60 + .../examples/gateway/Gateway_Delete.json | 18 + .../examples/gateway/Gateway_Get.json | 28 + .../gateway/Gateway_ListByResourceGroup.json | 32 + .../gateway/Gateway_ListBySubscription.json | 31 + .../examples/gateway/Gateway_Update.json | 34 + .../license/License_CreateOrUpdate.json | 45 + .../examples/license/License_Delete.json | 12 + .../examples/license/License_Get.json | 32 + .../license/License_ListByResourceGroup.json | 36 + .../license/License_ListBySubscription.json | 35 + .../examples/license/License_Update.json | 43 + .../license/License_ValidateLicense.json | 44 + .../LicenseProfile_CreateOrUpdate.json | 133 + .../licenseProfile/LicenseProfile_Delete.json | 19 + .../licenseProfile/LicenseProfile_Get.json | 59 + .../licenseProfile/LicenseProfile_List.json | 63 + .../licenseProfile/LicenseProfile_Update.json | 85 + .../machine/Machine_AssessPatches.json | 37 + .../machine/Machine_InstallPatches.json | 44 + .../machine/Machines_CreateOrUpdate.json | 141 + .../examples/machine/Machines_Delete.json | 12 + .../examples/machine/Machines_Get.json | 172 + ...chines_Get_LicenseProfileInstanceView.json | 193 + .../machine/Machines_ListByResourceGroup.json | 251 + .../machine/Machines_ListBySubscription.json | 249 + .../examples/machine/Machines_Update.json | 140 + .../NetworkConfigurationsCreate.json | 55 + .../NetworkConfigurationsGet.json | 28 + .../NetworkConfigurationsPatch.json | 34 + .../NetworkConfigurationsUpdate.json | 54 + ...workSecurityPerimeterConfigurationGet.json | 50 + ...orkSecurityPerimeterConfigurationList.json | 90 + ...curityPerimeterConfigurationReconcile.json | 18 + .../PrivateEndpointConnection_Delete.json | 20 + .../PrivateEndpointConnection_Get.json | 32 + .../PrivateEndpointConnection_List.json | 54 + .../PrivateEndpointConnection_Update.json | 41 + ...ivateLinkScopePrivateLinkResource_Get.json | 31 + ...eLinkScopePrivateLinkResource_ListGet.json | 35 + .../PrivateLinkScopes_Create.json | 77 + .../PrivateLinkScopes_Delete.json | 19 + .../PrivateLinkScopes_Get.json | 42 + .../PrivateLinkScopes_GetValidation.json | 25 + ...ateLinkScopes_GetValidationForMachine.json | 26 + .../PrivateLinkScopes_List.json | 57 + ...PrivateLinkScopes_ListByResourceGroup.json | 76 + .../PrivateLinkScopes_Update.json | 84 + .../PrivateLinkScopes_UpdateTagsOnly.json | 51 + .../RunCommands_CreateOrUpdate.json | 98 + .../runCommand/RunCommands_Delete.json | 19 + .../examples/runCommand/RunCommands_Get.json | 52 + .../examples/runCommand/RunCommands_List.json | 77 + .../runCommand/RunCommands_Update.json | 62 + .../examples/settings/SettingsGet.json | 26 + .../examples/settings/SettingsPatch.json | 33 + .../examples/settings/SettingsUpdate.json | 46 + .../2024-05-20-preview/privateLinkScopes.json | 1896 ++++++ .../hybridcompute/resource-manager/readme.md | 12 +- 75 files changed, 11310 insertions(+), 1 deletion(-) create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/AgentVersion_GetLatest.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/AgentVersions_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/HybridIdentityMetadata_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/HybridIdentityMetadata_ListByVirtualMachines.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/NetworkProfile_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/Operations_List.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/ExtensionMetadata_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/ExtensionMetadata_List.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_CreateOrUpdate.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_Delete.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_List.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_Update.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extensions_Upgrade.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_CreateOrUpdate.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_Delete.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_ListByResourceGroup.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_ListBySubscription.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_Update.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_CreateOrUpdate.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_Delete.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_ListByResourceGroup.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_ListBySubscription.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_Update.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_ValidateLicense.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_CreateOrUpdate.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_Delete.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_List.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_Update.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machine_AssessPatches.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machine_InstallPatches.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_CreateOrUpdate.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Delete.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Get_LicenseProfileInstanceView.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_ListByResourceGroup.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_ListBySubscription.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Update.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsCreate.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsGet.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsPatch.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsUpdate.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationGet.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationList.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationReconcile.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Delete.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_List.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Update.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_ListGet.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Create.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Delete.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidation.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidationForMachine.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_List.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_ListByResourceGroup.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Update.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_UpdateTagsOnly.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_CreateOrUpdate.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_Delete.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_Get.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_List.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_Update.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/settings/SettingsGet.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/settings/SettingsPatch.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/settings/SettingsUpdate.json create mode 100644 specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json diff --git a/cSpell.json b/cSpell.json index fe4853d587b6..ae2a6b889726 100644 --- a/cSpell.json +++ b/cSpell.json @@ -1266,6 +1266,12 @@ "AUTOCONFIRMED" ] }, + { + "filename": "**/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/**/*.json", + "words": [ + "hotpatch" + ] + }, { "filename": "**/specification/monitor/resource-manager/Microsoft.Insights/**/actionGroups_API.json", "words": [ diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json new file mode 100644 index 000000000000..70aeedb7d529 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json @@ -0,0 +1,5445 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridComputeManagementClient", + "description": "The Hybrid Compute Management Client.", + "version": "2024-05-20-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/validateLicense": { + "post": { + "tags": [ + "licenses" + ], + "operationId": "Licenses_ValidateLicense", + "description": "The operation to validate a license.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/License" + }, + "description": "Parameters supplied to the license validation operation." + } + ], + "responses": { + "200": { + "description": "Updated Resource", + "schema": { + "$ref": "#/definitions/License" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Validate a License": { + "$ref": "./examples/license/License_ValidateLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}": { + "put": { + "tags": [ + "licenses" + ], + "operationId": "Licenses_CreateOrUpdate", + "description": "The operation to create or update a license.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/licenseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/License" + }, + "description": "Parameters supplied to the Create license operation." + } + ], + "responses": { + "200": { + "description": "Updated Resource", + "schema": { + "$ref": "#/definitions/License" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or Update a License": { + "$ref": "./examples/license/License_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "licenses" + ], + "operationId": "Licenses_Update", + "description": "The operation to update a license.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/licenseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LicenseUpdate" + }, + "description": "Parameters supplied to the Update license operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/License" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a License": { + "$ref": "./examples/license/License_Update.json" + } + } + }, + "get": { + "tags": [ + "licenses" + ], + "operationId": "Licenses_Get", + "description": "Retrieves information about the view of a license.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/licenseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/License" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get License": { + "$ref": "./examples/license/License_Get.json" + } + } + }, + "delete": { + "tags": [ + "licenses" + ], + "operationId": "Licenses_Delete", + "description": "The operation to delete a license.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/licenseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a License": { + "$ref": "./examples/license/License_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses": { + "get": { + "tags": [ + "licenses" + ], + "operationId": "Licenses_ListByResourceGroup", + "description": "The operation to get all licenses of a non-Azure machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LicensesListResult" + } + }, + "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" + }, + "x-ms-examples": { + "GET all Machine Extensions": { + "$ref": "./examples/license/License_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/licenses": { + "get": { + "tags": [ + "licenses" + ], + "operationId": "Licenses_ListBySubscription", + "description": "The operation to get all licenses of a non-Azure machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LicensesListResult" + } + }, + "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" + }, + "x-ms-examples": { + "List Licenses by Subscription": { + "$ref": "./examples/license/License_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}": { + "put": { + "tags": [ + "machines" + ], + "operationId": "Machines_CreateOrUpdate", + "description": "The operation to create or update a hybrid machine. Please note some properties can be set only during machine creation.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Machine" + }, + "description": "Parameters supplied to the Create hybrid machine operation." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update a Machine": { + "$ref": "./examples/machine/Machines_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "machines" + ], + "operationId": "Machines_Update", + "description": "The operation to update a hybrid machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineUpdate" + }, + "description": "Parameters supplied to the Update hybrid machine operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a Machine": { + "$ref": "./examples/machine/Machines_Update.json" + } + } + }, + "delete": { + "tags": [ + "machines" + ], + "operationId": "Machines_Delete", + "description": "The operation to delete a hybrid machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a Machine": { + "$ref": "./examples/machine/Machines_Delete.json" + } + } + }, + "get": { + "tags": [ + "machines" + ], + "operationId": "Machines_Get", + "description": "Retrieves information about the model view or the instance view of a hybrid machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Machine": { + "$ref": "./examples/machine/Machines_Get.json" + }, + "Get Machine with License Profile Instance View": { + "$ref": "./examples/machine/Machines_Get_LicenseProfileInstanceView.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}": { + "put": { + "tags": [ + "licenseProfiles" + ], + "operationId": "LicenseProfiles_CreateOrUpdate", + "description": "The operation to create or update a license profile.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/machineNameParameter" + }, + { + "$ref": "#/parameters/licenseProfileNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LicenseProfile" + }, + "description": "Parameters supplied to the Create or Update license profile operation." + } + ], + "responses": { + "200": { + "description": "Updated Resource", + "schema": { + "$ref": "#/definitions/LicenseProfile" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/LicenseProfile" + }, + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or Update a License Profile": { + "$ref": "./examples/licenseProfile/LicenseProfile_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "licenseProfiles" + ], + "operationId": "LicenseProfiles_Update", + "description": "The operation to update a license profile.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/machineNameParameter" + }, + { + "$ref": "#/parameters/licenseProfileNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LicenseProfileUpdate" + }, + "description": "Parameters supplied to the Update license profile operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LicenseProfile" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a License Profile": { + "$ref": "./examples/licenseProfile/LicenseProfile_Update.json" + } + } + }, + "get": { + "tags": [ + "licenseProfiles" + ], + "operationId": "LicenseProfiles_Get", + "description": "Retrieves information about the view of a license profile.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/machineNameParameter" + }, + { + "$ref": "#/parameters/licenseProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LicenseProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get License Profile": { + "$ref": "./examples/licenseProfile/LicenseProfile_Get.json" + } + } + }, + "delete": { + "tags": [ + "licenseProfiles" + ], + "operationId": "LicenseProfiles_Delete", + "description": "The operation to delete a license profile.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/machineNameParameter" + }, + { + "$ref": "#/parameters/licenseProfileNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a License Profile": { + "$ref": "./examples/licenseProfile/LicenseProfile_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles": { + "get": { + "tags": [ + "licenseProfiles" + ], + "operationId": "LicenseProfiles_List", + "description": "The operation to get all license profiles of a non-Azure machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the machine." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LicenseProfilesListResult" + } + }, + "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" + }, + "x-ms-examples": { + "List all License Profiles": { + "$ref": "./examples/licenseProfile/LicenseProfile_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/assessPatches": { + "post": { + "tags": [ + "machines" + ], + "operationId": "Machines_AssessPatches", + "x-ms-examples": { + "Assess patch state of a machine.": { + "$ref": "./examples/machine/Machine_AssessPatches.json" + } + }, + "description": "The operation to assess patches on a hybrid machine identity in Azure.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineAssessPatchesResult" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/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.HybridCompute/machines/{name}/installPatches": { + "post": { + "tags": [ + "machines" + ], + "operationId": "Machines_InstallPatches", + "description": "The operation to install patches on a hybrid machine identity in Azure.", + "x-ms-examples": { + "Install patch state of a machine.": { + "$ref": "./examples/machine/Machine_InstallPatches.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + }, + { + "name": "installPatchesInput", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineInstallPatchesParameters" + }, + "description": "Input for InstallPatches as directly received by the API" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineInstallPatchesResult" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/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.HybridCompute/machines": { + "get": { + "tags": [ + "machines" + ], + "operationId": "Machines_ListByResourceGroup", + "description": "Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Machines by resource group": { + "$ref": "./examples/machine/Machines_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/machines": { + "get": { + "tags": [ + "machines" + ], + "operationId": "Machines_ListBySubscription", + "description": "Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Machines by resource group": { + "$ref": "./examples/machine/Machines_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}": { + "put": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_CreateOrUpdate", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the machine where the extension should be created or updated." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineExtension" + }, + "description": "Parameters supplied to the Create Machine Extension operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineExtension" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update a Machine Extension": { + "$ref": "./examples/extension/Extension_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_Update", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the machine where the extension should be created or updated." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineExtensionUpdate" + }, + "description": "Parameters supplied to the Create Machine Extension operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineExtension" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update a Machine Extension": { + "$ref": "./examples/extension/Extension_Update.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the machine where the extension should be deleted." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a Machine Extension": { + "$ref": "./examples/extension/Extension_Delete.json" + } + } + }, + "get": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the machine containing the extension." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GET Machine Extension": { + "$ref": "./examples/extension/Extension_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions": { + "get": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_List", + "description": "The operation to get all extensions of a non-Azure machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the machine containing the extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineExtensionsListResult" + } + }, + "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" + }, + "x-ms-examples": { + "GET all Machine Extensions - List": { + "$ref": "./examples/extension/Extension_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/upgradeExtensions": { + "post": { + "tags": [ + "MachineExtensions Upgrade" + ], + "operationId": "UpgradeExtensions", + "description": "The operation to Upgrade Machine Extensions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + }, + { + "name": "extensionUpgradeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineExtensionUpgrade" + }, + "description": "Parameters supplied to the Upgrade Extensions operation." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upgrade Machine Extensions": { + "$ref": "./examples/extension/Extensions_Upgrade.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions/{version}": { + "get": { + "tags": [ + "extensions" + ], + "operationId": "ExtensionMetadata_Get", + "description": "Gets an Extension Metadata based on location, publisher, extensionType and version", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the Extension being received." + }, + { + "name": "publisher", + "in": "path", + "required": true, + "type": "string", + "description": "The publisher of the Extension being received." + }, + { + "name": "extensionType", + "in": "path", + "required": true, + "type": "string", + "description": "The extensionType of the Extension being received." + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the Extension being received." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExtensionValue" + } + }, + "default": { + "description": "Error in retrieving an extension metadata", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GET an extensions metadata": { + "$ref": "./examples/extension/ExtensionMetadata_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions": { + "get": { + "tags": [ + "extensions" + ], + "operationId": "ExtensionMetadata_List", + "description": "Gets all Extension versions based on location, publisher, extensionType", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the Extension being received." + }, + { + "name": "publisher", + "in": "path", + "required": true, + "type": "string", + "description": "The publisher of the Extension being received." + }, + { + "name": "extensionType", + "in": "path", + "required": true, + "type": "string", + "description": "The extensionType of the Extension being received." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExtensionValueListResult" + } + }, + "default": { + "description": "Error in retrieving extension list", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "GET a list of extensions": { + "$ref": "./examples/extension/ExtensionMetadata_List.json" + } + } + } + }, + "/providers/Microsoft.HybridCompute/operations": { + "get": { + "tags": [ + "operations" + ], + "operationId": "Operations_List", + "description": "Gets a list of hybrid compute operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Hybrid Compute Provider Operations": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/networkProfile": { + "get": { + "tags": [ + "MachineNetworkProfile" + ], + "operationId": "NetworkProfile_Get", + "description": "The operation to get network information of hybrid machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GET Network Profile": { + "$ref": "./examples/NetworkProfile_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/hybridIdentityMetadata/{metadataName}": { + "get": { + "tags": [ + "HybridIdentityMetadata" + ], + "operationId": "HybridIdentityMetadata_Get", + "summary": "Gets HybridIdentityMetadata.", + "description": "Implements HybridIdentityMetadata GET method.", + "x-ms-examples": { + "GetHybridIdentityMetadata": { + "$ref": "./examples/HybridIdentityMetadata_Get.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + }, + { + "in": "path", + "name": "metadataName", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "description": "Name of the HybridIdentityMetadata." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HybridIdentityMetadata" + } + }, + "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.HybridCompute/machines/{machineName}/hybridIdentityMetadata": { + "get": { + "tags": [ + "HybridIdentityMetadata" + ], + "operationId": "HybridIdentityMetadata_ListByMachines", + "summary": "Implements GET HybridIdentityMetadata in a machine.", + "description": "Returns the list of HybridIdentityMetadata of the given machine.", + "x-ms-examples": { + "HybridIdentityMetadataListByVirtualMachines": { + "$ref": "./examples/HybridIdentityMetadata_ListByVirtualMachines.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HybridIdentityMetadataList" + } + }, + "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.HybridCompute/osType/{osType}/agentVersions": { + "get": { + "tags": [ + "AgentVersions" + ], + "operationId": "AgentVersion_List", + "description": "Gets all Agent Versions along with the download link currently present.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "osType", + "in": "path", + "required": true, + "type": "string", + "description": "Defines the os type." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentVersionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GET Agent Versions": { + "$ref": "./examples/AgentVersions_Get.json" + } + } + } + }, + "/providers/Microsoft.HybridCompute/osType/{osType}/agentVersions/{version}": { + "get": { + "tags": [ + "AgentVersions" + ], + "operationId": "AgentVersion_Get", + "description": "Gets an Agent Version along with the download link currently present.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "osType", + "in": "path", + "required": true, + "type": "string", + "description": "Defines the os type" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "Defines the agent version. To get latest, use latest or else a specific agent version." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GET Agent Versions": { + "$ref": "./examples/AgentVersion_GetLatest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}": { + "put": { + "tags": [ + "MachineRunCommands" + ], + "operationId": "MachineRunCommands_CreateOrUpdate", + "description": "The operation to create or update a run command.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/machineNameParameter" + }, + { + "$ref": "#/parameters/runCommandNameParameter" + }, + { + "name": "runCommandProperties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineRunCommand" + }, + "description": "Parameters supplied to the Create Run Command." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Updated Resource", + "schema": { + "$ref": "#/definitions/MachineRunCommand" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/MachineRunCommand" + }, + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update a Run Command": { + "$ref": "./examples/runCommand/RunCommands_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "MachineRunCommands" + ], + "operationId": "MachineRunCommands_Update", + "description": "The operation to update the run command.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/machineNameParameter" + }, + { + "$ref": "#/parameters/runCommandNameParameter" + }, + { + "name": "runCommandProperties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineRunCommandUpdate" + }, + "description": "Parameters supplied to the Create Run Command." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineRunCommand" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a Run Command": { + "$ref": "./examples/runCommand/RunCommands_Update.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "MachineRunCommands" + ], + "operationId": "MachineRunCommands_Delete", + "description": "The operation to delete a run command.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/machineNameParameter" + }, + { + "$ref": "#/parameters/runCommandNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete a Machine Run Command": { + "$ref": "./examples/runCommand/RunCommands_Delete.json" + } + } + }, + "get": { + "tags": [ + "MachineRunCommands" + ], + "operationId": "MachineRunCommands_Get", + "description": "The operation to get a run command.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/machineNameParameter" + }, + { + "$ref": "#/parameters/runCommandNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Run Command": { + "$ref": "./examples/runCommand/RunCommands_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands": { + "get": { + "tags": [ + "MachineRunCommands" + ], + "operationId": "MachineRunCommands_List", + "description": "The operation to get all the run commands of a non-Azure machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/machineNameParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineRunCommandsListResult" + } + }, + "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" + }, + "x-ms-examples": { + "GET all Machine Run Commands": { + "$ref": "./examples/runCommand/RunCommands_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName}": { + "put": { + "tags": [ + "gateways" + ], + "operationId": "Gateways_CreateOrUpdate", + "description": "The operation to create or update a gateway.", + "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": "#/parameters/gatewayNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Gateway" + }, + "description": "Parameters supplied to the Create gateway operation." + } + ], + "responses": { + "200": { + "description": "Updated Resource", + "schema": { + "$ref": "#/definitions/Gateway" + } + }, + "201": { + "description": "Updated Resource", + "schema": { + "$ref": "#/definitions/Gateway" + }, + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "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": { + "Create or Update a Gateway": { + "$ref": "./examples/gateway/Gateway_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "gateways" + ], + "operationId": "Gateways_Update", + "description": "The operation to update a gateway.", + "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": "#/parameters/gatewayNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayUpdate" + }, + "description": "Parameters supplied to the Update gateway operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gateway" + } + }, + "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": false, + "x-ms-examples": { + "Update a Gateway": { + "$ref": "./examples/gateway/Gateway_Update.json" + } + } + }, + "get": { + "tags": [ + "gateways" + ], + "operationId": "Gateways_Get", + "description": "Retrieves information about the view of a gateway.", + "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": "#/parameters/gatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Gateway": { + "$ref": "./examples/gateway/Gateway_Get.json" + } + } + }, + "delete": { + "tags": [ + "gateways" + ], + "operationId": "Gateways_Delete", + "description": "The operation to delete a gateway.", + "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": "#/parameters/gatewayNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "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": { + "Delete a Gateway": { + "$ref": "./examples/gateway/Gateway_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways": { + "get": { + "tags": [ + "gateways" + ], + "operationId": "Gateways_ListByResourceGroup", + "description": "The operation to get all gateways of a non-Azure machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$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/GatewaysListResult" + } + }, + "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": { + "List Gateways by Resource Group": { + "$ref": "./examples/gateway/Gateway_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/gateways": { + "get": { + "tags": [ + "gateways" + ], + "operationId": "Gateways_ListBySubscription", + "description": "The operation to get all gateways of a non-Azure machine", + "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/GatewaysListResult" + } + }, + "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": { + "List Gateways by Subscription": { + "$ref": "./examples/gateway/Gateway_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{baseProvider}/{baseResourceType}/{baseResourceName}/providers/Microsoft.HybridCompute/settings/{settingsResourceName}": { + "get": { + "tags": [ + "Settings" + ], + "description": "Returns the base Settings for the target resource.", + "operationId": "Settings_Get", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "NetworkConfigurationsGet": { + "$ref": "./examples/settings/SettingsGet.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": "#/parameters/baseProviderParameter" + }, + { + "$ref": "#/parameters/baseResourceTypeParameter" + }, + { + "$ref": "#/parameters/baseResourceNameParameter" + }, + { + "$ref": "#/parameters/settingsResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Settings information for the target resource.", + "schema": { + "$ref": "#/definitions/Settings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Settings" + ], + "description": "Updates the base Settings of the target resource.", + "operationId": "Settings_Update", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "SettingsUpdate": { + "$ref": "./examples/settings/SettingsUpdate.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": "#/parameters/baseProviderParameter" + }, + { + "$ref": "#/parameters/baseResourceTypeParameter" + }, + { + "$ref": "#/parameters/baseResourceNameParameter" + }, + { + "$ref": "#/parameters/settingsResourceNameParameter" + }, + { + "name": "parameters", + "description": "Settings details", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Settings" + } + } + ], + "responses": { + "200": { + "description": "Successful request when updating a Settings resource. The updated Settings are returned.", + "schema": { + "$ref": "#/definitions/Settings" + } + }, + "201": { + "description": "Successful request when updating a Settings resource. The updated Settings are returned.", + "schema": { + "$ref": "#/definitions/Settings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Settings" + ], + "description": "Update the base Settings of the target resource.", + "operationId": "Settings_Patch", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "NetworkConfigurationsPatch": { + "$ref": "./examples/settings/SettingsPatch.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": "#/parameters/baseProviderParameter" + }, + { + "$ref": "#/parameters/baseResourceTypeParameter" + }, + { + "$ref": "#/parameters/baseResourceNameParameter" + }, + { + "$ref": "#/parameters/settingsResourceNameParameter" + }, + { + "name": "parameters", + "description": "Settings details", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Settings" + } + } + ], + "responses": { + "200": { + "description": "Settings information for the target resource.", + "schema": { + "$ref": "#/definitions/Settings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ExtensionValueListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ExtensionValue" + }, + "description": "The list of extension metadata", + "x-ms-identifiers": [] + } + }, + "description": "The List Extension Metadata response." + }, + "ExtensionValue": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExtensionValueProperties", + "description": "The single extension based on search criteria" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Describes a Extension Metadata" + }, + "ExtensionValueProperties": { + "type": "object", + "properties": { + "version": { + "type": "string", + "readOnly": true, + "description": "The version of the Extension being received." + }, + "extensionType": { + "type": "string", + "readOnly": true, + "description": "The type of the Extension being received." + }, + "publisher": { + "type": "string", + "readOnly": true, + "description": "The publisher of the Extension being received." + } + }, + "description": "Describes Extension Metadata properties" + }, + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "description": "The list of compute operations", + "x-ms-identifiers": [] + } + }, + "description": "The List Compute Operation operation response." + }, + "OperationValue": { + "type": "object", + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "$ref": "#/definitions/OperationValueDisplay", + "description": "Display properties" + }, + "isDataAction": { + "type": "boolean", + "readOnly": true, + "description": "This property indicates if the operation is an action or a data action" + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "OperationValueDisplay": { + "type": "object", + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Hybrid Compute Operation Value Display." + }, + "PatchSettings": { + "type": "object", + "properties": { + "assessmentMode": { + "type": "string", + "description": "Specifies the assessment mode.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "AssessmentModeTypes", + "modelAsString": true + } + }, + "patchMode": { + "type": "string", + "description": "Specifies the patch mode.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform", + "AutomaticByOS", + "Manual" + ], + "x-ms-enum": { + "name": "PatchModeTypes", + "modelAsString": true + } + }, + "enableHotpatching": { + "type": "boolean", + "description": "Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot." + }, + "status": { + "readOnly": true, + "type": "object", + "properties": { + "hotpatchEnablementStatus": { + "$ref": "#/definitions/HotpatchEnablementStatus", + "description": "Indicates the current status of the hotpatch being enabled or disabled." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail", + "readOnly": true, + "description": "The errors that were encountered during the hotpatch capability enrollment or disenrollment." + } + }, + "description": "Status of the hotpatch capability enrollment or disenrollment." + } + }, + "description": "Specifies the patch settings." + }, + "AgentConfiguration": { + "type": "object", + "readOnly": true, + "properties": { + "proxyUrl": { + "type": "string", + "readOnly": true, + "description": "Specifies the URL of the proxy to be used." + }, + "incomingConnectionsPorts": { + "type": "array", + "readOnly": true, + "description": "Specifies the list of ports that the agent will be able to listen on.", + "items": { + "type": "string" + } + }, + "extensionsAllowList": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ConfigurationExtension" + }, + "description": "Array of extensions that are allowed to be installed or updated.", + "x-ms-identifiers": [] + }, + "extensionsBlockList": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ConfigurationExtension" + }, + "description": "Array of extensions that are blocked (cannot be installed or updated)", + "x-ms-identifiers": [] + }, + "proxyBypass": { + "type": "array", + "readOnly": true, + "description": "List of service names which should not use the specified proxy server.", + "items": { + "type": "string" + } + }, + "extensionsEnabled": { + "type": "string", + "readOnly": true, + "description": "Specifies whether the extension service is enabled or disabled." + }, + "guestConfigurationEnabled": { + "type": "string", + "readOnly": true, + "description": "Specified whether the guest configuration service is enabled or disabled." + }, + "configMode": { + "type": "string", + "readOnly": true, + "description": "Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft.", + "enum": [ + "full", + "monitor" + ], + "x-ms-enum": { + "name": "agent configuration mode", + "modelAsString": true + } + } + }, + "description": "Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM." + }, + "ConfigurationExtension": { + "type": "object", + "properties": { + "publisher": { + "type": "string", + "readOnly": true, + "description": "Publisher of the extension." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Type of the extension." + } + }, + "description": "Describes properties that can identify extensions." + }, + "ServiceStatuses": { + "type": "object", + "properties": { + "extensionService": { + "$ref": "#/definitions/ServiceStatus", + "description": "The state of the extension service on the Arc-enabled machine." + }, + "guestConfigurationService": { + "$ref": "#/definitions/ServiceStatus", + "description": "The state of the guest configuration service on the Arc-enabled machine." + } + }, + "description": "Reports the state and behavior of dependent services." + }, + "ServiceStatus": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The current status of the service." + }, + "startupType": { + "type": "string", + "description": "The behavior of the service when the Arc-enabled machine starts up." + } + }, + "description": "Describes the status and behavior of a service." + }, + "CloudMetadata": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "readOnly": true, + "description": "Specifies the cloud provider (Azure/AWS/GCP...)." + } + }, + "description": "The metadata of the cloud environment (Azure/GCP/AWS/OCI...)." + }, + "AgentUpgrade": { + "type": "object", + "properties": { + "desiredVersion": { + "type": "string", + "description": "Specifies the version info w.r.t AgentUpgrade for the machine." + }, + "correlationId": { + "type": "string", + "description": "The correlation ID passed in from RSM per upgrade." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Specifies if RSM should try to upgrade this machine" + }, + "lastAttemptDesiredVersion": { + "type": "string", + "readOnly": true, + "description": "Specifies the version of the last attempt" + }, + "lastAttemptTimestamp": { + "type": "string", + "readOnly": true, + "description": "Timestamp of last upgrade attempt" + }, + "lastAttemptStatus": { + "type": "string", + "readOnly": true, + "enum": [ + "Success", + "Failed" + ], + "x-ms-enum": { + "name": "LastAttemptStatusEnum", + "modelAsString": true + }, + "description": "Specifies the status of Agent Upgrade." + }, + "lastAttemptMessage": { + "type": "string", + "readOnly": true, + "description": "Failure message of last upgrade attempt if any." + } + }, + "description": "The info w.r.t Agent Upgrade." + }, + "OSProfile": { + "type": "object", + "properties": { + "computerName": { + "type": "string", + "readOnly": true, + "description": "Specifies the host OS name of the hybrid machine." + }, + "windowsConfiguration": { + "type": "object", + "properties": { + "patchSettings": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PatchSettings" + } + }, + "description": "Specifies the windows configuration for update management." + }, + "linuxConfiguration": { + "type": "object", + "properties": { + "patchSettings": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PatchSettings" + } + }, + "description": "Specifies the linux configuration for update management." + } + }, + "description": "Specifies the operating system settings for the hybrid machine." + }, + "DetectedProperties": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Detected properties from the machine." + }, + "MachineProperties": { + "type": "object", + "properties": { + "locationData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/locationData" + }, + "agentConfiguration": { + "$ref": "#/definitions/AgentConfiguration", + "description": "Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM." + }, + "serviceStatuses": { + "$ref": "#/definitions/ServiceStatuses", + "description": "Statuses of dependent services that are reported back to ARM." + }, + "cloudMetadata": { + "$ref": "#/definitions/CloudMetadata", + "description": "The metadata of the cloud environment (Azure/GCP/AWS/OCI...)." + }, + "agentUpgrade": { + "$ref": "#/definitions/AgentUpgrade", + "description": "The info of the machine w.r.t Agent Upgrade" + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the hybrid machine." + }, + "licenseProfile": { + "$ref": "#/definitions/LicenseProfileMachineInstanceView", + "description": "Specifies the License related properties for a machine." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "The status of the hybrid machine agent.", + "enum": [ + "Connected", + "Disconnected", + "Error" + ], + "x-ms-enum": { + "name": "StatusTypes", + "modelAsString": true + } + }, + "lastStatusChange": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time of the last status change." + }, + "errorDetails": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail" + }, + "description": "Details about the error state.", + "x-ms-identifiers": [] + }, + "agentVersion": { + "readOnly": true, + "type": "string", + "description": "The hybrid machine agent full version." + }, + "vmId": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Specifies the hybrid machine unique ID." + }, + "displayName": { + "readOnly": true, + "type": "string", + "description": "Specifies the hybrid machine display name." + }, + "machineFqdn": { + "readOnly": true, + "type": "string", + "description": "Specifies the hybrid machine FQDN." + }, + "clientPublicKey": { + "type": "string", + "description": "Public Key that the client provides to be used during initial resource onboarding" + }, + "osName": { + "readOnly": true, + "type": "string", + "description": "The Operating System running on the hybrid machine." + }, + "osVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Operating System running on the hybrid machine." + }, + "osType": { + "type": "string", + "description": "The type of Operating System (windows/linux)." + }, + "vmUuid": { + "readOnly": true, + "type": "string", + "description": "Specifies the Arc Machine's unique SMBIOS ID" + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/MachineExtensionInstanceView" + }, + "description": "Machine Extensions information (deprecated field)", + "x-ms-identifiers": [] + }, + "osSku": { + "readOnly": true, + "type": "string", + "description": "Specifies the Operating System product SKU." + }, + "osEdition": { + "readOnly": true, + "type": "string", + "description": "The edition of the Operating System." + }, + "domainName": { + "readOnly": true, + "type": "string", + "description": "Specifies the Windows domain name." + }, + "adFqdn": { + "readOnly": true, + "type": "string", + "description": "Specifies the AD fully qualified display name." + }, + "dnsFqdn": { + "readOnly": true, + "type": "string", + "description": "Specifies the DNS fully qualified display name." + }, + "privateLinkScopeResourceId": { + "type": "string", + "description": "The resource id of the private link scope this machine is assigned to, if any." + }, + "parentClusterResourceId": { + "type": "string", + "description": "The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any." + }, + "mssqlDiscovered": { + "type": "string", + "description": "Specifies whether any MS SQL instance is discovered on the machine." + }, + "detectedProperties": { + "$ref": "#/definitions/DetectedProperties", + "description": "Detected properties from the machine." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Information about the network the machine is on." + } + }, + "description": "Describes the properties of a hybrid machine." + }, + "MachineUpdateProperties": { + "type": "object", + "properties": { + "locationData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/locationData" + }, + "osProfile": { + "$ref": "#/definitions/OSProfile" + }, + "cloudMetadata": { + "$ref": "#/definitions/CloudMetadata", + "description": "The metadata of the cloud environment (Azure/GCP/AWS/OCI...)." + }, + "agentUpgrade": { + "$ref": "#/definitions/AgentUpgrade", + "description": "The info of the machine w.r.t Agent Upgrade" + }, + "parentClusterResourceId": { + "type": "string", + "description": "The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any." + }, + "privateLinkScopeResourceId": { + "type": "string", + "description": "The resource id of the private link scope this machine is assigned to, if any." + } + }, + "description": "Describes the ARM updatable properties of a hybrid machine." + }, + "Machine": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MachineProperties", + "description": "Hybrid Compute Machine properties" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MachineExtension" + }, + "description": "The list of extensions affiliated to the machine" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Identity" + }, + "kind": { + "$ref": "#/definitions/ArcKindEnum" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a hybrid machine." + }, + "ArcKindEnum": { + "type": "string", + "description": "Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc.", + "enum": [ + "AVS", + "HCI", + "SCVMM", + "VMware", + "EPS", + "GCP", + "AWS" + ], + "x-ms-enum": { + "name": "ArcKindEnum ", + "modelAsString": true + } + }, + "MachineUpdate": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Identity" + }, + "kind": { + "$ref": "#/definitions/ArcKindEnum" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MachineUpdateProperties", + "description": "Hybrid Compute Machine properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a hybrid machine Update." + }, + "MachineListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Machine" + }, + "description": "The list of hybrid machines." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines." + } + }, + "required": [ + "value" + ], + "description": "The List hybrid machine operation response." + }, + "ProvisioningState": { + "readOnly": true, + "type": "string", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Accepted", + "Canceled", + "Deleted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The provisioning state, which only appears in the response." + }, + "License": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LicenseProperties", + "description": "Hybrid Compute License properties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a license in a hybrid machine." + }, + "LicenseProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state, which only appears in the response." + }, + "tenantId": { + "type": "string", + "description": "Describes the tenant id." + }, + "licenseType": { + "$ref": "#/definitions/LicenseType", + "description": "The type of the license resource." + }, + "licenseDetails": { + "$ref": "#/definitions/LicenseDetails", + "description": "Describes the properties of a License." + } + }, + "description": "Describes the properties of a License Profile." + }, + "LicenseUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LicenseUpdateProperties", + "description": "License Update properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a License Update." + }, + "LicenseUpdateProperties": { + "type": "object", + "properties": { + "licenseType": { + "$ref": "#/definitions/LicenseType", + "description": "The type of the license resource." + }, + "licenseDetails": { + "x-ms-client-flatten": true, + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/LicenseState" + }, + "target": { + "$ref": "#/definitions/LicenseTarget" + }, + "edition": { + "$ref": "#/definitions/LicenseEdition" + }, + "type": { + "$ref": "#/definitions/LicenseCoreType" + }, + "processors": { + "type": "integer", + "format": "int32", + "description": "Describes the number of processors." + } + } + } + }, + "description": "Describes the Update properties of a License Profile." + }, + "LicenseDetails": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/LicenseState" + }, + "target": { + "$ref": "#/definitions/LicenseTarget" + }, + "edition": { + "$ref": "#/definitions/LicenseEdition" + }, + "type": { + "$ref": "#/definitions/LicenseCoreType" + }, + "processors": { + "type": "integer", + "format": "int32", + "description": "Describes the number of processors." + }, + "assignedLicenses": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Describes the number of assigned licenses." + }, + "immutableId": { + "readOnly": true, + "type": "string", + "description": "Describes the immutable id." + }, + "volumeLicenseDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/VolumeLicenseDetails" + }, + "description": "A list of volume license details." + } + }, + "description": "Describes the properties of a License." + }, + "VolumeLicenseDetails": { + "type": "object", + "properties": { + "programYear": { + "type": "string", + "description": "Describes the program year the volume license is for.", + "enum": [ + "Year 1", + "Year 2", + "Year 3" + ], + "x-ms-enum": { + "name": "ProgramYear", + "modelAsString": true + } + }, + "invoiceId": { + "type": "string", + "description": "The invoice id for the volume license." + } + } + }, + "LicenseType": { + "type": "string", + "enum": [ + "ESU" + ], + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + }, + "description": "The type of the license resource." + }, + "LicenseState": { + "type": "string", + "enum": [ + "Activated", + "Deactivated" + ], + "x-ms-enum": { + "name": "LicenseState", + "modelAsString": true + }, + "description": "Describes the state of the license." + }, + "LicenseEdition": { + "type": "string", + "enum": [ + "Standard", + "Datacenter" + ], + "x-ms-enum": { + "name": "LicenseEdition", + "modelAsString": true + }, + "description": "Describes the edition of the license. The values are either Standard or Datacenter." + }, + "LicenseTarget": { + "type": "string", + "enum": [ + "Windows Server 2012", + "Windows Server 2012 R2" + ], + "x-ms-enum": { + "name": "LicenseTarget", + "modelAsString": true + }, + "description": "Describes the license target server." + }, + "LicenseCoreType": { + "type": "string", + "enum": [ + "pCore", + "vCore" + ], + "x-ms-enum": { + "name": "LicenseCoreType", + "modelAsString": true + }, + "description": "Describes the license core type (pCore or vCore)." + }, + "LicensesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/License" + }, + "description": "The list of licenses." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of license profile." + } + }, + "required": [ + "value" + ], + "description": "The List license operation response." + }, + "LicenseProfile": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "properties": { + "softwareAssurance": { + "x-ms-client-flatten": true, + "type": "object", + "properties": { + "softwareAssuranceCustomer": { + "type": "boolean", + "description": "Specifies if this machine is licensed as part of a Software Assurance agreement." + } + } + }, + "esuProfile": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LicenseProfileArmEsuProperties", + "description": "Hybrid Compute ESU Profile properties" + }, + "productProfile": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LicenseProfileArmProductProfileProperties", + "description": "Hybrid Compute Product Profile properties" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state, which only appears in the response." + } + }, + "description": "Describe the properties of a license profile." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a license profile in a hybrid machine." + }, + "LicenseProfileUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "properties": { + "softwareAssurance": { + "x-ms-client-flatten": true, + "type": "object", + "properties": { + "softwareAssuranceCustomer": { + "type": "boolean", + "description": "Specifies if this machine is licensed as part of a Software Assurance agreement." + } + } + }, + "esuProfile": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EsuProfileUpdateProperties", + "description": "Hybrid Compute ESU Profile Update properties" + }, + "productProfile": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProductProfileUpdateProperties", + "description": "Hybrid Compute Product Profile Update properties" + } + }, + "description": "Describe the Update properties of a license profile." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a License Profile Update." + }, + "LicenseProfilesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LicenseProfile" + }, + "description": "The list of license profiles." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of license profile." + } + }, + "required": [ + "value" + ], + "description": "The List hybrid machine license profile operation response." + }, + "EsuServerType": { + "type": "string", + "enum": [ + "Standard", + "Datacenter" + ], + "x-ms-enum": { + "name": "EsuServerType", + "modelAsString": true + }, + "description": "The server types for Esu." + }, + "EsuEligibility": { + "type": "string", + "enum": [ + "Eligible", + "Ineligible", + "Unknown" + ], + "x-ms-enum": { + "name": "EsuEligibility", + "modelAsString": true + }, + "description": "The ESU eligibility." + }, + "EsuKey": { + "type": "object", + "properties": { + "sku": { + "type": "string", + "description": "SKU number." + }, + "licenseStatus": { + "type": "integer", + "format": "int32", + "description": "The current status of the license profile key. Represented by the same integer value that is presented on the machine itself when querying the license key status." + } + }, + "description": "ESU key" + }, + "EsuKeyState": { + "type": "string", + "enum": [ + "Inactive", + "Active" + ], + "x-ms-enum": { + "name": "EsuKeyState", + "modelAsString": true + }, + "description": "The ESU key state." + }, + "LicenseProfileStorageModelEsuProperties": { + "type": "object", + "properties": { + "assignedLicenseImmutableId": { + "readOnly": true, + "type": "string", + "description": "The guid id of the license." + }, + "esuKeys": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/EsuKey" + }, + "description": "The list of ESU keys.", + "x-ms-identifiers": [] + } + }, + "description": "License profile storage model for ESU properties." + }, + "LicenseProfileArmEsuProperties": { + "type": "object", + "properties": { + "assignedLicense": { + "type": "string", + "description": "The resource id of the license." + } + }, + "allOf": [ + { + "$ref": "#/definitions/LicenseProfileArmEsuPropertiesWithoutAssignedLicense" + } + ], + "description": "Describes the properties of a License Profile ARM model." + }, + "LicenseProfileArmEsuPropertiesWithoutAssignedLicense": { + "type": "object", + "properties": { + "serverType": { + "readOnly": true, + "$ref": "#/definitions/EsuServerType", + "description": "The type of the Esu servers." + }, + "esuEligibility": { + "readOnly": true, + "$ref": "#/definitions/EsuEligibility", + "description": "Indicates the eligibility state of Esu." + }, + "esuKeyState": { + "readOnly": true, + "$ref": "#/definitions/EsuKeyState", + "description": "Indicates whether there is an ESU Key currently active for the machine." + } + }, + "allOf": [ + { + "$ref": "#/definitions/LicenseProfileStorageModelEsuProperties" + } + ], + "description": "Describes the properties of a License Profile ARM model." + }, + "EsuProfileUpdateProperties": { + "type": "object", + "properties": { + "assignedLicense": { + "type": "string", + "description": "The resource id of the license." + } + }, + "description": "Describes the Update properties of a ESU License Profile." + }, + "LicenseProfileSubscriptionStatusUpdate": { + "type": "string", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "LicenseProfileSubscriptionStatusUpdate", + "modelAsString": true + }, + "description": "Indicates the new subscription status of the OS or Product Features." + }, + "ProductFeatureUpdate": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Product feature name." + }, + "subscriptionStatus": { + "$ref": "#/definitions/LicenseProfileSubscriptionStatusUpdate", + "description": "Indicates the new status of the product feature." + } + }, + "description": "Product Feature" + }, + "ProductProfileUpdateProperties": { + "type": "object", + "properties": { + "subscriptionStatus": { + "$ref": "#/definitions/LicenseProfileSubscriptionStatusUpdate", + "description": "Indicates the subscription status of the product." + }, + "productType": { + "$ref": "#/definitions/LicenseProfileProductType", + "description": "Indicates the product type of the license." + }, + "productFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductFeatureUpdate" + }, + "description": "The list of product feature updates.", + "x-ms-identifiers": [] + } + }, + "description": "Describes the Update properties of a Product Profile." + }, + "LicenseProfileMachineInstanceView": { + "type": "object", + "properties": { + "licenseStatus": { + "$ref": "#/definitions/LicenseStatus", + "description": "Indicates the license status of the OS." + }, + "licenseChannel": { + "readOnly": true, + "type": "string", + "description": "Indicates the license channel." + }, + "softwareAssurance": { + "x-ms-client-flatten": true, + "type": "object", + "readOnly": true, + "properties": { + "softwareAssuranceCustomer": { + "type": "boolean", + "description": "Specifies if this machine is licensed as part of a Software Assurance agreement." + } + } + }, + "esuProfile": { + "$ref": "#/definitions/LicenseProfileMachineInstanceViewEsuProperties" + }, + "productProfile": { + "x-ms-client-flatten": true, + "readOnly": true, + "$ref": "#/definitions/LicenseProfileArmProductProfileProperties", + "description": "Hybrid Compute Product Profile properties" + } + }, + "description": "License Profile Instance View in Machine Properties." + }, + "LicenseProfileMachineInstanceViewEsuProperties": { + "type": "object", + "properties": { + "assignedLicense": { + "$ref": "#/definitions/License", + "description": "The assigned license resource." + }, + "licenseAssignmentState": { + "type": "string", + "enum": [ + "Assigned", + "NotAssigned" + ], + "description": "Describes the license assignment state (Assigned or NotAssigned).", + "x-ms-enum": { + "name": "licenseAssignmentState", + "modelAsString": true + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/LicenseProfileArmEsuPropertiesWithoutAssignedLicense" + } + ], + "description": "Properties for the Machine ESU profile." + }, + "LicenseStatus": { + "readOnly": true, + "type": "string", + "enum": [ + "Unlicensed", + "Licensed", + "OOBGrace", + "OOTGrace", + "NonGenuineGrace", + "Notification", + "ExtendedGrace" + ], + "x-ms-enum": { + "name": "LicenseStatus", + "modelAsString": true + }, + "description": "The license status." + }, + "LicenseProfileSubscriptionStatus": { + "type": "string", + "enum": [ + "Unknown", + "Enabling", + "Enabled", + "Disabled", + "Disabling", + "Failed" + ], + "x-ms-enum": { + "name": "LicenseProfileSubscriptionStatus", + "modelAsString": true + }, + "description": "Subscription status of the OS or Product feature." + }, + "LicenseProfileProductType": { + "type": "string", + "enum": [ + "WindowsServer", + "WindowsIoTEnterprise" + ], + "x-ms-enum": { + "name": "LicenseProfileProductType", + "modelAsString": true + }, + "description": "The product type of the license." + }, + "ProductFeature": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Product feature name." + }, + "subscriptionStatus": { + "$ref": "#/definitions/LicenseProfileSubscriptionStatus", + "description": "Indicates the current status of the product features." + }, + "enrollmentDate": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The timestamp in UTC when the user enrolls the feature." + }, + "billingStartDate": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The timestamp in UTC when the billing starts." + }, + "disenrollmentDate": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The timestamp in UTC when the user disenrolled the feature." + }, + "billingEndDate": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The timestamp in UTC when the billing ends." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail", + "readOnly": true, + "description": "The errors that were encountered during the feature enrollment or disenrollment." + } + }, + "description": "Product Feature" + }, + "LicenseProfileArmProductProfileProperties": { + "type": "object", + "properties": { + "subscriptionStatus": { + "$ref": "#/definitions/LicenseProfileSubscriptionStatus", + "description": "Indicates the subscription status of the product." + }, + "productType": { + "$ref": "#/definitions/LicenseProfileProductType", + "description": "Indicates the product type of the license." + }, + "enrollmentDate": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The timestamp in UTC when the user enrolls the feature." + }, + "billingStartDate": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The timestamp in UTC when the billing starts." + }, + "disenrollmentDate": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The timestamp in UTC when the user disenrolled the feature." + }, + "billingEndDate": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The timestamp in UTC when the billing ends." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail", + "readOnly": true, + "description": "The errors that were encountered during the feature enrollment or disenrollment." + }, + "productFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductFeature" + }, + "description": "The list of product features.", + "x-ms-identifiers": [] + } + }, + "description": "Describes the properties of a Product License Profile ARM model." + }, + "HotpatchEnablementStatus": { + "type": "string", + "enum": [ + "Unknown", + "PendingEvaluation", + "Disabled", + "ActionRequired", + "Enabled" + ], + "x-ms-enum": { + "name": "HotpatchEnablementStatus", + "modelAsString": true + }, + "description": "Status of hotpatch enablement or disablement." + }, + "ResourceUpdate": { + "type": "object", + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + } + }, + "MachineExtension": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MachineExtensionProperties", + "description": "Describes Machine Extension Properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a Machine Extension." + }, + "MachineExtensionUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MachineExtensionUpdateProperties", + "description": "Describes Machine Extension Update Properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a Machine Extension Update." + }, + "MachineExtensionProperties": { + "type": "object", + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "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." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "additionalProperties": {}, + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "additionalProperties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/MachineExtensionInstanceView", + "description": "The machine extension instance view." + } + }, + "description": "Describes the properties of a Machine Extension." + }, + "MachineExtensionUpdateProperties": { + "type": "object", + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "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." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "additionalProperties": {}, + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "additionalProperties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + } + }, + "description": "Describes the properties of a Machine Extension." + }, + "MachineExtensionInstanceView": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The machine extension name." + }, + "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." + }, + "status": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + } + }, + "description": "Describes the Machine Extension Instance View." + }, + "MachineExtensionsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MachineExtension" + }, + "description": "The list of extensions" + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of machine extensions. Call ListNext() with this to fetch the next page of extensions." + } + }, + "description": "Describes the Machine Extensions List Result." + }, + "TargetVersion": { + "type": "string", + "description": "Extension Upgrade Target Version." + }, + "ExtensionTargetProperties": { + "type": "object", + "properties": { + "targetVersion": { + "type": "object", + "$ref": "#/definitions/TargetVersion", + "description": "Properties for the specified Extension to Upgrade." + } + }, + "description": "Describes the Machine Extension Target Version Properties" + }, + "ExtensionTarget": { + "type": "object", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/ExtensionTargetProperties" + }, + "description": "Describes the Machine Extension Target Properties" + }, + "MachineExtensionUpgrade": { + "type": "object", + "properties": { + "extensionTargets": { + "$ref": "#/definitions/ExtensionTarget", + "description": "Describes the Extension Target Properties." + } + }, + "description": "Describes the Machine Extension Upgrade Properties." + }, + "NetworkProfile": { + "type": "object", + "readOnly": true, + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "description": "The list of network interfaces.", + "x-ms-identifiers": [] + } + }, + "description": "Describes the network information on this machine." + }, + "NetworkInterface": { + "type": "object", + "readOnly": true, + "properties": { + "ipAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/IpAddress" + }, + "description": "The list of IP addresses in this interface.", + "x-ms-identifiers": [] + } + }, + "description": "Describes a network interface." + }, + "IpAddress": { + "type": "object", + "readOnly": true, + "properties": { + "address": { + "type": "string", + "description": "Represents the IP Address." + }, + "ipAddressVersion": { + "type": "string", + "description": "Represents the Ip Address Version." + }, + "subnet": { + "type": "object", + "$ref": "#/definitions/Subnet", + "description": "The subnet to which this IP address belongs." + } + }, + "description": "Describes properties of the IP address." + }, + "Subnet": { + "type": "object", + "readOnly": true, + "properties": { + "addressPrefix": { + "type": "string", + "description": "Represents address prefix." + } + }, + "description": "Describes the subnet." + }, + "HybridIdentityMetadataList": { + "description": "List of HybridIdentityMetadata.", + "type": "object", + "properties": { + "nextLink": { + "description": "Url to follow for getting next page of HybridIdentityMetadata.", + "type": "string" + }, + "value": { + "description": "Array of HybridIdentityMetadata", + "type": "array", + "items": { + "$ref": "#/definitions/HybridIdentityMetadata" + } + } + }, + "required": [ + "value" + ] + }, + "HybridIdentityMetadata": { + "description": "Defines the HybridIdentityMetadata.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource", + "description": "The resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags." + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Resource properties.", + "$ref": "#/definitions/HybridIdentityMetadataProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "The system data." + } + }, + "x-ms-azure-resource": true + }, + "HybridIdentityMetadataProperties": { + "description": "Defines the resource properties.", + "type": "object", + "properties": { + "vmId": { + "description": "The unique identifier for the resource.", + "type": "string" + }, + "publicKey": { + "description": "The Public Key.", + "type": "string" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Identity", + "readOnly": true + } + } + }, + "AgentVersionsList": { + "type": "object", + "readOnly": true, + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentVersion" + }, + "description": "The list of available Agent Versions.", + "x-ms-identifiers": [ + "agentVersion" + ] + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next 10 available Agent Versions." + } + }, + "description": "Describes AgentVersions List." + }, + "AgentVersion": { + "type": "object", + "readOnly": true, + "properties": { + "agentVersion": { + "type": "string", + "description": "Represents the agent version." + }, + "downloadLink": { + "type": "string", + "description": "Represents the download link of specific agent version." + }, + "osType": { + "type": "string", + "description": "Defines the os type." + } + }, + "description": "Describes properties of Agent Version." + }, + "MachineAssessPatchesResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"", + "enum": [ + "Unknown", + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "assessmentActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result." + }, + "rebootPending": { + "type": "boolean", + "readOnly": true, + "description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred." + }, + "availablePatchCountByClassification": { + "$ref": "#/definitions/AvailablePatchCountByClassification", + "description": "Summarization of patches available for installation on the machine by classification." + }, + "startDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "lastModifiedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation finished." + }, + "startedBy": { + "type": "string", + "readOnly": true, + "enum": [ + "User", + "Platform" + ], + "x-ms-enum": { + "name": "PatchOperationStartedBy", + "modelAsString": true + }, + "description": "Indicates if operation was triggered by user or by platform." + }, + "patchServiceUsed": { + "type": "string", + "readOnly": true, + "enum": [ + "Unknown", + "WU", + "WU_WSUS", + "YUM", + "APT", + "Zypper" + ], + "x-ms-enum": { + "name": "PatchServiceUsed", + "modelAsString": true + }, + "description": "Specifies the patch service used for the operation." + }, + "osType": { + "type": "string", + "readOnly": true, + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true + }, + "description": "The operating system type of the machine." + }, + "errorDetails": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "Describes the properties of an AssessPatches result." + }, + "AvailablePatchCountByClassification": { + "type": "object", + "properties": { + "security": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of security patches available for installation." + }, + "critical": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of critical patches available for installation." + }, + "definition": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of definition patches available for installation." + }, + "updateRollup": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of update Rollup patches available for installation." + }, + "featurePack": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of feature pack patches available for installation." + }, + "servicePack": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of service pack patches available for installation." + }, + "tools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of tools patches available for installation." + }, + "updates": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of updates category patches available for installation." + }, + "other": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of other patches available for installation." + } + }, + "description": "Summarization of patches available for installation on the machine by classification." + }, + "MachineInstallPatchesParameters": { + "type": "object", + "properties": { + "maximumDuration": { + "type": "string", + "description": "Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours)" + }, + "rebootSetting": { + "type": "string", + "description": "Defines when it is acceptable to reboot a VM during a software update operation.", + "enum": [ + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "VMGuestPatchRebootSetting", + "modelAsString": true + } + }, + "windowsParameters": { + "$ref": "#/definitions/WindowsParameters", + "description": "Input for InstallPatches on a Windows VM, as directly received by the API" + }, + "linuxParameters": { + "$ref": "#/definitions/LinuxParameters", + "description": "Input for InstallPatches on a Linux VM, as directly received by the API" + } + }, + "required": [ + "maximumDuration", + "rebootSetting" + ], + "description": "Input for InstallPatches as directly received by the API" + }, + "WindowsParameters": { + "type": "object", + "properties": { + "classificationsToInclude": { + "type": "array", + "description": "The update classifications to select when installing patches for Windows.", + "items": { + "type": "string", + "enum": [ + "Critical", + "Security", + "UpdateRollUp", + "FeaturePack", + "ServicePack", + "Definition", + "Tools", + "Updates" + ], + "x-ms-enum": { + "name": "VMGuestPatchClassification_Windows", + "modelAsString": true + } + } + }, + "kbNumbersToInclude": { + "type": "array", + "description": "Kbs to include in the patch operation", + "items": { + "type": "string" + } + }, + "kbNumbersToExclude": { + "type": "array", + "description": "Kbs to exclude in the patch operation", + "items": { + "type": "string" + } + }, + "excludeKbsRequiringReboot": { + "type": "boolean", + "description": "Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true." + }, + "maxPatchPublishDate": { + "type": "string", + "format": "date-time", + "description": "This is used to install patches that were published on or before this given max published date." + } + }, + "description": "Input for InstallPatches on a Windows VM, as directly received by the API" + }, + "LinuxParameters": { + "type": "object", + "properties": { + "classificationsToInclude": { + "type": "array", + "description": "The update classifications to select when installing patches for Linux.", + "items": { + "type": "string", + "enum": [ + "Critical", + "Security", + "Other" + ], + "x-ms-enum": { + "name": "VMGuestPatchClassification_Linux", + "modelAsString": true + } + } + }, + "packageNameMasksToInclude": { + "type": "array", + "description": "packages to include in the patch operation. Format: packageName_packageVersion", + "items": { + "type": "string" + } + }, + "packageNameMasksToExclude": { + "type": "array", + "description": "packages to exclude in the patch operation. Format: packageName_packageVersion", + "items": { + "type": "string" + } + } + }, + "description": "Input for InstallPatches on a Linux VM, as directly received by the API" + }, + "MachineInstallPatchesResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Failed\", \"Succeeded\", \"Unknown\" or \"CompletedWithWarnings.\"", + "enum": [ + "Unknown", + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "installationActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result." + }, + "rebootStatus": { + "type": "string", + "readOnly": true, + "description": "The reboot state of the VM following completion of the operation.", + "enum": [ + "Unknown", + "NotNeeded", + "Required", + "Started", + "Failed", + "Completed" + ], + "x-ms-enum": { + "name": "VMGuestPatchRebootStatus", + "modelAsString": true + } + }, + "maintenanceWindowExceeded": { + "type": "boolean", + "readOnly": true, + "description": "Whether the operation ran out of time before it completed all its intended actions." + }, + "excludedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that were not installed due to the user blocking their installation." + }, + "notSelectedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that were detected as available for install, but did not meet the operation's criteria." + }, + "pendingPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true." + }, + "installedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches successfully installed." + }, + "failedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that could not be installed due to some issue. See errors for details." + }, + "startDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "lastModifiedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation finished." + }, + "startedBy": { + "type": "string", + "readOnly": true, + "enum": [ + "User", + "Platform" + ], + "x-ms-enum": { + "name": "PatchOperationStartedBy", + "modelAsString": true + }, + "description": "Indicates if operation was triggered by user or by platform." + }, + "patchServiceUsed": { + "type": "string", + "readOnly": true, + "enum": [ + "Unknown", + "WU", + "WU_WSUS", + "YUM", + "APT", + "Zypper" + ], + "x-ms-enum": { + "name": "PatchServiceUsed", + "modelAsString": true + }, + "description": "Specifies the patch service used for the operation." + }, + "osType": { + "type": "string", + "readOnly": true, + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true + }, + "description": "The operating system type of the machine." + }, + "errorDetails": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "The result summary of an installation operation." + }, + "MachineRunCommand": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MachineRunCommandProperties", + "description": "Describes Run Command Properties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a Run Command" + }, + "MachineRunCommandProperties": { + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/MachineRunCommandScriptSource", + "description": "The source of the run command script." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The parameters used by the script." + }, + "protectedParameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The parameters used by the script." + }, + "asyncExecution": { + "type": "boolean", + "default": false, + "description": "Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete." + }, + "runAsUser": { + "type": "string", + "description": "Specifies the user account on the machine when executing the run command." + }, + "runAsPassword": { + "type": "string", + "description": "Specifies the user account password on the machine when executing the run command.", + "x-ms-secret": true + }, + "timeoutInSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout in seconds to execute the run command." + }, + "outputBlobUri": { + "type": "string", + "description": "Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. " + }, + "errorBlobUri": { + "type": "string", + "description": "Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter." + }, + "outputBlobManagedIdentity": { + "$ref": "#/definitions/RunCommandManagedIdentity", + "description": "User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged " + }, + "errorBlobManagedIdentity": { + "$ref": "#/definitions/RunCommandManagedIdentity", + "description": "User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged " + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "readOnly": true, + "$ref": "#/definitions/MachineRunCommandInstanceView", + "description": "The machine run command instance view." + } + }, + "description": "Describes the properties of a run command." + }, + "MachineRunCommandScriptSource": { + "type": "object", + "properties": { + "script": { + "type": "string", + "description": "Specifies the script content to be executed on the machine." + }, + "scriptUri": { + "type": "string", + "description": "Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI." + }, + "commandId": { + "type": "string", + "description": "Specifies the commandId of predefined built-in script." + }, + "scriptUriManagedIdentity": { + "$ref": "#/definitions/RunCommandManagedIdentity", + "description": "User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged." + } + }, + "description": "Describes the script sources for run command. Use only one of script, scriptUri, commandId." + }, + "MachineRunCommandInstanceView": { + "type": "object", + "properties": { + "executionState": { + "type": "string", + "description": "Script execution status.", + "enum": [ + "Unknown", + "Pending", + "Running", + "Failed", + "Succeeded", + "TimedOut", + "Canceled" + ], + "x-ms-enum": { + "name": "ExecutionState", + "modelAsString": true + } + }, + "executionMessage": { + "type": "string", + "description": "Communicate script configuration errors or execution messages." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "description": "Exit code returned from script execution." + }, + "output": { + "type": "string", + "description": "Script output stream." + }, + "error": { + "type": "string", + "description": "Script error stream." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Script start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Script end time." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/ExtensionsResourceStatus" + }, + "x-ms-identifiers": [], + "description": "The status information." + } + }, + "description": "The instance view of a machine run command." + }, + "MachineRunCommandsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MachineRunCommand" + }, + "description": "The list of run commands" + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands." + } + }, + "description": "Describes the Run Commands List Result." + }, + "MachineRunCommandUpdate": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a Machine Extension Update." + }, + "RunCommandInputParameter": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "value": { + "type": "string", + "description": "The run command parameter value." + } + }, + "required": [ + "name", + "value" + ], + "description": "Describes the properties of a run command parameter." + }, + "RunCommandManagedIdentity": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided." + }, + "objectId": { + "type": "string", + "description": "Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided." + } + }, + "description": " Contains clientId or objectId (use only one, not both) of a user-assigned managed identity that has access to storage blob used in Run Command. Use an empty RunCommandManagedIdentity object in case of system-assigned identity. Make sure the Azure storage blob exists in case of scriptUri, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment with scriptUri blob and 'Storage Blob Data Contributor' for Append blobs(outputBlobUri, errorBlobUri). In case of user assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged." + }, + "ExtensionsResourceStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "ExtensionsStatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "type": "object", + "description": "Instance view status." + }, + "Gateway": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GatewayProperties", + "description": "Hybrid Compute Gateway properties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes an Arc Gateway." + }, + "GatewayProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state, which only appears in the response.", + "readOnly": true + }, + "gatewayId": { + "type": "string", + "description": "A unique, immutable, identifier for the Gateway.", + "readOnly": true + }, + "gatewayType": { + "$ref": "#/definitions/GatewayType", + "description": "The type of the Gateway resource." + }, + "gatewayEndpoint": { + "type": "string", + "description": "The endpoint fqdn for the Gateway.", + "readOnly": true + }, + "allowedFeatures": { + "type": "array", + "description": "Specifies the list of features that are enabled for this Gateway.", + "items": { + "type": "string" + } + } + }, + "description": "Describes the properties of a Gateway Profile." + }, + "GatewayType": { + "type": "string", + "enum": [ + "Public" + ], + "x-ms-enum": { + "name": "GatewayType", + "modelAsString": true + }, + "description": "The type of the Gateway resource." + }, + "GatewayUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GatewayUpdateProperties", + "description": "Gateway Update properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a License Update." + }, + "GatewayUpdateProperties": { + "type": "object", + "properties": { + "allowedFeatures": { + "type": "array", + "description": "Specifies the list of features that are enabled for this Gateway.", + "items": { + "type": "string" + } + } + }, + "description": "Describes the Update properties of a Gateway Profile." + }, + "GatewaysListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Gateway" + }, + "description": "The list of Gateways." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Gateways. Call ListNext() with this URI to fetch the next page of Gateways." + } + }, + "required": [ + "value" + ], + "description": "The List license operation response." + }, + "Settings": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SettingsProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SettingsProperties": { + "type": "object", + "description": "Settings properties", + "properties": { + "tenantId": { + "type": "string", + "readOnly": true, + "description": "Azure resource tenant Id" + }, + "gatewayProperties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SettingsGatewayProperties" + } + } + }, + "SettingsGatewayProperties": { + "type": "object", + "description": "Settings Gateway properties", + "properties": { + "gatewayResourceId": { + "type": "string", + "description": "Associated Gateway Resource Id", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.HybridCompute/gateways" + } + ] + } + } + } + } + }, + "parameters": { + "machineNameParameter": { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]+", + "description": "The name of the hybrid machine.", + "x-ms-parameter-location": "method" + }, + "licenseProfileNameParameter": { + "name": "licenseProfileName", + "in": "path", + "description": "The name of the license profile.", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]+", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method", + "x-ms-enum": { + "name": "LicenseProfileName", + "modelAsString": false + } + }, + "licenseNameParameter": { + "name": "licenseName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]+", + "description": "The name of the license.", + "x-ms-parameter-location": "method" + }, + "gatewayNameParameter": { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]+", + "description": "The name of the Gateway.", + "x-ms-parameter-location": "method" + }, + "runCommandNameParameter": { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]+", + "description": "The name of the run command.", + "x-ms-parameter-location": "method" + }, + "baseProviderParameter": { + "name": "baseProvider", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]+", + "description": "The name of the base Resource Provider.", + "x-ms-parameter-location": "method" + }, + "baseResourceTypeParameter": { + "name": "baseResourceType", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]+", + "description": "The name of the base Resource Type.", + "x-ms-parameter-location": "method" + }, + "baseResourceNameParameter": { + "name": "baseResourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]+", + "description": "The name of the base resource.", + "x-ms-parameter-location": "method" + }, + "settingsResourceNameParameter": { + "name": "settingsResourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "default", + "description": "The name of the settings resource.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/AgentVersion_GetLatest.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/AgentVersion_GetLatest.json new file mode 100644 index 000000000000..ecd5a325efd2 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/AgentVersion_GetLatest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "osType": "myOsType", + "version": "1.27", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "agentVersion": "1.27", + "downloadLink": "https://download.microsoft.com/download/8/4/5/845d5e04-bb09-4ed2-9ca8-bb51184cddc9/AzureConnectedMachineAgent.msi", + "osType": "myOsType" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/AgentVersions_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/AgentVersions_Get.json new file mode 100644 index 000000000000..5791929155e9 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/AgentVersions_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "osType": "myOsType", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "agentVersion": "1.26", + "downloadLink": "https://download.microsoft.com/download/8/4/5/845d5e04-bb09-4ed2-9ca8-bb51184cddc9/AzureConnectedMachineAgent.msi", + "osType": "myOsType" + }, + { + "agentVersion": "1.27", + "downloadLink": "https://download.microsoft.com/download/8/4/5/845d5e04-bb09-4ed2-9ca8-bb51184cddc9/AzureConnectedMachineAgent.msi", + "osType": "myOsType" + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/HybridIdentityMetadata_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/HybridIdentityMetadata_Get.json new file mode 100644 index 000000000000..bcdeea429bbd --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/HybridIdentityMetadata_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "testrg", + "machineName": "ContosoVm", + "metadataName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/ContosoVm/hybridIdentityMetadata/default", + "name": "testItem", + "type": "Microsoft.HybridCompute/machines/hybridIdentityMetadata", + "properties": { + "vmId": "f8b82dff-38ef-4220-99ef-d3a3f86ddc6c", + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2", + "identity": { + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d", + "type": "SystemAssigned" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/HybridIdentityMetadata_ListByVirtualMachines.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/HybridIdentityMetadata_ListByVirtualMachines.json new file mode 100644 index 000000000000..bac519f382f6 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/HybridIdentityMetadata_ListByVirtualMachines.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "testrg", + "machineName": "ContosoVm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/ContosoVm/hybridIdentityMetadata/default", + "name": "testItem", + "type": "Microsoft.HybridCompute/machines/hybridIdentityMetadata", + "properties": { + "vmId": "f8b82dff-38ef-4220-99ef-d3a3f86ddc6c", + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2", + "identity": { + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d", + "type": "SystemAssigned" + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/NetworkProfile_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/NetworkProfile_Get.json new file mode 100644 index 000000000000..cec0e0a7231d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/NetworkProfile_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "networkInterfaces": [ + { + "ipAddresses": [ + { + "address": "192.168.12.345", + "ipAddressVersion": "IPv4", + "subnet": { + "addressPrefix": "192.168.12.0/24" + } + } + ] + }, + { + "ipAddresses": [ + { + "address": "1001:0:34aa:5000:1234:aaaa:bbbb:cccc", + "ipAddressVersion": "IPv6", + "subnet": { + "addressPrefix": "1001:0:34aa:5000::/64" + } + } + ] + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/Operations_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/Operations_List.json new file mode 100644 index 000000000000..c176ad20fcb9 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/Operations_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "origin": "user,system", + "name": "Microsoft.HybridCompute/operations/read", + "display": { + "operation": "Read all Operations", + "resource": "Microsoft.HybridCompute Resource Provider", + "description": "Read all Operations for Azure Arc for Servers", + "provider": "Microsoft HybridCompute" + }, + "isDataAction": true + }, + { + "origin": "user,system", + "name": "Microsoft.HybridCompute/register/action", + "display": { + "operation": "Register Subscription for Azure Arc for Servers", + "resource": "Microsoft.HybridCompute Resource Provider", + "description": "Registers the subscription for the Microsoft.HybridCompute Resource Provider", + "provider": "Microsoft HybridCompute" + }, + "isDataAction": true + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/ExtensionMetadata_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/ExtensionMetadata_Get.json new file mode 100644 index 000000000000..777f9d17d591 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/ExtensionMetadata_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "location": "EastUS", + "publisher": "microsoft.azure.monitor", + "extensionType": "azuremonitorlinuxagent", + "version": "1.9.1", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.HybridCompute/locations/eastus/publishers/microsoft.azure.monitor/extensionTypes/azuremonitorlinuxagent/versions/1.9.1", + "properties": { + "version": "1.9.1", + "extensionType": "azuremonitorlinuxagent", + "publisher": "microsoft.azure.monitor" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/ExtensionMetadata_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/ExtensionMetadata_List.json new file mode 100644 index 000000000000..9476dd0f7303 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/ExtensionMetadata_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "location": "EastUS", + "publisher": "microsoft.azure.monitor", + "extensionType": "azuremonitorlinuxagent", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "1.9.1", + "extensionType": "azuremonitorlinuxagent", + "publisher": "microsoft.azure.monitor" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.HybridCompute/locations/eastus/publishers/microsoft.azure.monitor/extensionTypes/azuremonitorlinuxagent/versions/1.9.1" + }, + { + "properties": { + "version": "1.9.2", + "extensionType": "azuremonitorlinuxagent", + "publisher": "microsoft.azure.monitor" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.HybridCompute/locations/eastus/publishers/microsoft.azure.monitor/extensionTypes/azuremonitorlinuxagent/versions/1.9.2" + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_CreateOrUpdate.json new file mode 100644 index 000000000000..8dc62e866c15 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_CreateOrUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "CustomScriptExtension", + "api-version": "2024-05-20-preview", + "extensionParameters": { + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "type": "CustomScriptExtension", + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.HybridCompute/machines/extensions", + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + }, + "protectedSettings": {}, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2020-08-08T20:42:10.999Z" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_Delete.json new file mode 100644 index 000000000000..f44c8dd55f9d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "MMA", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + }, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_Get.json new file mode 100644 index 000000000000..2840ffd246c5 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "CustomScriptExtension", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.HybridCompute/machines/extensions", + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + }, + "protectedSettings": {}, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_List.json new file mode 100644 index 000000000000..232f1438d7f3 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_List.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "location": "eastus2euap", + "type": "Microsoft.HybridCompute/machines/extensions", + "properties": { + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + }, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "formattedMessage: Finished executing command, StdOut: , StdErr: ", + "time": "2020-08-13T17:18:57.405Z" + } + } + } + }, + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/winosupdateextension", + "name": "winosupdateextension", + "location": "eastus2euap", + "type": "Microsoft.HybridCompute/machines/extensions", + "properties": { + "publisher": "microsoft.softwareupdatemanagement.test", + "type": "windowsosupdateextension", + "typeHandlerVersion": "1.0.0.0", + "autoUpgradeMinorVersion": false, + "settings": {}, + "provisioningState": "Creating", + "instanceView": { + "name": "winosupdateextension", + "type": "windowsosupdateextension", + "typeHandlerVersion": "1.0.0.0", + "status": {} + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_Update.json new file mode 100644 index 000000000000..eacdc2e5c68b --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extension_Update.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "CustomScriptExtension", + "api-version": "2024-05-20-preview", + "extensionParameters": { + "properties": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "enableAutomaticUpgrade": true, + "type": "CustomScriptExtension", + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -lt 100 }\"" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.HybridCompute/machines/extensions", + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "enableAutomaticUpgrade": true, + "autoUpgradeMinorVersion": false, + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + }, + "protectedSettings": {}, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2020-01-08T20:42:10.999Z" + } + } + } + } + }, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extensions_Upgrade.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extensions_Upgrade.json new file mode 100644 index 000000000000..65251c90a986 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/extension/Extensions_Upgrade.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2024-05-20-preview", + "extensionUpgradeParameters": { + "extensionTargets": { + "Microsoft.Compute.CustomScriptExtension": { + "targetVersion": "1.10" + }, + "Microsoft.Azure.Monitoring": { + "targetVersion": "2.0" + } + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_CreateOrUpdate.json new file mode 100644 index 000000000000..4e507125ea0c --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_CreateOrUpdate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "ffd506c8-3415-42d3-9612-fdb423fb17df", + "resourceGroupName": "myResourceGroup", + "gatewayName": "{gatewayName}", + "api-version": "2024-05-20-preview", + "parameters": { + "location": "eastus2euap", + "properties": { + "gatewayType": "Public", + "allowedFeatures": [ + "*" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffd506c8-3415-42d3-9612-fdb423fb17df/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/gateways/{gatewayName}", + "name": "{gatewayName}", + "type": "Microsoft.HybridCompute/gateways", + "location": "eastus2euap", + "tags": null, + "properties": { + "provisioningState": "Succeeded", + "gatewayId": "", + "gatewayType": "Public", + "gatewayEndpoint": "https://uniqueValue.contoso.com", + "allowedFeatures": [ + "*" + ] + } + } + }, + "201": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + }, + "body": { + "id": "/subscriptions/ffd506c8-3415-42d3-9612-fdb423fb17df/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/gateways/{gatewayName}", + "name": "{gatewayName}", + "type": "Microsoft.HybridCompute/gateways", + "location": "eastus2euap", + "tags": null, + "properties": { + "provisioningState": "Creating", + "gatewayId": "", + "gatewayType": "Public", + "gatewayEndpoint": "https://uniqueValue.contoso.com", + "allowedFeatures": [ + "*" + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_Delete.json new file mode 100644 index 000000000000..86410171dd2e --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "ffd506c8-3415-42d3-9612-fdb423fb17df", + "resourceGroupName": "myResourceGroup", + "gatewayName": "{gatewayName}", + "api-version": "2024-05-20-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + }, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_Get.json new file mode 100644 index 000000000000..d67aab0eabb3 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "ffd506c8-3415-42d3-9612-fdb423fb17df", + "resourceGroupName": "myResourceGroup", + "gatewayName": "{gatewayName}", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffd506c8-3415-42d3-9612-fdb423fb17df/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/gateways/{gatewayName}", + "name": "{gatewayName}", + "type": "Microsoft.HybridCompute/gateways", + "location": "eastus2euap", + "tags": null, + "properties": { + "provisioningState": "Succeeded", + "gatewayId": "", + "gatewayType": "Public", + "gatewayEndpoint": "https://uniqueValue.contoso.com", + "allowedFeatures": [ + "*" + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_ListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_ListByResourceGroup.json new file mode 100644 index 000000000000..891e4750fc20 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_ListByResourceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "ffd506c8-3415-42d3-9612-fdb423fb17df", + "resourceGroupName": "myResourceGroup", + "gatewayName": "{gatewayName}", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffd506c8-3415-42d3-9612-fdb423fb17df/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/gateways/{gatewayName}", + "name": "{gatewayName}", + "type": "Microsoft.HybridCompute/gateways", + "location": "eastus2euap", + "tags": null, + "properties": { + "provisioningState": "Succeeded", + "gatewayId": "", + "gatewayType": "Public", + "gatewayEndpoint": "https://uniqueValue.contoso.com", + "allowedFeatures": [ + "*" + ] + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_ListBySubscription.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_ListBySubscription.json new file mode 100644 index 000000000000..9b7a97576b63 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_ListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "ffd506c8-3415-42d3-9612-fdb423fb17df", + "gatewayName": "{gatewayName}", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffd506c8-3415-42d3-9612-fdb423fb17df/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/gateways/{gatewayName}", + "name": "{gatewayName}", + "type": "Microsoft.HybridCompute/gateways", + "location": "eastus2euap", + "tags": null, + "properties": { + "provisioningState": "Succeeded", + "gatewayId": "", + "gatewayType": "Public", + "gatewayEndpoint": "https://uniqueValue.contoso.com", + "allowedFeatures": [ + "*" + ] + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_Update.json new file mode 100644 index 000000000000..fbcba389f060 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/gateway/Gateway_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "ffd506c8-3415-42d3-9612-fdb423fb17df", + "resourceGroupName": "myResourceGroup", + "gatewayName": "{gatewayName}", + "api-version": "2024-05-20-preview", + "parameters": { + "properties": { + "allowedFeatures": [ + "*" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffd506c8-3415-42d3-9612-fdb423fb17df/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/gateways/{gatewayName}", + "name": "{gatewayName}", + "type": "Microsoft.HybridCompute/gateways", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "gatewayId": "", + "gatewayType": "Public", + "gatewayEndpoint": "https://uniqueValue.contoso.com", + "allowedFeatures": [ + "*" + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_CreateOrUpdate.json new file mode 100644 index 000000000000..a9e11e0af1f2 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_CreateOrUpdate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "licenseName": "{licenseName}", + "api-version": "2024-05-20-preview", + "parameters": { + "location": "eastus2euap", + "properties": { + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "tags": null, + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 2, + "immutableId": "" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_Delete.json new file mode 100644 index 000000000000..289967df9091 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "licenseName": "{licenseName}", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_Get.json new file mode 100644 index 000000000000..447db0feecee --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "licenseName": "{licenseName}", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "tags": null, + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 8, + "immutableId": "" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_ListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_ListByResourceGroup.json new file mode 100644 index 000000000000..5818b084856f --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_ListByResourceGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "licenseName": "{licenseName}", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "tags": null, + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 8, + "immutableId": "" + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_ListBySubscription.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_ListBySubscription.json new file mode 100644 index 000000000000..71b2c9878fb5 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_ListBySubscription.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "licenseName": "{licenseName}", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "tags": null, + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 8, + "immutableId": "" + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_Update.json new file mode 100644 index 000000000000..df4de7887c7c --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "licenseName": "{licenseName}", + "api-version": "2024-05-20-preview", + "parameters": { + "properties": { + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 8, + "immutableId": "" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_ValidateLicense.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_ValidateLicense.json new file mode 100644 index 000000000000..ee06db26ffd3 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/license/License_ValidateLicense.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "licenseName": "{licenseName}", + "api-version": "2024-05-20-preview", + "parameters": { + "location": "eastus2euap", + "properties": { + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/Licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "tags": null, + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 2, + "immutableId": "" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_CreateOrUpdate.json new file mode 100644 index 000000000000..89ccdf983071 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_CreateOrUpdate.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "licenseProfileName": "default", + "api-version": "2024-05-20-preview", + "parameters": { + "location": "eastus2euap", + "properties": { + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "assignedLicense": "{LicenseResourceId}" + }, + "productProfile": { + "subscriptionStatus": "Enabled", + "productType": "WindowsServer", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabled" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/licenseProfiles/default", + "name": "default", + "type": "Microsoft.HybridCompute/machines/licenseProfiles", + "location": "eastus2euap", + "tags": null, + "properties": { + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "assignedLicense": "{LicenseResourceId}", + "assignedLicenseImmutableId": "{Guid}", + "esuEligibility": "Eligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabling", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabling", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + } + } + }, + "201": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + }, + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/licenseProfiles/default", + "name": "default", + "type": "Microsoft.HybridCompute/machines/licenseProfiles", + "location": "eastus2euap", + "properties": { + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "assignedLicense": "{LicenseResourceId}", + "esuEligibility": "Eligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabling", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabling", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_Delete.json new file mode 100644 index 000000000000..90585a33747e --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "licenseProfileName": "default", + "api-version": "2024-05-20-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + }, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_Get.json new file mode 100644 index 000000000000..46c3d0ec63fc --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "licenseProfileName": "default", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/licenseProfiles/default", + "name": "default", + "type": "Microsoft.HybridCompute/machines/licenseProfiles", + "location": "eastus2euap", + "tags": null, + "properties": { + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "assignedLicense": "{LicenseResourceId}", + "esuEligibility": "Eligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabled", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabled", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_List.json new file mode 100644 index 000000000000..969d59137cac --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_List.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "licenseProfileName": "default", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/licenseProfiles/default", + "name": "default", + "type": "Microsoft.HybridCompute/machines/licenseProfiles", + "location": "eastus2euap", + "tags": null, + "properties": { + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "assignedLicense": "{LicenseResourceId}", + "esuEligibility": "Eligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabled", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabled", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_Update.json new file mode 100644 index 000000000000..975e11e5a06d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/licenseProfile/LicenseProfile_Update.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "licenseProfileName": "default", + "api-version": "2024-05-20-preview", + "parameters": { + "properties": { + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "assignedLicense": "{LicenseResourceId}" + }, + "productProfile": { + "subscriptionStatus": "Enable", + "productType": "WindowsServer", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enable" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/licenseProfiles/default", + "name": "default", + "type": "Microsoft.HybridCompute/machines/licenseProfiles", + "location": "eastus2euap", + "properties": { + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "assignedLicense": "{LicenseResourceId}", + "esuEligibility": "Eligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabling", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabling", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + } + } + }, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machine_AssessPatches.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machine_AssessPatches.json new file mode 100644 index 000000000000..2cc7de5ec674 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machine_AssessPatches.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroupName", + "name": "myMachineName", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968", + "rebootPending": true, + "startDateTime": "2021-08-22T02:15:20.9340000Z", + "lastModifiedDateTime": "2021-08-22T02:16:06.9740000Z", + "availablePatchCountByClassification": { + "security": 0, + "updateRollup": 1, + "featurePack": 0, + "servicePack": 0, + "definition": 0, + "critical": 0, + "updates": 1, + "tools": 0 + }, + "startedBy": "User", + "osType": "Windows", + "errorDetails": null + } + }, + "202": { + "headers": { + "Location": "eastus2euap" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machine_InstallPatches.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machine_InstallPatches.json new file mode 100644 index 000000000000..2917c3f34dd1 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machine_InstallPatches.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroupName", + "name": "myMachineName", + "api-version": "2024-05-20-preview", + "installPatchesInput": { + "maximumDuration": "PT4H", + "rebootSetting": "IfRequired", + "windowsParameters": { + "classificationsToInclude": [ + "Critical", + "Security" + ], + "maxPatchPublishDate": "2021-08-19T02:36:43.0539904+00:00" + } + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "installationActivityId": "68f8b292-dfc2-4646-9781-33cc88631968", + "rebootStatus": "Completed", + "maintenanceWindowExceeded": false, + "excludedPatchCount": 0, + "notSelectedPatchCount": 0, + "pendingPatchCount": 2, + "installedPatchCount": 3, + "failedPatchCount": 0, + "startDateTime": "2021-08-22T02:15:06.9740000Z", + "lastModifiedDateTime": "2021-08-22T02:16:06.9740000Z", + "startedBy": "User", + "osType": "Windows", + "errorDetails": null + } + }, + "202": { + "headers": { + "Location": "eastus2euap" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_CreateOrUpdate.json new file mode 100644 index 000000000000..3e199cf8cbce --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_CreateOrUpdate.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2024-05-20-preview", + "parameters": { + "location": "eastus2euap", + "properties": { + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "osProfile": { + "windowsConfiguration": { + "patchSettings": { + "enableHotpatching": true + } + } + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "osEdition": "Standard", + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null, + "enableHotpatching": true, + "status": { + "hotpatchEnablementStatus": "PendingEvaluation", + "error": null + } + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "licenseStatus": "Licensed", + "licenseChannel": "PSG", + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabled", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabled", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond", + "city": "redmond", + "district": null, + "countryOrRegion": "usa" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Delete.json new file mode 100644 index 000000000000..daccef1140e2 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Get.json new file mode 100644 index 000000000000..05518c4eb3eb --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Get.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "osEdition": "Standard", + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null, + "enableHotpatching": true, + "status": { + "hotpatchEnablementStatus": "Enabled", + "error": null + } + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "licenseStatus": "Licensed", + "licenseChannel": "PSG", + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabled", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabled", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond", + "city": "redmond", + "district": null, + "countryOrRegion": "usa" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "agentConfiguration": { + "proxyUrl": "https://test.test", + "incomingConnectionsPorts": [ + "22", + "23" + ], + "extensionsAllowList": null, + "extensionsBlockList": null, + "proxyBypass": [ + "proxy1", + "proxy2" + ], + "extensionsEnabled": "true", + "guestConfigurationEnabled": "true", + "configMode": "full" + }, + "serviceStatuses": { + "extensionService": { + "status": "Running", + "startupType": "Automatic" + }, + "guestConfigurationService": { + "status": "Running", + "startupType": "Automatic" + } + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "networkProfile": { + "networkInterfaces": [ + { + "ipAddresses": [ + { + "address": "192.168.12.345", + "ipAddressVersion": "IPv4", + "subnet": { + "addressPrefix": "192.168.12.0/24" + } + } + ] + }, + { + "ipAddresses": [ + { + "address": "1001:0:34aa:5000:1234:aaaa:bbbb:cccc", + "ipAddressVersion": "IPv6", + "subnet": { + "addressPrefix": "1001:0:34aa:5000::/64" + } + } + ] + } + ] + } + }, + "resources": [] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Get_LicenseProfileInstanceView.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Get_LicenseProfileInstanceView.json new file mode 100644 index 000000000000..cac13f9248d6 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Get_LicenseProfileInstanceView.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "$expand": "instanceView", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "osEdition": "Standard", + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null, + "enableHotpatching": true, + "status": { + "hotpatchEnablementStatus": "Enabled", + "error": null + } + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "licenseStatus": "Licensed", + "licenseChannel": "PSG", + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "assignedLicense": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "tags": null, + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 8, + "immutableId": "" + } + } + }, + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabled", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabled", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond", + "city": "redmond", + "district": null, + "countryOrRegion": "usa" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "agentConfiguration": { + "proxyUrl": "https://test.test", + "incomingConnectionsPorts": [ + "22", + "23" + ], + "extensionsAllowList": null, + "extensionsBlockList": null, + "proxyBypass": [ + "proxy1", + "proxy2" + ], + "extensionsEnabled": "true", + "guestConfigurationEnabled": "true", + "configMode": "full" + }, + "serviceStatuses": { + "extensionService": { + "status": "Running", + "startupType": "Automatic" + }, + "guestConfigurationService": { + "status": "Running", + "startupType": "Automatic" + } + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "networkProfile": { + "networkInterfaces": [ + { + "ipAddresses": [ + { + "address": "192.168.12.345", + "ipAddressVersion": "IPv4", + "subnet": { + "addressPrefix": "192.168.12.0/24" + } + } + ] + }, + { + "ipAddresses": [ + { + "address": "1001:0:34aa:5000:1234:aaaa:bbbb:cccc", + "ipAddressVersion": "IPv6", + "subnet": { + "addressPrefix": "1001:0:34aa:5000::/64" + } + } + ] + } + ] + } + }, + "resources": [] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_ListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_ListByResourceGroup.json new file mode 100644 index 000000000000..0c0f71d04e04 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_ListByResourceGroup.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "f7a068cc-b0b8-46e8-a203-22f301a62a8f", + "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "osEdition": "Standard", + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null, + "enableHotpatching": true, + "status": { + "hotpatchEnablementStatus": "Enabled", + "error": null + } + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "licenseStatus": "Licensed", + "licenseChannel": "PSG", + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabled", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabled", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": null, + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "agentConfiguration": { + "proxyUrl": "https://test.test", + "incomingConnectionsPorts": [ + "22", + "23" + ], + "extensionsAllowList": null, + "extensionsBlockList": null, + "proxyBypass": [ + "proxy1", + "proxy2" + ], + "extensionsEnabled": "true", + "guestConfigurationEnabled": "true", + "configMode": "full" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine2", + "name": "myMachine2", + "location": "westus2", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "e7a068cc-b0b8-46e8-a203-22f301a62a8f", + "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "osEdition": "Standard", + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null, + "enableHotpatching": true, + "status": { + "hotpatchEnablementStatus": "Enabled", + "error": null + } + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "licenseStatus": "Licensed", + "licenseChannel": "PSG", + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabled", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabled", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + }, + "vmId": "a4a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "true", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Surfacebook" + }, + "agentConfiguration": { + "proxyUrl": "https://test.test", + "incomingConnectionsPorts": [ + "22", + "23" + ], + "extensionsAllowList": null, + "extensionsBlockList": null, + "proxyBypass": [ + "proxy1", + "proxy2" + ], + "extensionsEnabled": "true", + "guestConfigurationEnabled": "true", + "configMode": "full" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_ListBySubscription.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_ListBySubscription.json new file mode 100644 index 000000000000..9435c16b55f8 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_ListBySubscription.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "osEdition": "Standard", + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null, + "enableHotpatching": true, + "status": { + "hotpatchEnablementStatus": "Enabled", + "error": null + } + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "licenseStatus": "Licensed", + "licenseChannel": "PSG", + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabled", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabled", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": null, + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "agentConfiguration": { + "proxyUrl": "https://test.test", + "incomingConnectionsPorts": [ + "22", + "23" + ], + "extensionsAllowList": null, + "extensionsBlockList": null, + "proxyBypass": [ + "proxy1", + "proxy2" + ], + "extensionsEnabled": "true", + "guestConfigurationEnabled": "true", + "configMode": "full" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + }, + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup2/providers/Microsoft.HybridCompute/machines/myMachine2", + "name": "myMachine2", + "location": "westus2", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "e7a068cc-b0b8-46e8-a203-22f301a62a8f", + "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "osEdition": "Standard", + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null, + "enableHotpatching": true, + "status": { + "hotpatchEnablementStatus": "Enabled", + "error": null + } + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "licenseStatus": "Licensed", + "licenseChannel": "PSG", + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabled", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabled", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + }, + "vmId": "a4a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "true", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Surfacebook" + }, + "agentConfiguration": { + "proxyUrl": "https://test.test", + "incomingConnectionsPorts": [ + "22", + "23" + ], + "extensionsAllowList": null, + "extensionsBlockList": null, + "proxyBypass": [ + "proxy1", + "proxy2" + ], + "extensionsEnabled": "true", + "guestConfigurationEnabled": "true", + "configMode": "full" + } + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Update.json new file mode 100644 index 000000000000..8b001ef57ba9 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/machine/Machines_Update.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2024-05-20-preview", + "location": "eastus2euap", + "kind": null, + "parameters": { + "properties": { + "locationData": { + "name": "Redmond" + }, + "osProfile": { + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": "ImageDefault", + "patchMode": "AutomaticByPlatform", + "enableHotpatching": true + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": "ImageDefault", + "patchMode": "Manual" + } + } + }, + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "osEdition": "Standard", + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": "ImageDefault", + "patchMode": "AutomaticByPlatform", + "enableHotpatching": true, + "status": { + "hotpatchEnablementStatus": "PendingEvaluation", + "error": null + } + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": "ImageDefault", + "patchMode": "Manual" + } + } + }, + "licenseProfile": { + "licenseStatus": "Licensed", + "licenseChannel": "PSG", + "softwareAssurance": { + "softwareAssuranceCustomer": true + }, + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": 1 + }, + { + "sku": "skuNumber2", + "licenseStatus": 1 + } + ] + }, + "productProfile": { + "subscriptionStatus": "Enabled", + "productType": "WindowsServer", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z", + "productFeatures": [ + { + "name": "Hotpatch", + "subscriptionStatus": "Enabled", + "enrollmentDate": "2023-10-05T20:36:49.745Z", + "billingStartDate": "2023-10-05T20:36:49.745Z", + "disenrollmentDate": "2023-11-05T20:36:49.745Z", + "billingEndDate": "2023-11-05T20:36:49.745Z" + } + ] + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "detectedProperties": null, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsCreate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsCreate.json new file mode 100644 index 000000000000..3541689eff61 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsCreate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "resourceUri": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2024-05-20-preview", + "name": "current", + "parameters": { + "properties": { + "location": "westus", + "networkConfigurationScopeResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/privateLinkScopes/testScope" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridCompute/networkConfigurations/current", + "name": "current", + "type": "Microsoft.HybridCompute/networkConfigurations", + "properties": { + "location": "westus", + "tenantId": "00000000-1111-2222-3333-444444444444", + "networkConfigurationScopeId": "00000000-1111-2222-3333-444444444444", + "networkConfigurationScopeResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/privateLinkScopes/testScope", + "keyProperties": { + "clientPublicKey": { + "publicKey": "62617365363420656e636f646564207075626c6963206b6579", + "notAfter": "2021-01-01T00:00:00Z", + "renewAfter": "2021-02-01T00:00:00Z" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridCompute/networkConfigurations/current", + "name": "current", + "type": "Microsoft.HybridCompute/networkConfigurations", + "properties": { + "location": "westus", + "tenantId": "00000000-1111-2222-3333-444444444444", + "networkConfigurationScopeId": "00000000-1111-2222-3333-444444444444", + "networkConfigurationScopeResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/privateLinkScopes/testScope", + "keyProperties": { + "clientPublicKey": { + "publicKey": "62617365363420656e636f646564207075626c6963206b6579", + "notAfter": "2021-01-01T00:00:00Z", + "renewAfter": "2021-02-01T00:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsGet.json new file mode 100644 index 000000000000..1440df18553d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceUri": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridCompute/networkConfigurations/current", + "name": "current", + "type": "Microsoft.HybridCompute/networkConfigurations", + "properties": { + "tenantId": "default", + "location": "westus", + "networkConfigurationScopeId": "00000000-1111-2222-3333-444444444444", + "networkConfigurationScopeResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/privateLinkScopes/testScope", + "keyProperties": { + "clientPublicKey": { + "publicKey": "62617365363420656e636f646564207075626c6963206b6579", + "notAfter": "2021-01-01T00:00:00Z", + "renewAfter": "2021-02-01T00:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsPatch.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsPatch.json new file mode 100644 index 000000000000..73b7ad83590a --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsPatch.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceUri": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2024-05-20-preview", + "name": "current", + "parameters": { + "properties": { + "networkConfigurationScopeResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/privateLinkScopes/newScope" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridCompute/networkConfigurations/current", + "name": "current", + "type": "Microsoft.HybridCompute/networkConfigurations", + "properties": { + "location": "westus", + "tenantId": "00000000-1111-2222-3333-444444444444", + "networkConfigurationScopeId": "00000000-1111-2222-3333-444444444444", + "networkConfigurationScopeResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/privateLinkScopes/newScope", + "keyProperties": { + "clientPublicKey": { + "publicKey": "publickey", + "notAfter": "2021-01-01T00:00:00Z", + "renewAfter": "2021-02-01T00:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsUpdate.json new file mode 100644 index 000000000000..c1499740dd36 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkConfiguration/NetworkConfigurationsUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "resourceUri": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2024-05-20-preview", + "name": "current", + "parameters": { + "properties": { + "networkConfigurationScopeResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/privateLinkScopes/newScope" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridCompute/networkConfigurations/current", + "name": "current", + "type": "Microsoft.HybridCompute/networkConfigurations", + "properties": { + "location": "westus", + "tenantId": "00000000-1111-2222-3333-444444444444", + "networkConfigurationScopeId": "00000000-1111-2222-3333-444444444444", + "networkConfigurationScopeResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/privateLinkScopes/newScope", + "keyProperties": { + "clientPublicKey": { + "publicKey": "publickey", + "notAfter": "2021-01-01T00:00:00Z", + "renewAfter": "2021-02-01T00:00:00Z" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridCompute/networkConfigurations/current", + "name": "current", + "type": "Microsoft.HybridCompute/networkConfigurations", + "properties": { + "location": "westus", + "tenantId": "00000000-1111-2222-3333-444444444444", + "networkConfigurationScopeId": "00000000-1111-2222-3333-444444444444", + "networkConfigurationScopeResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/privateLinkScopes/newScope", + "keyProperties": { + "clientPublicKey": { + "publicKey": "publickey", + "notAfter": "2021-01-01T00:00:00Z", + "renewAfter": "2021-02-01T00:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationGet.json new file mode 100644 index 000000000000..9c856b3c0c28 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "perimeterName": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.myAssociation" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/my-resource-group/providers/Microsoft.HybridCompute/privateLinkScopes/my-privatelinkscope/networkSecurityPerimeterConfigurations/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.myAssociation", + "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.myAssociation", + "type": "Microsoft.HybridCompute/privateLinkScopes/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Accepted", + "provisioningIssues": [], + "networkSecurityPerimeter": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/networkSecurityPerimeters/myPerimeter", + "perimeterGuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "location": "westus" + }, + "resourceAssociation": { + "name": "myAssociation", + "accessMode": "enforced" + }, + "profile": { + "name": "myProfile", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "myAccessRule", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24", + "..." + ] + } + } + ], + "diagnosticSettingsVersion": 1, + "enabledLogCategories": [] + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationList.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationList.json new file mode 100644 index 000000000000..813fe0cfd930 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/my-resource-group/providers/Microsoft.HybridCompute/privateLinkScopes/my-privatelinkscope/networkSecurityPerimeterConfigurations/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.myAssociation", + "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.myAssociation", + "type": "Microsoft.HybridCompute/privateLinkScopes/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Accepted", + "provisioningIssues": [], + "networkSecurityPerimeter": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/networkSecurityPerimeters/myPerimeter", + "perimeterGuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "location": "westus" + }, + "resourceAssociation": { + "name": "myAssociation", + "accessMode": "enforced" + }, + "profile": { + "name": "myProfile", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "myAccessRule", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24", + "..." + ] + } + } + ], + "diagnosticSettingsVersion": 1, + "enabledLogCategories": [] + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/my-resource-group/providers/Microsoft.HybridCompute/privateLinkScopes/my-privatelinkscope/networkSecurityPerimeterConfigurations/37364608-77ea-4c2a-bdc3-4b0b1cdfab15.myAssociation2", + "name": "aaaaaaaa-0000-cccc-1111-eeeeeeeeeeee.myAssociation2", + "type": "Microsoft.HybridCompute/privateLinkScopes/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Accepted", + "provisioningIssues": [], + "networkSecurityPerimeter": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/networkSecurityPerimeters/myOtherPerimeter", + "perimeterGuid": "aaaaaaaa-0000-cccc-1111-eeeeeeeeeeee", + "location": "westus" + }, + "resourceAssociation": { + "name": "myAssociation", + "accessMode": "learning" + }, + "profile": { + "name": "myProfile", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "myAccessRule", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "122.0.0.0/8", + "144.4.6.0/24", + "..." + ] + } + } + ], + "diagnosticSettingsVersion": 1, + "enabledLogCategories": [] + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationReconcile.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationReconcile.json new file mode 100644 index 000000000000..903db22baadf --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationReconcile.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "perimeterName": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.myAssociation" + }, + "responses": { + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Delete.json new file mode 100644 index 000000000000..9b15cd8084bf --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + }, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Get.json new file mode 100644 index 000000000000..82fdacf957c4 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + }, + "groupIds": [ + "hybridcompute" + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_List.json new file mode 100644 index 000000000000..88cedbcda437 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_List.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + }, + "groupIds": [ + "hybridcompute" + ] + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", + "name": "private-endpoint-connection-name-2", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name-2" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection.", + "actionsRequired": "None" + }, + "groupIds": [ + "hybridcompute" + ] + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Update.json new file mode 100644 index 000000000000..58cfd738f24d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2024-05-20-preview", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + }, + "groupIds": [ + "hybridcompute" + ] + } + } + }, + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_Get.json new file mode 100644 index 000000000000..133754399097 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "api-version": "2024-05-20-preview", + "groupName": "hybridcompute" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateLinkResources/hybridcompute", + "name": "hybridcompute", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateLinkResources", + "properties": { + "groupId": "hybridcompute", + "requiredMembers": [ + "HybridCompute.Server", + "HybridCompute.K8sConfiguration", + "GuestConfig.DP" + ], + "requiredZoneNames": [ + "privatelink.his.arc.azure.com", + "privatelink.kubernetesconfiguration.azure.com", + "privatelink.Guestconfiguration.azure.com" + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_ListGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_ListGet.json new file mode 100644 index 000000000000..dc160dda3d4e --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_ListGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateLinkResources/hybridcompute", + "name": "hybridcompute", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateLinkResources", + "properties": { + "groupId": "hybridcompute", + "requiredMembers": [ + "HybridCompute.ServerDP", + "HybridCompute.K8sConfigurationDP", + "HybridCompute.GuestConfigDP" + ], + "requiredZoneNames": [ + "privatelink.his.arc.azure.com", + "privatelink.kubernetesconfiguration.azure.com", + "privatelink.Guestconfiguration.azure.com" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Create.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Create.json new file mode 100644 index 000000000000..961a4e473e7e --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Create.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Delete.json new file mode 100644 index 000000000000..ab69b129833e --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Get.json new file mode 100644 index 000000000000..0581cfc629d1 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidation.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidation.json new file mode 100644 index 000000000000..245588b0ebcd --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidation.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "location": "wus2", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "publicNetworkAccess": "Disabled", + "connectionDetails": [ + { + "id": "id", + "privateIpAddress": "ip", + "linkIdentifier": "linkId", + "groupId": "groupId", + "memberName": "memberName" + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidationForMachine.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidationForMachine.json new file mode 100644 index 000000000000..46ae4a8f2c99 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidationForMachine.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "location": "wus2", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "machineName": "machineName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "publicNetworkAccess": "Disabled", + "connectionDetails": [ + { + "id": "id", + "privateIpAddress": "ip", + "linkIdentifier": "linkId", + "groupId": "groupId", + "memberName": "memberName" + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_List.json new file mode 100644 index 000000000000..9cb00447732d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled" + } + }, + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-other-privatelinkscope", + "name": "my-other-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_ListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_ListByResourceGroup.json new file mode 100644 index 000000000000..1a0de1a9d40d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_ListByResourceGroup.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + }, + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-other-privatelinkscope", + "name": "my-other-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "a5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Update.json new file mode 100644 index 000000000000..927484969145 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_Update.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "parameters": { + "location": "westus", + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridCompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridCompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_UpdateTagsOnly.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_UpdateTagsOnly.json new file mode 100644 index 000000000000..15331bb36840 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/privateLinkScope/PrivateLinkScopes_UpdateTagsOnly.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-05-20-preview", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "PrivateLinkScopeTags": { + "tags": { + "Tag1": "Value1", + "Tag2": "Value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": { + "Tag1": "Value1", + "Tag2": "Value2" + }, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_CreateOrUpdate.json new file mode 100644 index 000000000000..2cb5715d7f54 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_CreateOrUpdate.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "runCommandName": "myRunCommand", + "api-version": "2024-05-20-preview", + "runCommandProperties": { + "location": "eastus2", + "properties": { + "source": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "runAsPassword": "", + "timeoutInSeconds": 3600, + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand", + "name": "myRunCommand", + "type": "Microsoft.HybridCompute/machines/runcommands", + "location": "eastus2", + "properties": { + "source": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + }, + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand", + "name": "myRunCommand", + "type": "Microsoft.HybridCompute/machines/runcommands", + "location": "eastus2", + "properties": { + "source": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt", + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_Delete.json new file mode 100644 index 000000000000..ae56f3d1dabf --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "runCommandName": "myRunCommand", + "api-version": "2024-05-20-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + }, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_Get.json new file mode 100644 index 000000000000..a616e5655c95 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "runCommandName": "myRunCommand", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand", + "name": "myRunCommand", + "type": "Microsoft.HybridCompute/machines/runcommands", + "location": "eastus2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "source": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "protectedParameters": [], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Succeeded", + "instanceView": { + "executionState": "Succeeded", + "executionMessage": "", + "exitCode": 0, + "output": "Hello World", + "error": "", + "startTime": "2023-06-15T20:48:41.4641785+00:00", + "endTime": "2023-06-15T20:48:41.4641785+00:00" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_List.json new file mode 100644 index 000000000000..6eeded6c56b5 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand_1", + "name": "myRunCommand_1", + "location": "eastus2", + "type": "Microsoft.HybridCompute/machines/runcommands", + "properties": { + "source": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "protectedParameters": [], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Succeeded", + "instanceView": { + "executionState": "Succeeded", + "executionMessage": "", + "exitCode": 0, + "output": "Hello World", + "error": "", + "startTime": "2023-06-15T20:48:41.4641785+00:00", + "endTime": "2023-06-15T20:48:41.4641785+00:00" + } + } + }, + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand_2", + "name": "myRunCommand_2", + "location": "eastus2", + "type": "Microsoft.HybridCompute/machines/runcommands", + "properties": { + "source": { + "script": "Get-Process | Where-Object { $_.CPU -gt 10000 }" + }, + "parameters": [], + "protectedParameters": [], + "asyncExecution": false, + "runAsUser": "userA", + "timeoutInSeconds": 100, + "provisioningState": "Succeeded", + "instanceView": { + "executionState": "Succeeded", + "executionMessage": "", + "exitCode": 0, + "output": "", + "error": "", + "startTime": "2023-06-15T20:48:41.4641785+00:00", + "endTime": "2023-06-15T20:48:41.4641785+00:00" + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_Update.json new file mode 100644 index 000000000000..5dedaf143a28 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/runCommand/RunCommands_Update.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "runCommandName": "myRunCommand", + "api-version": "2024-05-20-preview", + "runCommandProperties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand", + "name": "myRunCommand", + "type": "Microsoft.HybridCompute/machines/runcommands", + "location": "eastus2", + "properties": { + "source": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt", + "provisioningState": "Succeeded", + "instanceView": { + "executionState": "Succeeded", + "executionMessage": "", + "exitCode": 0, + "output": "Hello World", + "error": "", + "startTime": "2023-06-15T20:48:41.4641785+00:00", + "endTime": "2023-06-15T20:48:41.4641785+00:00" + } + } + } + }, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/settings/SettingsGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/settings/SettingsGet.json new file mode 100644 index 000000000000..83a469ef3cf2 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/settings/SettingsGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "hybridRG", + "baseProvider": "Microsoft.HybridCompute", + "baseResourceType": "machines", + "baseResourceName": "testMachine", + "settingsResourceName": "default", + "api-version": "2024-05-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridCompute/settings/default", + "name": "current", + "type": "Microsoft.HybridCompute/settings", + "properties": { + "tenantId": "00000000-1111-2222-5555-444444444444", + "gatewayProperties": { + "gatewayResourceId": "/subscriptions/{subscriptionId}/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/gateways/newGateway" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/settings/SettingsPatch.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/settings/SettingsPatch.json new file mode 100644 index 000000000000..1a62ebc9c93f --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/settings/SettingsPatch.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "hybridRG", + "baseProvider": "Microsoft.HybridCompute", + "baseResourceType": "machines", + "baseResourceName": "testMachine", + "settingsResourceName": "default", + "api-version": "2024-05-20-preview", + "parameters": { + "properties": { + "gatewayProperties": { + "gatewayResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/gateways/newGateway" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridCompute/settings/default", + "name": "current", + "type": "Microsoft.HybridCompute/settings", + "properties": { + "tenantId": "00000000-1111-2222-5555-444444444444", + "gatewayProperties": { + "gatewayResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/gateways/newGateway" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/settings/SettingsUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/settings/SettingsUpdate.json new file mode 100644 index 000000000000..9da02d9d447b --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/examples/settings/SettingsUpdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "hybridRG", + "baseProvider": "Microsoft.HybridCompute", + "baseResourceType": "machines", + "baseResourceName": "testMachine", + "settingsResourceName": "default", + "api-version": "2024-05-20-preview", + "parameters": { + "properties": { + "gatewayProperties": { + "gatewayResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/gateways/newGateway" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridCompute/settings/default", + "name": "current", + "type": "Microsoft.HybridCompute/settings", + "properties": { + "tenantId": "00000000-1111-2222-5555-444444444444", + "gatewayProperties": { + "gatewayResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/gateways/newGateway" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridCompute/settings/default", + "name": "current", + "type": "Microsoft.HybridCompute/settings", + "properties": { + "tenantId": "00000000-1111-2222-5555-444444444444", + "gatewayProperties": { + "gatewayResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/gateways/newGateway" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json new file mode 100644 index 000000000000..8c74eb87cf2f --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json @@ -0,0 +1,1896 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridComputeManagementClient", + "x-ms-code-generation-settings": { + "name": "HybridComputeManagementClient" + }, + "description": "Azure Arc( Servers and K8s Clusters) API reference for Private Link's Scopes management.", + "version": "2024-05-20-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/privateLinkScopes": { + "get": { + "description": "Gets a list of all Azure Arc PrivateLinkScopes within a subscription.", + "operationId": "PrivateLinkScopes_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more Azure Arc PrivateLinkScope definitions.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScopeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopesList.json": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes": { + "get": { + "description": "Gets a list of Azure Arc PrivateLinkScopes within a resource group.", + "operationId": "PrivateLinkScopes_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more Azure Arc PrivateLinkScope definitions.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScopeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeListByResourceGroup": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}": { + "delete": { + "description": "Deletes a Azure Arc PrivateLinkScope.", + "operationId": "PrivateLinkScopes_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successful request when deleting an Azure Arc PrivateLinkScope." + }, + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "The specified PrivateLinkScope does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrivateLinkScopesDelete": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_Delete.json" + } + } + }, + "get": { + "description": "Returns a Azure Arc PrivateLinkScope.", + "operationId": "PrivateLinkScopes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Azure Arc PrivateLinkScope definition.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_Get.json" + } + } + }, + "put": { + "description": "Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", + "operationId": "PrivateLinkScopes_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "parameters", + "description": "Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + } + ], + "responses": { + "200": { + "description": "Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope is returned.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "201": { + "description": "Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope was created and is returned.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeCreate": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_Create.json" + }, + "PrivateLinkScopeUpdate": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_Update.json" + } + } + }, + "patch": { + "description": "Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.", + "operationId": "PrivateLinkScopes_UpdateTags", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "PrivateLinkScopeTags", + "description": "Updated tag information to set into the PrivateLinkScope instance.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsResource" + } + } + ], + "responses": { + "200": { + "description": "Updating the Azure Arc PrivateLinkScope's tags was successful. PrivateLinkScope tags are updated and returned with the rest of the PrivateLinkScope's object properties.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeUpdateTagsOnly": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_UpdateTagsOnly.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkResources_ListByPrivateLinkScope", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_ListGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkResources_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "$ref": "#/parameters/GroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private link resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/privateEndpoint/PrivateEndpointConnection_Get.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Approve or reject a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/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/privateEndpoint/PrivateEndpointConnection_Update.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully deleted private endpoint connection." + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a private endpoint connection with a given name.": { + "$ref": "./examples/privateEndpoint/PrivateEndpointConnection_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets all private endpoint connections on a private link scope.", + "operationId": "PrivateEndpointConnections_ListByPrivateLinkScope", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets list of private endpoint connections on a private link scope.": { + "$ref": "./examples/privateEndpoint/PrivateEndpointConnection_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/privateLinkScopes/{privateLinkScopeId}": { + "get": { + "description": "Returns a Azure Arc PrivateLinkScope's validation details.", + "operationId": "PrivateLinkScopes_GetValidationDetails", + "parameters": [ + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeId" + } + ], + "responses": { + "200": { + "description": "Azure Arc PrivateLinkScope validation details definition.", + "schema": { + "$ref": "#/definitions/PrivateLinkScopeValidationDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_GetValidation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/privateLinkScopes/current": { + "get": { + "description": "Returns a Azure Arc PrivateLinkScope's validation details for a given machine.", + "operationId": "PrivateLinkScopes_GetValidationDetailsForMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MachineNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure Arc PrivateLinkScope validation details definition.", + "schema": { + "$ref": "#/definitions/PrivateLinkScopeValidationDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_GetValidationForMachine.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.HybridCompute/networkConfigurations/current": { + "get": { + "tags": [ + "NetworkConfigurations" + ], + "description": "Returns a NetworkConfiguration for the target resource.", + "operationId": "NetworkConfigurations_Get", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "NetworkConfigurationsGet": { + "$ref": "./examples/networkConfiguration/NetworkConfigurationsGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Network Configuration information for the target resource.", + "schema": { + "$ref": "#/definitions/NetworkConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "NetworkConfigurations" + ], + "description": "Create or update the NetworkConfiguration of the target resource.", + "operationId": "NetworkConfigurations_CreateOrUpdate", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "NetworkConfigurationsCreate": { + "$ref": "./examples/networkConfiguration/NetworkConfigurationsCreate.json" + }, + "NetworkConfigurationsUpdate": { + "$ref": "./examples/networkConfiguration/NetworkConfigurationsUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "name": "parameters", + "description": "Network Configuration details", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Successful request when creating or updating a NetworkConfiguration. The updated NetworkConfiguration is returned.", + "schema": { + "$ref": "#/definitions/NetworkConfiguration" + } + }, + "201": { + "description": "Successful request when creating or updating a NetworkConfiguration. The updated NetworkConfiguration was created and is returned.", + "schema": { + "$ref": "#/definitions/NetworkConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "NetworkConfigurations" + ], + "description": "Update the endpoint to the target resource.", + "operationId": "NetworkConfigurations_Update", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "NetworkConfigurationsPatch": { + "$ref": "./examples/networkConfiguration/NetworkConfigurationsPatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "name": "parameters", + "description": "Network Configuration details", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Network Configuration information for the target resource.", + "schema": { + "$ref": "#/definitions/NetworkConfiguration" + } + }, + "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.HybridCompute/privateLinkScopes/{scopeName}/networkSecurityPerimeterConfigurations/{perimeterName}": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfiguration" + ], + "description": "Gets the network security perimeter configuration for a private link scope.", + "operationId": "NetworkSecurityPerimeterConfigurations_GetByPrivateLinkScope", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "$ref": "#/parameters/PerimeterName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved network security perimeter configuration details.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets the network security perimeter configuration of the private link scope.": { + "$ref": "./examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/networkSecurityPerimeterConfigurations": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfiguration" + ], + "description": "Lists the network security perimeter configurations for a private link scope.", + "operationId": "NetworkSecurityPerimeterConfigurations_ListByPrivateLinkScope", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved network security perimeter configuration details.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationListResult" + } + }, + "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" + }, + "x-ms-examples": { + "Gets the list of network security perimeter configurations of the private link scope.": { + "$ref": "./examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/networkSecurityPerimeterConfigurations/{perimeterName}/reconcile": { + "post": { + "tags": [ + "NetworkSecurityPerimeterConfiguration" + ], + "description": "Forces the network security perimeter configuration to refresh for a private link scope.", + "operationId": "NetworkSecurityPerimeterConfigurations_ReconcileForPrivateLinkScope", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "$ref": "#/parameters/PerimeterName" + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reconciles the network security perimeter configuration of the private link scope.": { + "$ref": "./examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationReconcile.json" + } + } + } + } + }, + "definitions": { + "NetworkConfiguration": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "NetworkConfigurationProperties": { + "type": "object", + "description": "Network configuration properties", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "Azure resource tenant Id" + }, + "networkConfigurationScopeId": { + "type": "string", + "description": "Associated Network Configuration Scope Id (GUID)" + }, + "networkConfigurationScopeResourceId": { + "type": "string", + "description": "Associated Network Configuration Scope Resource Id", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.HybridCompute/privateLinkScopes" + } + ] + } + }, + "keyProperties": { + "description": "Public key information for client authentication", + "readOnly": true, + "$ref": "#/definitions/KeyProperties" + } + }, + "required": [ + "networkConfigurationScopeResourceId" + ] + }, + "KeyProperties": { + "type": "object", + "description": "Public key information for client authentication", + "properties": { + "clientPublicKey": { + "description": "Current public key details", + "readOnly": true, + "$ref": "#/definitions/KeyDetails" + }, + "candidatePublicKey": { + "description": "Candidate public key details", + "readOnly": true, + "$ref": "#/definitions/KeyDetails" + } + } + }, + "KeyDetails": { + "type": "object", + "description": "Public key details", + "properties": { + "publicKey": { + "type": "string", + "description": "Public key", + "readOnly": true + }, + "notAfter": { + "type": "string", + "format": "date-time", + "description": "Key expiration date", + "readOnly": true + }, + "renewAfter": { + "type": "string", + "format": "date-time", + "description": "Recommended key renewal date", + "readOnly": true + } + } + }, + "NetworkSecurityPerimeterConfiguration": { + "type": "object", + "description": "Properties that define a Network Security Perimeter resource.", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "description": "Azure resource name", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties that define a Network Security Perimeter resource.", + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationProperties" + } + }, + "x-ms-azure-resource": true + }, + "NetworkSecurityPerimeterConfigurationProperties": { + "type": "object", + "description": "Properties that define a Network Security Perimeter resource.", + "properties": { + "provisioningState": { + "type": "string", + "description": "Current state of this NetworkSecurityPerimeter: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.", + "readOnly": true + }, + "provisioningIssues": { + "type": "array", + "description": "Provisioning issues.", + "readOnly": true, + "items": { + "$ref": "#/definitions/ProvisioningIssue" + }, + "x-ms-identifiers": [] + }, + "networkSecurityPerimeter": { + "description": "The Network Security Perimeter associated with this configuration.", + "$ref": "#/definitions/NetworkSecurityPerimeter" + }, + "resourceAssociation": { + "description": "The Resource Association.", + "$ref": "#/definitions/ResourceAssociation" + }, + "profile": { + "description": "Network Security Perimeter profile", + "$ref": "#/definitions/NetworkSecurityPerimeterProfile" + } + } + }, + "NetworkSecurityPerimeterProfile": { + "type": "object", + "description": "Network Security Perimeter profile", + "properties": { + "name": { + "type": "string", + "description": "Name of the resource", + "readOnly": true + }, + "accessRulesVersion": { + "type": "integer", + "format": "int32", + "description": "Access rules version number", + "readOnly": true + }, + "accessRules": { + "type": "array", + "description": "Collection of access rules for the profile", + "readOnly": true, + "items": { + "$ref": "#/definitions/AccessRule" + }, + "x-ms-identifiers": [] + }, + "diagnosticSettingsVersion": { + "type": "integer", + "format": "int32", + "description": "Diagnostic settings version number", + "readOnly": true + }, + "enabledLogCategories": { + "type": "array", + "description": "Collection of enabled log categories for the profile", + "readOnly": true, + "items": { + "type": "string" + } + } + } + }, + "ProvisioningIssue": { + "type": "object", + "description": "Details on issues that occurred during provisioning.", + "properties": { + "name": { + "type": "string", + "description": "Name of the provisioning issue.", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Provisioning issue properties", + "readOnly": true, + "$ref": "#/definitions/ProvisioningIssueProperties" + } + } + }, + "ProvisioningIssueProperties": { + "type": "object", + "description": "Properties of a provisioning issue.", + "properties": { + "issueType": { + "description": "Issue type", + "readOnly": true, + "$ref": "#/definitions/ProvisioningIssueType" + }, + "severity": { + "description": "Severity of the provisioning issue.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningIssueSeverity" + }, + "description": { + "type": "string", + "description": "Description of the provisioning issue.", + "readOnly": true + }, + "suggestedResourceIds": { + "type": "array", + "description": "ARM Ids of the resources that can be associated to the same perimeter to remediate the issue", + "readOnly": true, + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "suggestedAccessRules": { + "type": "array", + "description": "Access rules that can be added to the perimeter to remediate the issue", + "readOnly": true, + "items": { + "$ref": "#/definitions/AccessRule" + }, + "x-ms-identifiers": [] + } + } + }, + "ProvisioningIssueType": { + "type": "string", + "description": "Type of provisioning issue.", + "enum": [ + "MissingPerimeterConfiguration", + "MissingIdentityConfiguration", + "ConfigurationPropagationFailure", + "Other" + ], + "x-ms-enum": { + "name": "ProvisioningIssueType", + "modelAsString": true, + "values": [ + { + "value": "MissingPerimeterConfiguration", + "description": "Perimeter configuration is missing." + }, + { + "value": "MissingIdentityConfiguration", + "description": "Identity configuration is missing." + }, + { + "value": "ConfigurationPropagationFailure", + "description": "Configuration failed to propagate." + }, + { + "value": "Other", + "description": "Other failure." + } + ] + } + }, + "ProvisioningIssueSeverity": { + "type": "string", + "description": "Severity of the provisioning issue.", + "enum": [ + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "ProvisioningIssueSeverity", + "modelAsString": true, + "values": [ + { + "value": "Warning", + "description": "Warnings can cause connectivity issues after provisioning succeeds." + }, + { + "value": "Error", + "description": "Errors will cause association provisioning to fail." + } + ] + } + }, + "AccessMode": { + "type": "string", + "description": "Property that impacts a resource's logging behavior and its connectivity with other resources and public networks.", + "enum": [ + "enforced", + "audit", + "learning" + ], + "x-ms-enum": { + "name": "AccessMode", + "modelAsString": true, + "values": [ + { + "value": "enforced", + "description": "Indicates that resource access is controlled by the NSP definition." + }, + { + "value": "audit", + "description": "Dry run mode, where traffic is evaluated against NSP Rules, logged but not enforced." + }, + { + "value": "learning", + "description": "Enables traffic evaluation to fall back to resource-specific firewall configurations." + } + ] + } + }, + "AccessRuleDirection": { + "type": "string", + "description": "Indicates direction of an access rule.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "AccessRuleDirection", + "modelAsString": true, + "values": [ + { + "value": "Inbound", + "description": "Traffic originates outside of network." + }, + { + "value": "Outbound", + "description": "Traffic originates inside the network" + } + ] + } + }, + "AccessRule": { + "type": "object", + "description": "Access rule.", + "properties": { + "name": { + "type": "string", + "description": "Name of the access rule.", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Access rule properties", + "readOnly": true, + "$ref": "#/definitions/AccessRuleProperties" + } + } + }, + "AccessRuleProperties": { + "type": "object", + "description": "Properties of an access rule.", + "properties": { + "direction": { + "description": "Direction of the access rule.", + "readOnly": true, + "$ref": "#/definitions/AccessRuleDirection" + }, + "addressPrefixes": { + "type": "array", + "description": "Address prefixes that are allowed access.", + "readOnly": true, + "items": { + "type": "string" + } + } + } + }, + "NetworkSecurityPerimeter": { + "type": "object", + "description": "Properties that define a Network Security Perimeter resource.", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "perimeterGuid": { + "type": "string", + "description": "Guid of the Network Security Perimeter", + "readOnly": true + }, + "location": { + "type": "string", + "readOnly": true, + "description": "Regional location of the perimeter" + } + } + }, + "NetworkSecurityPerimeterConfigurationListResult": { + "type": "object", + "description": "A list of network security perimeter configurations.", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceAssociation": { + "type": "object", + "description": "Properties that define a Resource Association.", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the Resource Association" + }, + "accessMode": { + "description": "The access mode", + "readOnly": true, + "$ref": "#/definitions/AccessMode" + } + } + }, + "PrivateLinkScopesResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "description": "Azure resource name", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "TagsResource": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "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 PrivateLinkScope instance." + }, + "HybridComputePrivateLinkScope": { + "type": "object", + "properties": { + "properties": { + "description": "Properties that define a Azure Arc PrivateLinkScope resource.", + "$ref": "#/definitions/HybridComputePrivateLinkScopeProperties" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PrivateLinkScopesResource" + } + ], + "description": "An Azure Arc PrivateLinkScope definition." + }, + "PrivateLinkScopeValidationDetails": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "publicNetworkAccess": { + "description": "Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "connectionDetails": { + "type": "array", + "description": "List of Private Endpoint Connection details.", + "items": { + "$ref": "#/definitions/ConnectionDetail" + } + } + } + }, + "ConnectionDetail": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection private ip address" + }, + "linkIdentifier": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection link identifier" + }, + "groupId": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection group id" + }, + "memberName": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection member name" + } + } + }, + "HybridComputePrivateLinkScopeProperties": { + "type": "object", + "description": "Properties that define a Azure Arc PrivateLinkScope resource.", + "properties": { + "publicNetworkAccess": { + "description": "Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "provisioningState": { + "type": "string", + "description": "Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.", + "readOnly": true + }, + "privateLinkScopeId": { + "readOnly": true, + "description": "The Guid id of the private link scope.", + "type": "string" + }, + "privateEndpointConnections": { + "readOnly": true, + "description": "The collection of associated Private Endpoint Connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionDataModel" + } + } + } + }, + "HybridComputePrivateLinkScopeListResult": { + "type": "object", + "description": "Describes the list of Azure Arc PrivateLinkScope resources.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of Azure Arc PrivateLinkScope definitions.", + "items": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "nextLink": { + "type": "string", + "description": "The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set." + } + } + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateLinkResource": { + "type": "object", + "description": "A private link resource", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "Properties of a private link resource.", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "description": "Required DNS zone names of the the private link resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PrivateEndpointConnectionDataModel": { + "type": "object", + "description": "The Data Model for a Private Endpoint Connection associated with a Private Link Scope", + "properties": { + "id": { + "description": "The ARM Resource Id of the Private Endpoint.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Name of the Private Endpoint.", + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The Private Endpoint Connection properties." + } + } + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpointProperty", + "description": "Private endpoint which the connection belongs to." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStateProperty", + "description": "Connection state of the private endpoint connection." + }, + "provisioningState": { + "description": "State of the private endpoint connection.", + "type": "string", + "readOnly": true + }, + "groupIds": { + "description": "List of group IDs.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PrivateEndpointProperty": { + "type": "object", + "description": "Private endpoint which the connection belongs to.", + "properties": { + "id": { + "description": "Resource id of the private endpoint.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStateProperty": { + "type": "object", + "description": "State of the private endpoint connection.", + "required": [ + "status", + "description" + ], + "properties": { + "status": { + "description": "The private link service connection status.", + "type": "string" + }, + "description": { + "description": "The private link service connection description.", + "type": "string" + }, + "actionsRequired": { + "description": "The actions required for private link service connection.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "A private endpoint connection", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" + } + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections.", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "PublicNetworkAccessType": { + "type": "string", + "description": "The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link).", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints." + }, + { + "value": "Disabled", + "description": "Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link." + }, + { + "value": "SecuredByPerimeter", + "description": "Azure Arc agent communication with Azure Arc services over public (internet) is enforced by Network Security Perimeter (NSP)" + } + ] + } + } + }, + "parameters": { + "PrivateLinkScopeName": { + "name": "scopeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Arc PrivateLinkScope resource.", + "x-ms-parameter-location": "method", + "pattern": "[a-zA-Z0-9-_\\.]+" + }, + "PrivateLinkScopeId": { + "name": "privateLinkScopeId", + "in": "path", + "required": true, + "type": "string", + "description": "The id (Guid) of the Azure Arc PrivateLinkScope resource.", + "x-ms-parameter-location": "method" + }, + "GroupNameParameter": { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The location of the target resource.", + "minLength": 1 + }, + "MachineNameParameter": { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the target machine to get the private link scope validation details for.", + "minLength": 1, + "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" + }, + "NetworkConfigurationScopeId": { + "name": "scopeId", + "in": "path", + "required": true, + "type": "string", + "description": "The id (Guid) of the Azure Arc Network Configuration Scope resource.", + "x-ms-parameter-location": "method" + }, + "PerimeterName": { + "name": "perimeterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name, in the format {perimeterGuid}.{associationName}, of the Network Security Perimeter resource.", + "x-ms-parameter-location": "method", + "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[.]{1}.+$" + } + } +} diff --git a/specification/hybridcompute/resource-manager/readme.md b/specification/hybridcompute/resource-manager/readme.md index bb44dd796307..df97284daf81 100644 --- a/specification/hybridcompute/resource-manager/readme.md +++ b/specification/hybridcompute/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the HybridCompute API. ``` yaml openapi-type: arm -tag: package-preview-2024-03 +tag: package-preview-2024-05 directive: - from: HybridCompute.json where: $.definitions.MachineInstallPatchesParameters.properties.maximumDuration @@ -149,6 +149,16 @@ directive: ``` +### 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.HybridCompute/preview/2024-05-20-preview/HybridCompute.json + - Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json +``` + ### Tag: package-preview-2024-03 These settings apply only when `--tag=package-preview-2024-03` is specified on the command line. From 5b4680decb81a4b3d266a189206efcb2619e7806 Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Fri, 31 May 2024 18:46:46 +0200 Subject: [PATCH 14/49] Assistant SDK V2 changes (depending on the Assistant V1 PR) (#29067) * initial commit for models in support of streaming Assistants calls * merge + pr feedback * [OpenAI] [Assistants] PR feedback (#28786) * Adding streaming events and modified class visibilities * Represented the alias as a union to align better with the swagger and have a class generated * Adding chunk classes to be included on code emission * Update specification/ai/OpenAI.Assistants/streaming/events.tsp * Added usage models for run and runStep (#28864) * Added usage models for run and runStep * Added added annotation * Added warning suppresion for nullable fields * Compiled with new models and unions * back ported everything to a past version. Extracted SubmitToolOutputsOptions model * re-compile * Removed toolresources for now and added warning supressions * Brought up to date the classes related to streaming for AssistantStreamEvent * Making filename mandatory uploadFile operation * Project compilation * Re-formated definitiones according to CI instructions * Added new service version * Figuring out error highlights in vscode * Added get method listVectorStore * extracted union * Added create vector store method * Adding method to get single vector store * Added update methods for vector store * Added deletion method for vector stores * Removed assistant specific file models and operations * Added operation for listing vector store files * Added create file for vector store method * Added the rest of the file operations * Re-structured files under vector_store * Reformated correctly * Added first operation for vector store file batch * Added file listing per vector store file batch * WIP: AssistantsApiResponseFormatOption generates as anyOf of instead of oneOf * corrected values for enum * Adjusted Assistant response object * Added browse azure tool call type and renamed retrieval to file_search * Adding models for createAssistantsOptions * Updated assistant update models * Added TruncationObject * Added tool_choice to run related objects * Added new fields to ThreadRun model * Added attachements and tool resources to thread and message related models * 2nd pass to thread and message related files * Renamed 'retrieva'->'file_search' added 'browse' * Removed deprecated file endpoints and add java customizations for code gen * Spellchecks * Added missing documentation * -clear * Renamed union * TSP validation check * Reverted nullability of fileName * re-compiled * Added new file purposes * Removed openapi v2 and v3 files generated with the placeholder version * reformating * Added AOAI fields for Files * Added missing tool_resource object to createThreadAndRunRequest * Updated docs and removed Browse tools for this release * Maded the stream events public to expose types and docs to users * Made stream events publics * PR feedback and solved one open comment left for UpdateThreadOptions * remove single-use options model, merge into route params directly * proactively add 2024-05-01-preview label * Removed model removed in upstream branch * Recompile * Removed 05_01 from service version enum ... for now * Restored example * Added string type to AssistantStreamEvent * tsp validation check * Duplicate doc annotation * Removed duplicate entries * Added documentation for API response formats * Applied formatter * Removed package and annotation usage causing issues in Java emitter * Made temperature and top_p nullable for assistant create request * Commented out linter rule breaking code emission * Corrected double dot in documentation * Restored linter rules for formater and adjusted definition of JSON polymorphic type * Cleaned up comment * Split out the string variants into their own union * tsp format * PR feedback --------- Co-authored-by: Travis Wilson Co-authored-by: Travis Wilson <35748617+trrwilson@users.noreply.github.com> --- .../OpenAI.Assistants/assistants/models.tsp | 151 +- .../OpenAI.Assistants/assistants/routes.tsp | 74 - specification/ai/OpenAI.Assistants/client.tsp | 13 - .../ai/OpenAI.Assistants/common/models.tsp | 56 + .../2024-05-01-preview/create_assistant.json | 4 + .../ai/OpenAI.Assistants/files/models.tsp | 75 +- specification/ai/OpenAI.Assistants/main.tsp | 6 + .../ai/OpenAI.Assistants/messages/models.tsp | 90 +- .../ai/OpenAI.Assistants/messages/routes.tsp | 61 +- .../ai/OpenAI.Assistants/run_steps/models.tsp | 12 +- .../ai/OpenAI.Assistants/runs/models.tsp | 228 +- .../ai/OpenAI.Assistants/runs/routes.tsp | 2 + .../ai/OpenAI.Assistants/threads/models.tsp | 49 +- .../ai/OpenAI.Assistants/threads/routes.tsp | 6 +- .../ai/OpenAI.Assistants/tools/models.tsp | 91 +- .../tools/tool_resources.tsp | 164 + .../ai/OpenAI.Assistants/tspconfig.yaml | 2 +- .../vector_stores/file_batches/main.tsp | 2 + .../vector_stores/file_batches/models.tsp | 46 + .../vector_stores/file_batches/routes.tsp | 88 + .../vector_stores/files/main.tsp | 2 + .../vector_stores/files/models.tsp | 111 + .../vector_stores/files/routes.tsp | 85 + .../OpenAI.Assistants/vector_stores/main.tsp | 5 + .../vector_stores/models.tsp | 161 + .../vector_stores/routes.tsp | 81 + .../assistants_generated.json | 802 +-- .../assistants_generated.json | 5184 +++++++++++++++++ .../assistants_generated.yaml | 534 +- .../assistants_generated.yaml | 4225 ++++++++++++++ 30 files changed, 10959 insertions(+), 1451 deletions(-) create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/tools/tool_resources.tsp create mode 100644 specification/ai/OpenAI.Assistants/vector_stores/file_batches/main.tsp create mode 100644 specification/ai/OpenAI.Assistants/vector_stores/file_batches/models.tsp create mode 100644 specification/ai/OpenAI.Assistants/vector_stores/file_batches/routes.tsp create mode 100644 specification/ai/OpenAI.Assistants/vector_stores/files/main.tsp create mode 100644 specification/ai/OpenAI.Assistants/vector_stores/files/models.tsp create mode 100644 specification/ai/OpenAI.Assistants/vector_stores/files/routes.tsp create mode 100644 specification/ai/OpenAI.Assistants/vector_stores/main.tsp create mode 100644 specification/ai/OpenAI.Assistants/vector_stores/models.tsp create mode 100644 specification/ai/OpenAI.Assistants/vector_stores/routes.tsp create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml diff --git a/specification/ai/OpenAI.Assistants/assistants/models.tsp b/specification/ai/OpenAI.Assistants/assistants/models.tsp index 6f82c711d58d..1ecff00e2e15 100644 --- a/specification/ai/OpenAI.Assistants/assistants/models.tsp +++ b/specification/ai/OpenAI.Assistants/assistants/models.tsp @@ -1,6 +1,9 @@ import "@typespec/versioning"; + import "../common/models.tsp"; import "../tools/models.tsp"; +import "../tools/tool_resources.tsp"; +import "../main.tsp"; namespace Azure.AI.OpenAI.Assistants; @@ -39,9 +42,43 @@ model Assistant { @doc("The collection of tools enabled for the assistant.") tools: ToolDefinition[] = []; - @encodedName("application/json", "file_ids") - @doc("A list of attached file IDs, ordered by creation date in ascending order.") - fileIds: string[] = []; + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "tool_resources") + @added(ServiceApiVersions.v2024_05_01_preview) + toolResources: ToolResources | null; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @added(ServiceApiVersions.v2024_05_01_preview) + @minValue(0) + @maxValue(2) + temperature: float32 | null = 1; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @added(ServiceApiVersions.v2024_05_01_preview) + @minValue(0) + @maxValue(1) + @encodedName("application/json", "top_p") + topP: float32 | null = 1; + + /** The response format of the tool calls used by this assistant. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "response_format") + @added(ServiceApiVersions.v2024_05_01_preview) + responseFormat?: AssistantsApiResponseFormatOption | null; ...RequiredNullableMetadata; } @@ -68,9 +105,43 @@ model AssistantCreationOptions { @doc("The collection of tools to enable for the new assistant.") tools?: ToolDefinition[] = []; - @encodedName("application/json", "file_ids") - @doc("A list of previously uploaded file IDs to attach to the assistant.") - fileIds?: string[] = []; + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "tool_resources") + @added(ServiceApiVersions.v2024_05_01_preview) + toolResources?: CreateToolResourcesOptions | null; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @added(ServiceApiVersions.v2024_05_01_preview) + @minValue(0) + @maxValue(2) + temperature?: float32 | null = 1; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @added(ServiceApiVersions.v2024_05_01_preview) + @minValue(0) + @maxValue(1) + @encodedName("application/json", "top_p") + topP?: float32 | null = 1; + + /** The response format of the tool calls used by this assistant. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "response_format") + @added(ServiceApiVersions.v2024_05_01_preview) + responseFormat?: AssistantsApiResponseFormatOption | null; ...OptionalNullableMetadata; } @@ -100,9 +171,42 @@ model UpdateAssistantOptions { @doc("The modified collection of tools to enable for the assistant.") tools?: ToolDefinition[] = []; - @encodedName("application/json", "file_ids") - @doc("The modified list of previously uploaded fileIDs to attach to the assistant.") - fileIds?: string[] = []; + /** + * 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. + */ + @encodedName("application/json", "tool_resources") + @added(ServiceApiVersions.v2024_05_01_preview) + toolResources?: UpdateToolResourcesOptions; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @added(ServiceApiVersions.v2024_05_01_preview) + @minValue(0) + @maxValue(2) + temperature?: float32 | null = 1; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @added(ServiceApiVersions.v2024_05_01_preview) + @minValue(0) + @maxValue(1) + @encodedName("application/json", "top_p") + topP?: float32 | null = 1; + + /** The response format of the tool calls used by this assistant. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "response_format") + @added(ServiceApiVersions.v2024_05_01_preview) + responseFormat?: AssistantsApiResponseFormatOption | null; ...OptionalNullableMetadata; } @@ -115,32 +219,3 @@ model AssistantDeletionStatus { @doc("The object type, which is always 'assistant.deleted'.") object: "assistant.deleted"; } - -@doc("Information about a file attached to an assistant, as used by tools that can read files.") -@added(ServiceApiVersions.v2024_02_15_preview) -model AssistantFile { - @doc("The identifier, which can be referenced in API endpoints.") - id: string; - - @doc("The object type, which is always 'assistant.file'.") - object: "assistant.file"; - - @encodedName("application/json", "created_at") - @encode(DateTimeKnownEncoding.unixTimestamp, int32) - @doc("The Unix timestamp, in seconds, representing when this object was created.") - createdAt: utcDateTime; - - @encodedName("application/json", "assistant_id") - @doc("The assistant ID that the file is attached to.") - assistantId: string; -} - -#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "https://github.com/Azure/autorest.csharp/issues/4041" -@doc("The status of an assistant file deletion operation.") -@added(ServiceApiVersions.v2024_02_15_preview) -model AssistantFileDeletionStatus { - ...DeletionStatus; - - @doc("The object type, which is always 'assistant.file.deleted'.") - object: "assistant.file.deleted"; -} diff --git a/specification/ai/OpenAI.Assistants/assistants/routes.tsp b/specification/ai/OpenAI.Assistants/assistants/routes.tsp index bbdb7829485a..cdefb9fd6aa5 100644 --- a/specification/ai/OpenAI.Assistants/assistants/routes.tsp +++ b/specification/ai/OpenAI.Assistants/assistants/routes.tsp @@ -78,77 +78,3 @@ op updateAssistant(...UpdateAssistantOptions): Assistant; @route("/assistants/{assistantId}") @added(ServiceApiVersions.v2024_02_15_preview) op deleteAssistant(@path assistantId: string): AssistantDeletionStatus; - -/** - * Attaches a previously uploaded file to an assistant for use by tools that can read files. - * - * @param assistantId The ID of the assistant to attach the file to. - * @param fileId The ID of the previously uploaded file to attach. - * @returns Information about the attached file. - */ -#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" -#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" -#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" -@post -@route("assistants/{assistantId}/files") -@added(ServiceApiVersions.v2024_02_15_preview) -op createAssistantFile( - @path assistantId: string, - @encodedName("application/json", "file_id") fileId: string, -): AssistantFile; - -/** - * Gets a list of files attached to a specific assistant, as used by tools that can read files. - * - * @param assistantId The ID of the assistant to retrieve the list of attached files for. - * @returns The requested list of files attached to the specified assistant. - */ -#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" -#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" -#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" -#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" -@get -@route("assistants/{assistantId}/files") -@added(ServiceApiVersions.v2024_02_15_preview) -op listAssistantFiles( - @path assistantId: string, - ...OpenAIListRequestOptions, -): OpenAIPageableListOf; - -/** - * Retrieves a file attached to an assistant. - * - * @param assistantId The ID of the assistant associated with the attached file. - * @param fileId The ID of the file to retrieve. - * @returns A representation of the attached file. - */ -#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" -#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" -#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" -#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API name parity" -@get -@route("assistants/{assistantId}/files/{fileId}") -@added(ServiceApiVersions.v2024_02_15_preview) -op getAssistantFile( - @path assistantId: string, - @path fileId: string, -): AssistantFile; - -/** - * Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read - * files. - * - * @param assistantId The ID of the assistant from which the specified file should be unlinked. - * @param fileId The ID of the file to unlink from the specified assistant. - * @returns Status information about the requested file association deletion. - */ -#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" -#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" -#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" -@delete -@route("assistants/{assistantId}/files/{fileId}") -@added(ServiceApiVersions.v2024_02_15_preview) -op deleteAssistantFile( - @path assistantId: string, - @path fileId: string, -): AssistantFileDeletionStatus; diff --git a/specification/ai/OpenAI.Assistants/client.tsp b/specification/ai/OpenAI.Assistants/client.tsp index a2ef9ea62da6..09cbd97e3622 100644 --- a/specification/ai/OpenAI.Assistants/client.tsp +++ b/specification/ai/OpenAI.Assistants/client.tsp @@ -24,21 +24,10 @@ namespace Azure.AI.OpenAI.Assistants { ); @@access(deleteAssistant, Access.internal, "csharp"); @@clientName(deleteAssistant, "InternalDeleteAssistant", "csharp"); - @@access(AssistantFileDeletionStatus, Access.internal, "csharp"); - @@clientName(AssistantFileDeletionStatus, - "InternalAssistantFileDeletionStatus", - "csharp" - ); - @@access(deleteAssistantFile, Access.internal, "csharp"); - @@clientName(deleteAssistantFile, "InternalUnlinkAssistantFile", "csharp"); @@access(deleteThread, Access.internal, "csharp"); @@clientName(deleteThread, "InternalDeleteThread", "csharp"); @@access(listAssistants, Access.internal, "csharp"); @@clientName(listAssistants, "InternalGetAssistants", "csharp"); - @@access(listAssistantFiles, Access.internal, "csharp"); - @@clientName(listAssistantFiles, "InternalGetAssistantFiles", "csharp"); - @@access(listMessageFiles, Access.internal, "csharp"); - @@clientName(listMessageFiles, "InternalGetMessageFiles", "csharp"); @@access(listRunSteps, Access.internal, "csharp"); @@clientName(listRunSteps, "InternalGetRunSteps", "csharp"); @@access(listMessages, Access.internal, "csharp"); @@ -241,6 +230,4 @@ namespace Azure.AI.OpenAI.Assistants { // From https://platform.openai.com/docs/assistants/how-it-works // "Note that deleting an AssistantFile doesn’t delete the original File object, it simply deletes the association // between that File and the Assistant." - @@clientName(createAssistantFile, "LinkAssistantFile", "csharp"); - // 'Unlink' counterpart already renamed for DeletionStatus merge } diff --git a/specification/ai/OpenAI.Assistants/common/models.tsp b/specification/ai/OpenAI.Assistants/common/models.tsp index bbdfce9bed09..5c446a1d1d42 100644 --- a/specification/ai/OpenAI.Assistants/common/models.tsp +++ b/specification/ai/OpenAI.Assistants/common/models.tsp @@ -92,3 +92,59 @@ alias OptionalNullableMetadata = { #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" metadata?: Record | null; }; + +/** + * 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. + */ +#suppress "@azure-tools/typespec-autorest/union-unsupported" "This union is defined according to the OpenAI API" +@added(ServiceApiVersions.v2024_05_01_preview) +union AssistantsApiResponseFormatOption { + string, + + /** The model will handle the return format. */ + AssistantsApiResponseFormatMode, + + /** Sets the format of the output of the model when a ToolCall is returned. */ + AssistantsApiResponseFormat, +} + +/** Represents the mode in which the model will handle the return format of a tool call. */ +@added(ServiceApiVersions.v2024_05_01_preview) +union AssistantsApiResponseFormatMode { + string, + + /** Default value. Let the model handle the return format. */ + "auto", + + /** Setting the value to `none`, will result in a 400 Bad request. */ + "none", +} + +/** + * 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. + */ +@added(ServiceApiVersions.v2024_05_01_preview) +model AssistantsApiResponseFormat { + /** Must be one of `text` or `json_object`. */ + type?: ApiResponseFormat = ApiResponseFormat.text; +} + +/** Possible API response formats. */ +@added(ServiceApiVersions.v2024_05_01_preview) +union ApiResponseFormat { + string, + + /** `text` format should be used for requests involving any sort of ToolCall. */ + text: "text", + + /** Using `json_object` format will limit the usage of ToolCall to only functions. */ + jsonObject: "json_object", +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json new file mode 100644 index 000000000000..24f1208ac3df --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json @@ -0,0 +1,4 @@ +{ + "title": "Assistants_CreateAssistant", + "operationId": "Assistants_CreateAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/files/models.tsp b/specification/ai/OpenAI.Assistants/files/models.tsp index 1b26b9845bf1..9b1963dd9a46 100644 --- a/specification/ai/OpenAI.Assistants/files/models.tsp +++ b/specification/ai/OpenAI.Assistants/files/models.tsp @@ -1,5 +1,7 @@ import "@typespec/versioning"; +import "../main.tsp"; + namespace Azure.AI.OpenAI.Assistants; using TypeSpec.Versioning; @@ -27,24 +29,87 @@ model OpenAIFile { @doc("The intended purpose of a file.") purpose: FilePurpose; + + /** The state of the file. This field is available in Azure OpenAI only. */ + @added(ServiceApiVersions.v2024_05_01_preview) + status?: FileState; + + /** The error message with details in case processing of this file failed. This field is available in Azure OpenAI only. */ + @encodedName("application/json", "status_details") + @added(ServiceApiVersions.v2024_05_01_preview) + statusDetails?: string; +} + +/** The state of the file. */ +@added(ServiceApiVersions.v2024_05_01_preview) +union FileState { + string, + + /** + * The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for + * compatibility. It can be categorized as an inactive state. + */ + uploaded: "uploaded", + + /** + * The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. + */ + pending: "pending", + + /** The operation has started to be processed. It can be categorized as an active state. */ + running: "running", + + /** + * The operation has successfully processed and is ready for consumption. It can be categorized as a terminal state. + */ + processed: "processed", + + /** + * The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. + */ + error: "error", + + /** + * The entity is in the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. + * It can be categorized as an active state. + */ + deleting: "deleting", + + /** + * The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a + * terminal state. + */ + deleted: "deleted", } -@doc("The possible values denoting the intended usage of a file.") +/** The possible values denoting the intended usage of a file. */ @added(ServiceApiVersions.v2024_02_15_preview) union FilePurpose { string, - @doc("Indicates a file is used for fine tuning input.") + /** Indicates a file is used for fine tuning input. */ fineTune: "fine-tune", - @doc("Indicates a file is used for fine tuning results.") + /** Indicates a file is used for fine tuning results. */ fineTuneResults: "fine-tune-results", - @doc("Indicates a file is used as input to assistants.") + /** Indicates a file is used as input to assistants. */ assistants: "assistants", - @doc("Indicates a file is used as output by assistants.") + /** Indicates a file is used as output by assistants. */ assistantsOutput: "assistants_output", + + /** Indicates a file is used as input to . */ + @added(ServiceApiVersions.v2024_05_01_preview) + batch: "batch", + + /** Indicates a file is used as output by a vector store batch operation. */ + @added(ServiceApiVersions.v2024_05_01_preview) + batchOutput: "batch_output", + + /** Indicates a file is used as input to a vision operation. */ + @added(ServiceApiVersions.v2024_05_01_preview) + vision: "vision", } @doc("The response data from a file list operation.") diff --git a/specification/ai/OpenAI.Assistants/main.tsp b/specification/ai/OpenAI.Assistants/main.tsp index 462d1028e419..1fa7e0790ce4 100644 --- a/specification/ai/OpenAI.Assistants/main.tsp +++ b/specification/ai/OpenAI.Assistants/main.tsp @@ -1,6 +1,7 @@ import "@azure-tools/typespec-azure-core"; import "@typespec/http"; import "@typespec/versioning"; + import "./assistants/main.tsp"; import "./threads/main.tsp"; import "./messages/main.tsp"; @@ -8,6 +9,7 @@ import "./runs/main.tsp"; import "./run_steps/main.tsp"; import "./files/main.tsp"; import "./streaming/events.tsp"; +import "./vector_stores/main.tsp"; using TypeSpec.Http; using TypeSpec.Versioning; @@ -52,5 +54,9 @@ namespace Azure.AI.OpenAI.Assistants { @useDependency(Azure.Core.Versions.v1_0_Preview_2) @doc("The initial version of Azure OpenAI Assistants that corresponds to functionality in OpenAI's first beta release.") v2024_02_15_preview: "2024-02-15-preview", + + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @doc("The May 2024 preview release for Azure OpenAI, including the first availability of assistants V2.") + v2024_05_01_preview: "2024-05-01-preview", } } diff --git a/specification/ai/OpenAI.Assistants/messages/models.tsp b/specification/ai/OpenAI.Assistants/messages/models.tsp index a6b286399fd0..ebce66ef29c4 100644 --- a/specification/ai/OpenAI.Assistants/messages/models.tsp +++ b/specification/ai/OpenAI.Assistants/messages/models.tsp @@ -1,24 +1,31 @@ +import "../main.tsp"; +import "../tools/models.tsp"; + import "@typespec/versioning"; namespace Azure.AI.OpenAI.Assistants; using TypeSpec.Versioning; -@doc("A single message within an assistant thread, as provided during that thread's creation for its initial state.") -@added(ServiceApiVersions.v2024_02_15_preview) -model ThreadInitializationMessage { - @doc("The role associated with the assistant thread message. Currently, only 'user' is supported when providing initial messages to a new thread.") +/** A single message within an assistant thread, as provided during that thread's creation for its initial state. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model ThreadMessageOptions { + /** + * 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. + */ role: MessageRole; - @doc("The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API.") + /** The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via + * a separate call to the create message API. + */ content: string; - @encodedName("application/json", "file_ids") - @doc(""" - A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can - access files. - """) - fileIds?: string[] = []; + /** A list of files attached to the message, and the tools they should be added to. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + attachments?: MessageAttachment[] | null; ...OptionalNullableMetadata; } @@ -49,7 +56,7 @@ model ThreadMessage { #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" @encodedName("application/json", "incomplete_details") @added(ServiceApiVersions.v2024_02_15_preview) - incompleteDetails: MessageIncompleteDetailsReason | null; + incompleteDetails: MessageIncompleteDetails | null; /** The Unix timestamp (in seconds) for when the message was completed. */ #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" @@ -71,24 +78,42 @@ model ThreadMessage { @doc("The list of content items associated with the assistant thread message.") content: MessageContent[]; + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" @encodedName("application/json", "assistant_id") @doc("If applicable, the ID of the assistant that authored this message.") - assistantId?: string; + assistantId: string | null; + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" @encodedName("application/json", "run_id") @doc("If applicable, the ID of the run associated with the authoring of this message.") - runId?: string; + runId: string | null; - @encodedName("application/json", "file_ids") - @doc(""" - A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can - access files. - """) - fileIds: string[]; + /** A list of files attached to the message, and the tools they were added to. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @added(ServiceApiVersions.v2024_05_01_preview) + attachments: MessageAttachment[] | null; ...RequiredNullableMetadata; } +/** This describes to which tools a file has been attached. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model MessageAttachment { + /** The ID of the file to attach to the message. */ + @encodedName("application/json", "file_id") + fileId: string; + + /** The tools to add to this file. */ + tools: MessageAttachmentToolDefinition[]; +} + +/** The possible tools to which files will be added by this message */ +#suppress "@azure-tools/typespec-autorest/union-unsupported" "This union is defined according to the OpenAI API" +@added(ServiceApiVersions.v2024_05_01_preview) +union MessageAttachmentToolDefinition { + CodeInterpreterToolDefinition | FileSearchToolDefinition, +} + // Message content types: "text" | "image_file" @discriminator("type") @@ -147,7 +172,7 @@ model MessageTextAnnotation { // File citation annotation + details -@doc("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.") +@doc("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.") @added(ServiceApiVersions.v2024_02_15_preview) model MessageTextFileCitationAnnotation extends MessageTextAnnotation { @doc("The object type, which is always 'file_citation'.") @@ -156,7 +181,7 @@ model MessageTextFileCitationAnnotation extends MessageTextAnnotation { @encodedName("application/json", "file_citation") @doc(""" A citation within the message that points to a specific quote from a specific file. - Generated when the assistant uses the "retrieval" tool to search files. + Generated when the assistant uses the "file_search" tool to search files. """) fileCitation: MessageTextFileCitationDetails; @@ -219,27 +244,6 @@ model MessageImageFileDetails { fileId: string; } -// Assistant message file representation, used for message "list files" route responses - -@doc("Information about a file attached to an assistant thread message.") -@added(ServiceApiVersions.v2024_02_15_preview) -model MessageFile { - @doc("The identifier, which can be referenced in API endpoints.") - id: string; - - @doc("The object type, which is always 'thread.message.file'.") - object: "thread.message.file"; - - @encodedName("application/json", "created_at") - @encode(DateTimeKnownEncoding.unixTimestamp, int32) - @doc("The Unix timestamp, in seconds, representing when this object was created.") - createdAt: utcDateTime; - - @encodedName("application/json", "message_id") - @doc("The ID of the message that this file is attached to.") - messageId: string; -} - /** The possible execution status values for a thread message. */ @added(ServiceApiVersions.v2024_02_15_preview) union MessageStatus { diff --git a/specification/ai/OpenAI.Assistants/messages/routes.tsp b/specification/ai/OpenAI.Assistants/messages/routes.tsp index 356bf12e140f..9d8b27ad11f1 100644 --- a/specification/ai/OpenAI.Assistants/messages/routes.tsp +++ b/specification/ai/OpenAI.Assistants/messages/routes.tsp @@ -2,6 +2,8 @@ import "@azure-tools/typespec-azure-core"; import "@typespec/rest"; import "@typespec/http"; import "@typespec/versioning"; + +import "../main.tsp"; import "../common/models.tsp"; import "./models.tsp"; @@ -17,9 +19,6 @@ namespace Azure.AI.OpenAI.Assistants; * Creates a new message on a specified thread. * * @param threadId The ID of the thread to create the new message on. - * @param role The role to associate with the new message. - * @param content The textual content for the new message. - * @param fileIds A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. * @returns A representation of the new message. */ #suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" @@ -31,10 +30,11 @@ namespace Azure.AI.OpenAI.Assistants; @added(ServiceApiVersions.v2024_02_15_preview) op createMessage( @path threadId: string, - role: MessageRole, - content: string, - @encodedName("application/json", "file_ids") fileIds?: string[], - ...OptionalNullableMetadata, + + /** A single message within an assistant thread, as provided during that thread's creation for its initial state. */ + @added(ServiceApiVersions.v2024_05_01_preview) + @body + threadMessageOptions: ThreadMessageOptions, ): ThreadMessage; /** @@ -52,6 +52,12 @@ op createMessage( @added(ServiceApiVersions.v2024_02_15_preview) op listMessages( @path threadId: string, + + /** Filter messages by the run ID that generated them. */ + @added(ServiceApiVersions.v2024_05_01_preview) + @query + runId?: string, + ...OpenAIListRequestOptions, ): OpenAIPageableListOf; @@ -89,44 +95,3 @@ op updateMessage( @path messageId: string, ...OptionalNullableMetadata, ): ThreadMessage; - -/** - * Gets a list of previously uploaded files associated with a message from a thread. - * - * @param threadId The ID of the thread containing the message to list files from. - * @param messageId The ID of the message to list files from. - * @returns The requested list of files associated with the specified message. - */ -#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" -#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" -#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" -#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" -@get -@route("/threads/{threadId}/messages/{messageId}/files") -@added(ServiceApiVersions.v2024_02_15_preview) -op listMessageFiles( - @path threadId: string, - @path messageId: string, - ...OpenAIListRequestOptions, -): OpenAIPageableListOf; - -/** - * Gets information about a file attachment to a message within a thread. - * - * @param threadId The ID of the thread containing the message to get information from. - * @param messageId The ID of the message to get information from. - * @param fileId The ID of the file to get information about. - * @returns The requested file information. - */ -#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" -#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" -#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" -#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API name parity" -@get -@route("/threads/{threadId}/messages/{messageId}/files/{fileId}") -@added(ServiceApiVersions.v2024_02_15_preview) -op getMessageFile( - @path threadId: string, - @path messageId: string, - @path fileId: string, -): MessageFile; diff --git a/specification/ai/OpenAI.Assistants/run_steps/models.tsp b/specification/ai/OpenAI.Assistants/run_steps/models.tsp index 6a17ee099d81..89d15c2ea2bf 100644 --- a/specification/ai/OpenAI.Assistants/run_steps/models.tsp +++ b/specification/ai/OpenAI.Assistants/run_steps/models.tsp @@ -1,5 +1,7 @@ import "@typespec/versioning"; + import "../tools/models.tsp"; +import "../main.tsp"; namespace Azure.AI.OpenAI.Assistants; @@ -274,11 +276,11 @@ model RunStepDeltaFunctionToolCall extends RunStepDeltaToolCall { function?: RunStepDeltaFunction; } -/** Represents a retrieval tool call within a streaming run step's tool call details. */ -@added(ServiceApiVersions.v2024_02_15_preview) -model RunStepDeltaRetrievalToolCall extends RunStepDeltaToolCall { - /** The object type, which is always "retrieval." */ - type: "retrieval"; +/** Represents a file search tool call within a streaming run step's tool call details. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model RunStepDeltaFileSearchToolCall extends RunStepDeltaToolCall { + /** The object type, which is always "file_search." */ + type: "file_search"; /** Reserved for future use. */ @encodedName("application/json", "file_search") diff --git a/specification/ai/OpenAI.Assistants/runs/models.tsp b/specification/ai/OpenAI.Assistants/runs/models.tsp index 32f328e86fb2..08cd8e08355b 100644 --- a/specification/ai/OpenAI.Assistants/runs/models.tsp +++ b/specification/ai/OpenAI.Assistants/runs/models.tsp @@ -53,10 +53,6 @@ model ThreadRun { @doc("The overridden enabled tools used for this assistant thread run.") tools: ToolDefinition[] = []; - @encodedName("application/json", "file_ids") - @doc("A list of attached file IDs, ordered by creation date in ascending order.") - fileIds: string[] = []; - @encodedName("application/json", "created_at") @encode(DateTimeKnownEncoding.unixTimestamp, int32) @doc("The Unix timestamp, in seconds, representing when this object was created.") @@ -105,6 +101,49 @@ model ThreadRun { @added(ServiceApiVersions.v2024_02_15_preview) usage: RunCompletionUsage | null; + /** The sampling temperature used for this run. If not set, defaults to 1. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @added(ServiceApiVersions.v2024_05_01_preview) + temperature?: float32 | null; + + /** The nucleus sampling value used for this run. If not set, defaults to 1. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "top_p") + @added(ServiceApiVersions.v2024_05_01_preview) + topP?: float32 | null; + + /** The maximum number of prompt tokens specified to have been used over the course of the run. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "max_prompt_tokens") + @added(ServiceApiVersions.v2024_05_01_preview) + @minValue(256) + maxPromptTokens: int32 | null; + + /** The maximum number of completion tokens specified to have been used over the course of the run. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "max_completion_tokens") + @added(ServiceApiVersions.v2024_05_01_preview) + @minValue(256) + maxCompletionTokens: int32 | null; + + /** The strategy to use for dropping messages as the context windows moves forward. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "truncation_strategy") + @added(ServiceApiVersions.v2024_05_01_preview) + truncationStrategy: TruncationObject | null; + + /** Controls whether or not and which tool is called by the model. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "tool_choice") + @added(ServiceApiVersions.v2024_05_01_preview) + toolChoice: AssistantsApiToolChoiceOption | null; + + /** The response format of the tool calls used in this run. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "response_format") + @added(ServiceApiVersions.v2024_05_01_preview) + responseFormat: AssistantsApiResponseFormatOption | null; + ...RequiredNullableMetadata; } @@ -120,7 +159,9 @@ union IncompleteRunDetails { maxPromptTokens: "max_prompt_tokens", } -@doc("Usage statistics related to the run.") +/** + * 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.). + */ @added(ServiceApiVersions.v2024_02_15_preview) model RunCompletionUsage { @doc("Number of completion tokens used over the course of the run.") @@ -159,6 +200,12 @@ model CreateRunOptions { """) additionalInstructions?: string | null; + /** Adds additional messages to the thread before creating the run. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "additional_messages") + @added(ServiceApiVersions.v2024_05_01_preview) + additionalMessages?: ThreadMessage[] | null; + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" @doc("The overridden list of enabled tools that the assistant should use to run the thread.") tools?: ToolDefinition[] | null; @@ -170,6 +217,70 @@ model CreateRunOptions { @added(ServiceApiVersions.v2024_02_15_preview) stream?: boolean; + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @minValue(0) + @maxValue(2) + @added(ServiceApiVersions.v2024_05_01_preview) + temperature?: float32 | null = 1; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @minValue(0) + @maxValue(1) + @encodedName("application/json", "top_p") + @added(ServiceApiVersions.v2024_05_01_preview) + topP?: float32 | null = 1; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @minValue(256) + @encodedName("application/json", "max_prompt_tokens") + @added(ServiceApiVersions.v2024_05_01_preview) + maxPromptTokens?: int32 | null; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @minValue(256) + @encodedName("application/json", "max_completion_tokens") + @added(ServiceApiVersions.v2024_05_01_preview) + maxCompletionTokens?: int32 | null; + + /** The strategy to use for dropping messages as the context windows moves forward. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "truncation_strategy") + @added(ServiceApiVersions.v2024_05_01_preview) + truncationStrategy?: TruncationObject | null; + + /** Controls whether or not and which tool is called by the model. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "tool_choice") + @added(ServiceApiVersions.v2024_05_01_preview) + toolChoice?: AssistantsApiToolChoiceOption | null; + + /** Specifies the format that the model must output. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "response_format") + @added(ServiceApiVersions.v2024_05_01_preview) + responseFormat?: AssistantsApiResponseFormatOption | null; + ...OptionalNullableMetadata; } @@ -265,6 +376,12 @@ model CreateAndRunThreadOptions { @clientName("overrideTools", "csharp") tools?: ToolDefinition[] | null; + /** Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "tool_resources") + @added(ServiceApiVersions.v2024_05_01_preview) + toolResources?: UpdateToolResourcesOptions | null; + /** * 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. @@ -272,5 +389,106 @@ model CreateAndRunThreadOptions { @added(ServiceApiVersions.v2024_02_15_preview) stream?: boolean; + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @minValue(0) + @maxValue(2) + @added(ServiceApiVersions.v2024_05_01_preview) + temperature?: float32 | null = 1; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @minValue(0) + @maxValue(1) + @encodedName("application/json", "top_p") + @added(ServiceApiVersions.v2024_05_01_preview) + topP?: float32 | null = 1; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @minValue(256) + @encodedName("application/json", "max_prompt_tokens") + @added(ServiceApiVersions.v2024_05_01_preview) + maxPromptTokens?: int32 | null; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @minValue(256) + @encodedName("application/json", "max_completion_tokens") + @added(ServiceApiVersions.v2024_05_01_preview) + maxCompletionTokens?: int32 | null; + + /** The strategy to use for dropping messages as the context windows moves forward. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "truncation_strategy") + @added(ServiceApiVersions.v2024_05_01_preview) + truncationStrategy?: TruncationObject | null; + + /** Controls whether or not and which tool is called by the model. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "tool_choice") + @added(ServiceApiVersions.v2024_05_01_preview) + toolChoice?: AssistantsApiToolChoiceOption | null; + + /** Specifies the format that the model must output. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "response_format") + @added(ServiceApiVersions.v2024_05_01_preview) + responseFormat?: AssistantsApiResponseFormatOption | null; + ...OptionalNullableMetadata; } + +/** + * Controls for how a thread will be truncated prior to the run. Use this to control the initial + * context window of the run. + */ +@added(ServiceApiVersions.v2024_05_01_preview) +model TruncationObject { + /** + * The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will + * be truncated to the `lastMessages` count 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`. + */ + type: TruncationStrategy = TruncationStrategy.auto; + + /** + * The number of most recent messages from the thread when constructing the context for the run. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @minValue(1) + @added(ServiceApiVersions.v2024_05_01_preview) + @encodedName("application/json", "last_messages") + lastMessages?: int32 | null; +} + +/** + * Possible truncation strategies for the thread. + */ +@added(ServiceApiVersions.v2024_05_01_preview) +union TruncationStrategy { + string, + + /** Default value. Messages in the middle of the thread will be dropped to fit the context length of the model. */ + auto: "auto", + + /** The thread will truncate to the `lastMessages` count of recent messages. */ + lastMessages: "last_messages", +} diff --git a/specification/ai/OpenAI.Assistants/runs/routes.tsp b/specification/ai/OpenAI.Assistants/runs/routes.tsp index d1387e794cfd..c65c2d07fa06 100644 --- a/specification/ai/OpenAI.Assistants/runs/routes.tsp +++ b/specification/ai/OpenAI.Assistants/runs/routes.tsp @@ -1,6 +1,8 @@ import "@typespec/rest"; import "@typespec/http"; import "@typespec/versioning"; + +import "../main.tsp"; import "../threads/models.tsp"; import "../runs/models.tsp"; import "./models.tsp"; diff --git a/specification/ai/OpenAI.Assistants/threads/models.tsp b/specification/ai/OpenAI.Assistants/threads/models.tsp index d4097d0fecb0..167bc432d197 100644 --- a/specification/ai/OpenAI.Assistants/threads/models.tsp +++ b/specification/ai/OpenAI.Assistants/threads/models.tsp @@ -1,7 +1,10 @@ import "@typespec/versioning"; + +import "../tools/tool_resources.tsp"; import "../common/models.tsp"; import "../messages/models.tsp"; +using TypeSpec.Http; using TypeSpec.Versioning; namespace Azure.AI.OpenAI.Assistants; @@ -20,14 +23,54 @@ model AssistantThread { @doc("The Unix timestamp, in seconds, representing when this object was created.") createdAt: utcDateTime; + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @added(ServiceApiVersions.v2024_05_01_preview) + @encodedName("application/json", "tool_resources") + toolResources: ToolResources | null; + ...RequiredNullableMetadata; } -@doc("The details used to create a new assistant thread.") +/** The details used to create a new assistant thread. */ @added(ServiceApiVersions.v2024_02_15_preview) model AssistantThreadCreationOptions { - @doc("The initial messages to associate with the new thread.") - messages?: ThreadInitializationMessage[]; + /** The initial messages to associate with the new thread. */ + @added(ServiceApiVersions.v2024_05_01_preview) + messages?: ThreadMessageOptions[]; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "tool_resources") + @added(ServiceApiVersions.v2024_05_01_preview) + toolResources?: CreateToolResourcesOptions | null; + + ...OptionalNullableMetadata; +} + +/** The details used to update an existing assistant thread */ +@added(ServiceApiVersions.v2024_02_15_preview) +model UpdateAssistantThreadOptions { + /** The ID of the thread to modify. */ + @path threadId: string; + + /** + * 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 + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "tool_resources") + @added(ServiceApiVersions.v2024_05_01_preview) + toolResources?: UpdateToolResourcesOptions | null; ...OptionalNullableMetadata; } diff --git a/specification/ai/OpenAI.Assistants/threads/routes.tsp b/specification/ai/OpenAI.Assistants/threads/routes.tsp index 6867743b97ec..53dbc7fa16de 100644 --- a/specification/ai/OpenAI.Assistants/threads/routes.tsp +++ b/specification/ai/OpenAI.Assistants/threads/routes.tsp @@ -43,6 +43,7 @@ op getThread(@path threadId: string): AssistantThread; * Modifies an existing thread. * * @param threadId The ID of the thread to modify. + * @param updateAssistantThreadOptions The details of the modification to perform on a specified thread. * @returns Information about the modified thread. */ #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" @@ -51,10 +52,7 @@ op getThread(@path threadId: string): AssistantThread; @post @route("/threads/{threadId}") @added(ServiceApiVersions.v2024_02_15_preview) -op updateThread( - @path threadId: string, - ...OptionalNullableMetadata, -): AssistantThread; +op updateThread(...UpdateAssistantThreadOptions): AssistantThread; /** * Deletes an existing thread. diff --git a/specification/ai/OpenAI.Assistants/tools/models.tsp b/specification/ai/OpenAI.Assistants/tools/models.tsp index 250013bdf449..7b0118649f98 100644 --- a/specification/ai/OpenAI.Assistants/tools/models.tsp +++ b/specification/ai/OpenAI.Assistants/tools/models.tsp @@ -25,11 +25,11 @@ model CodeInterpreterToolDefinition extends ToolDefinition { type: "code_interpreter"; } -@doc("The input definition information for a retrieval tool as used to configure an assistant.") -@added(ServiceApiVersions.v2024_02_15_preview) -model RetrievalToolDefinition extends ToolDefinition { - @doc("The object type, which is always 'retrieval'.") - type: "retrieval"; +@doc("The input definition information for a file search tool as used to configure an assistant.") +@added(ServiceApiVersions.v2024_05_01_preview) +model FileSearchToolDefinition extends ToolDefinition { + @doc("The object type, which is always 'file_search'.") + type: "file_search"; } @doc("The input definition information for a function tool as used to configure an assistant.") @@ -125,16 +125,17 @@ model RunStepCodeInterpreterToolCall extends RunStepToolCall { } @doc(""" -A record of a call to a retrieval tool, issued by the model in evaluation of a defined tool, that represents -executed retrieval actions. +A record of a call to a file search tool, issued by the model in evaluation of a defined tool, that represents +executed file search. """) -@added(ServiceApiVersions.v2024_02_15_preview) -model RunStepRetrievalToolCall extends RunStepToolCall { - @doc("The object type, which is always 'retrieval'.") - type: "retrieval"; - - @doc("The key/value pairs produced by the retrieval tool.") - retrieval: Record; +@added(ServiceApiVersions.v2024_05_01_preview) +model RunStepFileSearchToolCall extends RunStepToolCall { + @doc("The object type, which is always 'file_search'.") + type: "file_search"; + + @doc("Reserved for future use.") + @encodedName("application/json", "file_search") + fileSearch: Record; } @doc(""" @@ -230,3 +231,65 @@ model ToolOutput { @doc("The output from the tool to be submitted.") output?: string; } + +/** + * 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. + */ +#suppress "@azure-tools/typespec-autorest/union-unsupported" "This union is defined according to the OpenAI API" +@added(ServiceApiVersions.v2024_05_01_preview) +union AssistantsApiToolChoiceOption { + string, + + /** Specifies how the tool choice will be used */ + AssistantsApiToolChoiceOptionMode, + + /** Specifies a tool the model should use. Use to force the model to call a specific tool. */ + AssistantsNamedToolChoice, +} + +/** Specifies how the tool choice will be used */ +@added(ServiceApiVersions.v2024_05_01_preview) +union AssistantsApiToolChoiceOptionMode { + string, + + /** The model will not call a function and instead generates a message. */ + none: "none", + + /** The model can pick between generating a message or calling a function. */ + auto: "auto", +} +/** Specifies a tool the model should use. Use to force the model to call a specific tool. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model AssistantsNamedToolChoice { + /** the type of tool. If type is `function`, the function name must be set. */ + type: AssistantsNamedToolChoiceType; + + /** The name of the function to call */ + function?: FunctionName; +} + +/** Available tool types for assistants named tools. */ +@added(ServiceApiVersions.v2024_05_01_preview) +union AssistantsNamedToolChoiceType { + string, + + /** Tool type `function` */ + function: "function", + + /** Tool type `code_interpreter` */ + codeInterpreter: "code_interpreter", + + /** Tool type `file_search` */ + fileSearch: "file_search", +} + +/** The function name that will be used, if using the `funtion` tool */ +@added(ServiceApiVersions.v2024_05_01_preview) +model FunctionName { + /** The name of the function to call */ + name: string; +} diff --git a/specification/ai/OpenAI.Assistants/tools/tool_resources.tsp b/specification/ai/OpenAI.Assistants/tools/tool_resources.tsp new file mode 100644 index 000000000000..b3b5b81c9164 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/tools/tool_resources.tsp @@ -0,0 +1,164 @@ +import "@typespec/http"; +import "@typespec/versioning"; + +import "../main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.OpenAI.Assistants; + +// +// Response objects +// + +/** + * 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. + */ +@added(ServiceApiVersions.v2024_05_01_preview) +model ToolResources { + /** Resources to be used by the `code_interpreter tool` consisting of file IDs. */ + @encodedName("application/json", "code_interpreter") + codeInterpreter?: CodeInterpreterToolResource; + + /** Resources to be used by the `file_search` tool consisting of vector store IDs. */ + @encodedName("application/json", "file_search") + fileSearch?: FileSearchToolResource; +} + +/** + * A set of resources that are used by the `code_interpreter` tool. + */ +@added(ServiceApiVersions.v2024_05_01_preview) +model CodeInterpreterToolResource { + /** + * A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files + * associated with the tool. + */ + @encodedName("application/json", "file_ids") + @maxItems(20) + fileIds: string[] = []; +} + +/** + * A set of resources that are used by the `file_search` tool. + */ +@added(ServiceApiVersions.v2024_05_01_preview) +model FileSearchToolResource { + /** + * 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) + @encodedName("application/json", "vector_store_ids") + vectorStoreIds?: string[]; +} + +// +// Creation request objects +// + +/** + * Request object. 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. + */ +@added(ServiceApiVersions.v2024_05_01_preview) +model CreateToolResourcesOptions { + /** + * A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files + * associated with the tool. + */ + @encodedName("application/json", "code_interpreter") + codeInterpreter?: CreateCodeInterpreterToolResourceOptions; + + /** A list of vector stores or their IDs made available to the `file_search` tool. */ + @encodedName("application/json", "file_search") + fileSearch?: CreateFileSearchToolResourceOptions; +} + +/** + * A set of resources that will be used by the `code_interpreter` tool. Request object. + */ +@added(ServiceApiVersions.v2024_05_01_preview) +model CreateCodeInterpreterToolResourceOptions { + /** A list of file IDs made available to the `code_interpreter` tool. */ + @maxItems(20) + @encodedName("application/json", "file_ids") + fileIds?: string[] = []; +} + +/** + * 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. + */ +#suppress "@azure-tools/typespec-autorest/union-unsupported" "This union is defined according to the OpenAI API" +@added(ServiceApiVersions.v2024_05_01_preview) +union CreateFileSearchToolResourceOptions { + /** The vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. */ + @encodedName("application/json", "vector_store_ids") + // @maxItems(1) // this can't be applied to string[] + vectorStoreIds: string[], + + /** 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. */ + @encodedName("application/json", "vector_stores") + // @maxItems(1) // this can't be applied to string[] + vectorStores: CreateFileSearchToolResourceVectorStoreOptions[], +} + +/** File IDs associated to the vector store to be passed to the helper. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model CreateFileSearchToolResourceVectorStoreOptions { + /** A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store. */ + @encodedName("application/json", "file_ids") + @maxItems(10000) + fileIds: string[]; + + /** 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. */ + ...OptionalNullableMetadata; +} + +// +// Update request objects +// + +/** + * Request object. 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. + */ +@added(ServiceApiVersions.v2024_05_01_preview) +model UpdateToolResourcesOptions { + /** + * 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. + */ + @encodedName("application/json", "code_interpreter") + codeInterpreter?: UpdateCodeInterpreterToolResourceOptions; + + /** Overrides the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. */ + @encodedName("application/json", "file_search") + fileSearch?: UpdateFileSearchToolResourceOptions; +} + +/** Request object to update `code_interpreted` tool resources. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model UpdateCodeInterpreterToolResourceOptions { + /** A list of file IDs to override the current list of the assistant. */ + @maxItems(20) + fileIds?: string[]; +} + +/** Request object to update `file_search` tool resources. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model UpdateFileSearchToolResourceOptions { + /** A list of vector store IDs to override the current list of the assistant. */ + @maxItems(1) + vectorStoreIds?: string[]; +} diff --git a/specification/ai/OpenAI.Assistants/tspconfig.yaml b/specification/ai/OpenAI.Assistants/tspconfig.yaml index fc567429be5b..0fb0ba8bdd39 100644 --- a/specification/ai/OpenAI.Assistants/tspconfig.yaml +++ b/specification/ai/OpenAI.Assistants/tspconfig.yaml @@ -35,7 +35,7 @@ options: enable-sync-stack: true generate-tests: false custom-types-subpackage: "implementation.models" - custom-types: "FileListResponse,OpenAIPageableListOfAssistant,OpenAIPageableListOfAssistantFile,OpenAIPageableListOfMessageFile,OpenAIPageableListOfRunStep,OpenAIPageableListOfThreadMessage,OpenAIPageableListOfThreadRun" + custom-types: "FileListResponse,OpenAIPageableListOfAssistant,OpenAIPageableListOfRunStep,OpenAIPageableListOfThreadMessage,OpenAIPageableListOfThreadRun,OpenAIPageableListOfVectorStore,OpenAIPageableListOfVectorStoreFile" flavor: azure "@azure-tools/typespec-ts": package-dir: "openai" diff --git a/specification/ai/OpenAI.Assistants/vector_stores/file_batches/main.tsp b/specification/ai/OpenAI.Assistants/vector_stores/file_batches/main.tsp new file mode 100644 index 000000000000..3b662be82ec5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/vector_stores/file_batches/main.tsp @@ -0,0 +1,2 @@ +import "./models.tsp"; +import "./routes.tsp"; diff --git a/specification/ai/OpenAI.Assistants/vector_stores/file_batches/models.tsp b/specification/ai/OpenAI.Assistants/vector_stores/file_batches/models.tsp new file mode 100644 index 000000000000..e5186371e912 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/vector_stores/file_batches/models.tsp @@ -0,0 +1,46 @@ +namespace Azure.AI.OpenAI.Assistants; + +using TypeSpec.Versioning; + +/** The status of the vector store file batch. */ +union VectorStoreFileBatchStatus { + string, + + /** The vector store is still processing this file batch. */ + inProgress: "in_progress", + + /** the vector store file batch is ready for use. */ + completed: "completed", + + /** The vector store file batch was cancelled. */ + cancelled: "cancelled", + + /** The vector store file batch failed to process. */ + failed: "failed", +} + +/** A batch of files attached to a vector store. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model VectorStoreFileBatch { + /** The identifier, which can be referenced in API endpoints. */ + id: string; + + /** The object type, which is always `vector_store.file_batch`. */ + object: "vector_store.files_batch"; + + /** The Unix timestamp (in seconds) for when the vector store files batch was created. */ + @encode("unixTimestamp", int32) + @encodedName("application/json", "created_at") + createdAt: utcDateTime; + + /** The ID of the vector store that the file is attached to. */ + @encodedName("application/json", "vector_store_id") + vectorStoreId: string; + + /** The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`. */ + status: VectorStoreFileBatchStatus; + + /** Files count grouped by status processed or being processed by this vector store. */ + @encodedName("application/json", "file_counts") + fileCounts: VectorStoreFileCount; +} diff --git a/specification/ai/OpenAI.Assistants/vector_stores/file_batches/routes.tsp b/specification/ai/OpenAI.Assistants/vector_stores/file_batches/routes.tsp new file mode 100644 index 000000000000..f00e40b1b0d9 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/vector_stores/file_batches/routes.tsp @@ -0,0 +1,88 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; + +import "../../main.tsp"; +import "../../common/models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.OpenAI.Assistants; + +/** + * Create a vector store file batch. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/vector_stores/{vectorStoreId}/file_batches") +@added(ServiceApiVersions.v2024_05_01_preview) +op createVectorStoreFileBatch( + /** The ID of the vector store for which to create a File Batch. */ + @path vectorStoreId: string, + + /** A list of File IDs that the vector store should use. Useful for tools like `file_search` that can access files. */ + @minItems(1) + @maxItems(500) + @encodedName("application/json", "file_ids") + fileIds: string[], +): VectorStoreFileBatch; + +/** + * Retrieve a vector store file batch. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@route("/vector_stores/{vectorStoreId}/file_batches/{batchId}") +@added(ServiceApiVersions.v2024_05_01_preview) +op getVectorStoreFileBatch( + /** The ID of the vector store that the file batch belongs to. */ + @path vectorStoreId: string, + + /** The ID of the file batch being retrieved. */ + @path batchId: string, +): VectorStoreFileBatch; + +/** + * Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/vector_stores/{vectorStoreId}/file_batches/{batchId}/cancel") +@added(ServiceApiVersions.v2024_05_01_preview) +op cancelVectorStoreFileBatch( + /** The ID of the vector store that the file batch belongs to. */ + @path vectorStoreId: string, + + /** The ID of the file batch to cancel. */ + @path batchId: string, +): VectorStoreFileBatch; + +/** + * Returns a list of vector store files in a batch. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@route("/vector_stores/{vectorStoreId}/file_batches/{batchId}/files") +@added(ServiceApiVersions.v2024_05_01_preview) +op listVectorStoreFileBatchFiles( + /** The ID of the vector store that the file batch belongs to. */ + @path vectorStoreId: string, + + /** The ID of the file batch that the files belong to. */ + @path batchId: string, + + /** Filter by file status. */ + @query filter?: VectorStoreFileStatusFilter, + + ...OpenAIListRequestOptions, +): OpenAIPageableListOf; diff --git a/specification/ai/OpenAI.Assistants/vector_stores/files/main.tsp b/specification/ai/OpenAI.Assistants/vector_stores/files/main.tsp new file mode 100644 index 000000000000..3b662be82ec5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/vector_stores/files/main.tsp @@ -0,0 +1,2 @@ +import "./models.tsp"; +import "./routes.tsp"; diff --git a/specification/ai/OpenAI.Assistants/vector_stores/files/models.tsp b/specification/ai/OpenAI.Assistants/vector_stores/files/models.tsp new file mode 100644 index 000000000000..0889b4d96b71 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/vector_stores/files/models.tsp @@ -0,0 +1,111 @@ +namespace Azure.AI.OpenAI.Assistants; + +using TypeSpec.Versioning; + +/** Query parameter filter for vector store file retrieval endpoint */ +@added(ServiceApiVersions.v2024_05_01_preview) +union VectorStoreFileStatusFilter { + string, + + /** Retrieve only files that are currently being processed */ + inProgress: "in_progress", + + /** Retrieve only files that have been successfully processed */ + completed: "completed", + + /** Retrieve only files that have failed to process */ + failed: "failed", + + /** Retrieve only files that were cancelled */ + cancelled: "cancelled", +} + +/** Vector store file status */ +@added(ServiceApiVersions.v2024_05_01_preview) +union VectorStoreFileStatus { + string, + + /** The file is currently being processed. */ + inProgress: "in_progress", + + /** The file has been successfully processed. */ + completed: "completed", + + /** The file has failed to process. */ + failed: "failed", + + /** The file was cancelled. */ + cancelled: "cancelled", +} + +/** Error code variants for vector store file processing */ +@added(ServiceApiVersions.v2024_05_01_preview) +union VectorStoreFileErrorCode { + string, + + /** An internal error occurred. */ + internalError: "internal_error", + + /** The file was not found. */ + fileNotFound: "file_not_found", + + /** The file could not be parsed. */ + parsingError: "parsing_error", + + /** The file has an unhandled mime type. */ + unhandledMimeType: "unhandled_mime_type", +} + +/** Details on the error that may have ocurred while processing a file for this vector store */ +@added(ServiceApiVersions.v2024_05_01_preview) +model VectorStoreFileError { + /** One of `server_error` or `rate_limit_exceeded`. */ + code: VectorStoreFileErrorCode; + + /** A human-readable description of the error. */ + message: string; +} + +/** Description of a file attached to a vector store. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model VectorStoreFile { + /** The identifier, which can be referenced in API endpoints. */ + id: string; + + /** The object type, which is always `vector_store.file`. */ + object: "vector_store.file"; + + /** + * The total vector store usage in bytes. Note that this may be different from the original file + * size. + */ + @encodedName("application/json", "usage_bytes") + usageBytes: int32; + + // Tool customization: _at and created are Unix encoded utcDateTime + /** The Unix timestamp (in seconds) for when the vector store file was created. */ + @encodedName("application/json", "created_at") + @encode("unixTimestamp", int32) + createdAt: utcDateTime; + + /** The ID of the vector store that the file is attached to. */ + @encodedName("application/json", "vector_store_id") + vectorStoreId: string; + + /** 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. */ + status: VectorStoreFileStatus; + + /** The last error associated with this vector store file. Will be `null` if there are no errors. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "last_error") + lastError: VectorStoreFileError | null; +} + +/** Response object for deleting a vector store file relationship. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model VectorStoreFileDeletionStatus { + ...DeletionStatus; + + /** The object type, which is always 'vector_store.deleted'. */ + object: "vector_store.file.deleted"; +} diff --git a/specification/ai/OpenAI.Assistants/vector_stores/files/routes.tsp b/specification/ai/OpenAI.Assistants/vector_stores/files/routes.tsp new file mode 100644 index 000000000000..2f0d81651415 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/vector_stores/files/routes.tsp @@ -0,0 +1,85 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; + +import "../../main.tsp"; +import "../../common/models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.OpenAI.Assistants; + +/** + * Returns a list of vector store files. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@route("/vector_stores/{vectorStoreId}/files") +@added(ServiceApiVersions.v2024_05_01_preview) +op listVectorStoreFiles( + /** The ID of the vector store that the files belong to. */ + @path vectorStoreId: string, + + /** Filter by file status. */ + @query filter?: VectorStoreFileStatusFilter, + + ...OpenAIListRequestOptions, +): OpenAIPageableListOf; + +/** + * Create a vector store file by attaching a file to a vector store. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/vector_stores/{vectorStoreId}/files") +@added(ServiceApiVersions.v2024_05_01_preview) +op createVectorStoreFile( + /** The ID of the vector store for which to create a File. */ + @path vectorStoreId: string, + + /** A File ID that the vector store should use. Useful for tools like `file_search` that can access files. */ + @encodedName("application/json", "file_id") + @body + fileId: string, +): VectorStoreFile; + +/** + * Retrieves a vector store file. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@route("/vector_stores/{vectorStoreId}/files/{fileId}") +@added(ServiceApiVersions.v2024_05_01_preview) +op getVectorStoreFile( + /** The ID of the vector store that the file belongs to. */ + @path vectorStoreId: string, + + /** The ID of the file being retrieved. */ + @path fileId: string, +): VectorStoreFile; + +/** + * 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. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@delete +@route("/vector_stores/{vectorStoreId}/files/{fileId}") +@added(ServiceApiVersions.v2024_05_01_preview) +op deleteVectorStoreFile( + /** The ID of the vector store that the file belongs to. */ + @path vectorStoreId: string, + + /** The ID of the file to delete its relationship to the vector store. */ + @path fileId: string, +): VectorStoreFileDeletionStatus; diff --git a/specification/ai/OpenAI.Assistants/vector_stores/main.tsp b/specification/ai/OpenAI.Assistants/vector_stores/main.tsp new file mode 100644 index 000000000000..b10f4fb0fbec --- /dev/null +++ b/specification/ai/OpenAI.Assistants/vector_stores/main.tsp @@ -0,0 +1,5 @@ +import "./models.tsp"; +import "./routes.tsp"; + +import "./files/main.tsp"; +import "./file_batches/main.tsp"; diff --git a/specification/ai/OpenAI.Assistants/vector_stores/models.tsp b/specification/ai/OpenAI.Assistants/vector_stores/models.tsp new file mode 100644 index 000000000000..39242fb736a0 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/vector_stores/models.tsp @@ -0,0 +1,161 @@ +namespace Azure.AI.OpenAI.Assistants; + +using TypeSpec.Versioning; + +/** The expiration policy for a vector store. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model VectorStoreExpirationPolicy { + /** Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`. */ + anchor: VectorStoreExpirationPolicyAnchor; + + /** The anchor timestamp after which the expiration policy applies. */ + @minValue(1) + @maxValue(365) + days: int32; +} + +/** Describes the relationship between the days and the expiration of this vector store */ +@added(ServiceApiVersions.v2024_05_01_preview) +union VectorStoreExpirationPolicyAnchor { + string, + + /** The expiration policy is based on the last time the vector store was active. */ + lastActiveAt: "last_active_at", +} + +/** Vector store possible status */ +@added(ServiceApiVersions.v2024_05_01_preview) +union VectorStoreStatus { + string, + + /** expired status indicates that this vector store has expired and is no longer available for use. */ + expired: "expired", + + /** in_progress status indicates that this vector store is still processing files. */ + inProgress: "in_progress", + + /** completed status indicates that this vector store is ready for use. */ + completed: "completed", +} + +/** Counts of files processed or being processed by this vector store grouped by status. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model VectorStoreFileCount { + /** The number of files that are currently being processed. */ + @encodedName("application/json", "in_progress") + inProgress: int32; + + /** The number of files that have been successfully processed. */ + completed: int32; + + /** The number of files that have failed to process. */ + failed: int32; + + /** The number of files that were cancelled. */ + cancelled: int32; + + /** The total number of files. */ + total: int32; +} + +/** + * A vector store is a collection of processed files can be used by the `file_search` tool. + */ +@added(ServiceApiVersions.v2024_05_01_preview) +model VectorStore { + /** The identifier, which can be referenced in API endpoints. */ + id: string; + + /** The object type, which is always `vector_store` */ + object: "vector_store"; + + // Tool customization: _at and created are Unix encoded utcDateTime + /** The Unix timestamp (in seconds) for when the vector store was created. */ + @encode("unixTimestamp", int32) + @encodedName("application/json", "created_at") + createdAt: utcDateTime; + + /** The name of the vector store. */ + name: string; + + /** The total number of bytes used by the files in the vector store. */ + @encodedName("application/json", "usage_bytes") + usageBytes: int32; + + /** Files count grouped by status processed or being processed by this vector store. */ + @encodedName("application/json", "file_counts") + fileCounts: VectorStoreFileCount; + + /** 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. */ + status: VectorStoreStatus; + + /** Details on when this vector store expires */ + @encodedName("application/json", "expires_after") + expiresAfter?: VectorStoreExpirationPolicy; + + /** The Unix timestamp (in seconds) for when the vector store will expire. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encode("unixTimestamp", int32) + @encodedName("application/json", "expires_at") + expiresAt?: utcDateTime | null; + + /** The Unix timestamp (in seconds) for when the vector store was last active. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encode("unixTimestamp", int32) + @encodedName("application/json", "last_active_at") + lastActiveAt: utcDateTime | null; + + /** + * 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. + */ + ...RequiredNullableMetadata; +} + +/** Request object for creating a vector store. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model VectorStoreOptions { + /** A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files. */ + @maxItems(500) + @encodedName("application/json", "file_ids") + fileIds?: string[]; + + /** The name of the vector store. */ + name?: string; + + /** Details on when this vector store expires */ + @encodedName("application/json", "expires_after") + expiresAfter?: VectorStoreExpirationPolicy; + + ...OptionalNullableMetadata; +} + +/** Request object for updating a vector store. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model VectorStoreUpdateOptions { + /** The name of the vector store. */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + name?: string | null; + + /** Details on when this vector store expires */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "expires_after") + expiresAfter?: VectorStoreExpirationPolicy | null; + + /** + * 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. + */ + ...OptionalNullableMetadata; +} + +/** Response object for deleting a vector store. */ +@added(ServiceApiVersions.v2024_05_01_preview) +model VectorStoreDeletionStatus { + ...DeletionStatus; + + /** The object type, which is always 'vector_store.deleted'. */ + object: "vector_store.deleted"; +} diff --git a/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp b/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp new file mode 100644 index 000000000000..a01dae88426f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp @@ -0,0 +1,81 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; + +import "../main.tsp"; +import "../common/models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.OpenAI.Assistants; + +/** + * Returns a list of vector stores. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@route("/vector_stores") +@added(ServiceApiVersions.v2024_05_01_preview) +op listVectorStores( + ...OpenAIListRequestOptions, +): OpenAIPageableListOf; + +/** + * Creates a vector store. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/vector_stores") +@added(ServiceApiVersions.v2024_05_01_preview) +op createVectorStore(...VectorStoreOptions): VectorStore; + +/** + * Returns the vector store object matching the specified ID. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@route("/vector_stores/{vectorStoreId}") +@added(ServiceApiVersions.v2024_05_01_preview) +op getVectorStore( + /** The ID of the vector store to retrieve. */ + @path vectorStoreId: string, +): VectorStore; + +/** + * The ID of the vector store to modify. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/vector_stores/{vectorStoreId}") +@added(ServiceApiVersions.v2024_05_01_preview) +op modifyVectorStore( + /** The ID of the vector store to modify. */ + @path vectorStoreId: string, + + ...VectorStoreUpdateOptions, +): VectorStore; + +/** + * Deletes the vector store object matching the specified ID. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@delete +@route("/vector_stores/{vectorStoreId}") +@added(ServiceApiVersions.v2024_05_01_preview) +op deleteVectorStore( + /** The ID of the vector store to delete. */ + @path vectorStoreId: string, +): VectorStoreDeletionStatus; diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index f9ebf70421c8..e1a20fe445e2 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -259,219 +259,6 @@ } } }, - "/assistants/{assistantId}/files": { - "get": { - "operationId": "ListAssistantFiles", - "description": "Gets a list of files attached to a specific assistant, as used by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve the list of attached files for.", - "required": true, - "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.", - "required": false, - "type": "integer", - "format": "int32", - "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.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort 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.", - "required": false, - "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files attached to the specified assistant.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/AssistantFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistantFile", - "description": "Attaches a previously uploaded file to an assistant for use by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to attach the file to.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the previously uploaded file to attach.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - } - }, - "/assistants/{assistantId}/files/{fileId}": { - "get": { - "operationId": "GetAssistantFile", - "description": "Retrieves a file attached to an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant associated with the attached file.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistantFile", - "description": "Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read\nfiles.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant from which the specified file should be unlinked.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to unlink from the specified assistant.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested file association deletion.", - "schema": { - "$ref": "#/definitions/AssistantFileDeletionStatus" - } - } - } - } - }, "/files": { "get": { "operationId": "ListFiles", @@ -716,28 +503,14 @@ "description": "Modifies an existing thread.", "parameters": [ { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to modify.", - "required": true, - "type": "string" + "$ref": "#/parameters/UpdateAssistantThreadOptions.threadId" }, { "name": "body", "in": "body", "required": true, "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } + "$ref": "#/definitions/UpdateAssistantThreadOptions" } } ], @@ -897,287 +670,89 @@ "description": "The ID of the thread to create the new message on.", "required": true, "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role to associate with the new message." - }, - "content": { - "type": "string", - "description": "The textual content for the new message." - }, - "file_ids": { - "type": "array", - "description": "A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "role", - "content" - ] - } } ], "responses": { "200": { "description": "A representation of the new message.", "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}": { - "get": { - "operationId": "GetMessage", - "description": "Gets an existing message from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve the specified message from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to retrieve from the specified thread.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the requested message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - }, - "post": { - "operationId": "UpdateMessage", - "description": "Modifies an existing message on an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the specified message to modify.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to modify on the specified thread.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "A representation of the modified message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files": { - "get": { - "operationId": "ListMessageFiles", - "description": "Gets a list of previously uploaded files associated with a message from a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to list files from.", - "required": true, - "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.", - "required": false, - "type": "integer", - "format": "int32", - "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.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort 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.", - "required": false, - "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.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files associated with the specified message.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/MessageFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] + "$ref": "#/definitions/ThreadMessage" } } } } }, - "/threads/{threadId}/messages/{messageId}/files/{fileId}": { + "/threads/{threadId}/messages/{messageId}": { "get": { - "operationId": "GetMessageFile", - "description": "Gets information about a file attachment to a message within a thread.", + "operationId": "GetMessage", + "description": "Gets an existing message from an existing thread.", "parameters": [ { "name": "threadId", "in": "path", - "description": "The ID of the thread containing the message to get information from.", + "description": "The ID of the thread to retrieve the specified message from.", "required": true, "type": "string" }, { "name": "messageId", "in": "path", - "description": "The ID of the message to get information from.", + "description": "The ID of the message to retrieve from the specified thread.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A representation of the requested message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + }, + "post": { + "operationId": "UpdateMessage", + "description": "Modifies an existing message on an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread containing the specified message to modify.", "required": true, "type": "string" }, { - "name": "fileId", + "name": "messageId", "in": "path", - "description": "The ID of the file to get information about.", + "description": "The ID of the message to modify on the specified thread.", "required": true, "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } } ], "responses": { "200": { - "description": "The requested file information.", + "description": "A representation of the modified message.", "schema": { - "$ref": "#/definitions/MessageFile" + "$ref": "#/definitions/ThreadMessage" } } } @@ -1730,15 +1305,6 @@ }, "x-ms-identifiers": [] }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, "metadata": { "type": "object", "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", @@ -1757,7 +1323,6 @@ "model", "instructions", "tools", - "file_ids", "metadata" ] }, @@ -1793,15 +1358,6 @@ }, "x-ms-identifiers": [] }, - "file_ids": { - "type": "array", - "description": "A list of previously uploaded file IDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, "metadata": { "type": "object", "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", @@ -1844,72 +1400,6 @@ "object" ] }, - "AssistantFile": { - "type": "object", - "description": "Information about a file attached to an assistant, as used by tools that can read files.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file'.", - "enum": [ - "assistant.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "assistant_id": { - "type": "string", - "description": "The assistant ID that the file is attached to.", - "x-ms-client-name": "assistantId" - } - }, - "required": [ - "id", - "object", - "created_at", - "assistant_id" - ] - }, - "AssistantFileDeletionStatus": { - "type": "object", - "description": "The status of an assistant file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file.deleted'.", - "enum": [ - "assistant.file.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, "AssistantThread": { "type": "object", "description": "Information about a single thread associated with an assistant.", @@ -1954,14 +1444,6 @@ "type": "object", "description": "The details used to create a new assistant thread.", "properties": { - "messages": { - "type": "array", - "description": "The initial messages to associate with the new thread.", - "items": { - "$ref": "#/definitions/ThreadInitializationMessage" - }, - "x-ms-identifiers": [] - }, "metadata": { "type": "object", "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", @@ -2252,43 +1734,6 @@ "type" ] }, - "MessageFile": { - "type": "object", - "description": "Information about a file attached to an assistant thread message.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message.file'.", - "enum": [ - "thread.message.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "message_id": { - "type": "string", - "description": "The ID of the message that this file is attached to.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "id", - "object", - "created_at", - "message_id" - ] - }, "MessageImageFileContent": { "type": "object", "description": "A representation of image file content in a thread message.", @@ -2323,6 +1768,19 @@ "file_id" ] }, + "MessageIncompleteDetails": { + "type": "object", + "description": "Information providing additional detail about a message entering an incomplete status.", + "properties": { + "reason": { + "$ref": "#/definitions/MessageIncompleteDetailsReason", + "description": "The provided reason describing why the message was marked as incomplete." + } + }, + "required": [ + "reason" + ] + }, "MessageIncompleteDetailsReason": { "type": "string", "description": "A set of reasons describing why a message is marked as incomplete.", @@ -2481,11 +1939,11 @@ }, "MessageTextFileCitationAnnotation": { "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.", + "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": { "file_citation": { "$ref": "#/definitions/MessageTextFileCitationDetails", - "description": "A citation within the message that points to a specific quote from a specific file.\nGenerated when the assistant uses the \"retrieval\" tool to search files.", + "description": "A citation within the message that points to a specific quote from a specific file.\nGenerated when the assistant uses the \"file_search\" tool to search files.", "x-ms-client-name": "fileCitation" }, "start_index": { @@ -2693,19 +2151,9 @@ "id" ] }, - "RetrievalToolDefinition": { - "type": "object", - "description": "The input definition information for a retrieval tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "retrieval" - }, "RunCompletionUsage": { "type": "object", - "description": "Usage statistics related to the run.", + "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", @@ -3208,28 +2656,6 @@ "message_id" ] }, - "RunStepRetrievalToolCall": { - "type": "object", - "description": "A record of a call to a retrieval tool, issued by the model in evaluation of a defined tool, that represents\nexecuted retrieval actions.", - "properties": { - "retrieval": { - "type": "object", - "description": "The key/value pairs produced by the retrieval tool.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "retrieval" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepToolCall" - } - ], - "x-ms-discriminator-value": "retrieval" - }, "RunStepStatus": { "type": "string", "description": "Possible values for the status of a run step.", @@ -3404,41 +2830,6 @@ "object" ] }, - "ThreadInitializationMessage": { - "type": "object", - "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", - "properties": { - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role associated with the assistant thread message. Currently, only 'user' is supported when providing initial messages to a new thread." - }, - "content": { - "type": "string", - "description": "The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API." - }, - "file_ids": { - "type": "array", - "description": "A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can\naccess files.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "role", - "content" - ] - }, "ThreadMessage": { "type": "object", "description": "A single, existing message within an assistant thread.", @@ -3473,9 +2864,14 @@ "description": "The status of the message." }, "incomplete_details": { - "$ref": "#/definitions/MessageIncompleteDetailsReason", + "type": "object", "description": "On an incomplete message, details about why the message is incomplete.", "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/MessageIncompleteDetails" + } + ], "x-ms-client-name": "incompleteDetails" }, "completed_at": { @@ -3507,21 +2903,15 @@ "assistant_id": { "type": "string", "description": "If applicable, the ID of the assistant that authored this message.", + "x-nullable": true, "x-ms-client-name": "assistantId" }, "run_id": { "type": "string", "description": "If applicable, the ID of the run associated with the authoring of this message.", + "x-nullable": true, "x-ms-client-name": "runId" }, - "file_ids": { - "type": "array", - "description": "A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can\naccess files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, "metadata": { "type": "object", "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", @@ -3542,7 +2932,8 @@ "incomplete_at", "role", "content", - "file_ids", + "assistant_id", + "run_id", "metadata" ] }, @@ -3617,15 +3008,6 @@ }, "x-ms-identifiers": [] }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, "created_at": { "type": "integer", "format": "unixtime", @@ -3702,7 +3084,6 @@ "model", "instructions", "tools", - "file_ids", "created_at", "expires_at", "started_at", @@ -3775,15 +3156,20 @@ }, "x-ms-identifiers": [] }, - "file_ids": { - "type": "array", - "description": "The modified list of previously uploaded fileIDs to attach to the assistant.", - "default": [], - "items": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { "type": "string" - }, - "x-ms-client-name": "fileIds" - }, + } + } + } + }, + "UpdateAssistantThreadOptions": { + "type": "object", + "description": "The details used to update an existing assistant thread", + "properties": { "metadata": { "type": "object", "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", @@ -3803,6 +3189,14 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" + }, + "UpdateAssistantThreadOptions.threadId": { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to modify.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" } } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json new file mode 100644 index 000000000000..3784be740a46 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -0,0 +1,5184 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI", + "version": "2024-05-01-preview", + "description": "Azure OpenAI APIs for Assistants.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "An OpenAI endpoint supporting assistants functionality.", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "api-key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/assistants": { + "get": { + "operationId": "ListAssistants", + "description": "Gets a list of assistants that were previously created.", + "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.", + "required": false, + "type": "integer", + "format": "int32", + "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.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort 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.", + "required": false, + "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.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of assistants.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/Assistant" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateAssistant", + "description": "Creates a new assistant.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AssistantCreationOptions" + } + } + ], + "responses": { + "200": { + "description": "The new assistant instance.", + "schema": { + "$ref": "#/definitions/Assistant" + } + } + } + } + }, + "/assistants/{assistantId}": { + "get": { + "operationId": "GetAssistant", + "description": "Retrieves an existing assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested assistant instance.", + "schema": { + "$ref": "#/definitions/Assistant" + } + } + } + }, + "post": { + "operationId": "UpdateAssistant", + "description": "Modifies an existing assistant.", + "parameters": [ + { + "$ref": "#/parameters/UpdateAssistantOptions.assistantId" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAssistantOptions" + } + } + ], + "responses": { + "200": { + "description": "The updated assistant instance.", + "schema": { + "$ref": "#/definitions/Assistant" + } + } + } + }, + "delete": { + "operationId": "DeleteAssistant", + "description": "Deletes an assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Status information about the requested deletion operation.", + "schema": { + "$ref": "#/definitions/AssistantDeletionStatus" + } + } + } + } + }, + "/files": { + "get": { + "operationId": "ListFiles", + "description": "Gets a list of previously uploaded files.", + "parameters": [ + { + "name": "purpose", + "in": "query", + "description": "A value that, when provided, limits list results to files matching the corresponding purpose.", + "required": false, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch", + "batch_output", + "vision" + ], + "x-ms-enum": { + "name": "FilePurpose", + "modelAsString": true, + "values": [ + { + "name": "fineTune", + "value": "fine-tune", + "description": "Indicates a file is used for fine tuning input." + }, + { + "name": "fineTuneResults", + "value": "fine-tune-results", + "description": "Indicates a file is used for fine tuning results." + }, + { + "name": "assistants", + "value": "assistants", + "description": "Indicates a file is used as input to assistants." + }, + { + "name": "assistantsOutput", + "value": "assistants_output", + "description": "Indicates a file is used as output by assistants." + }, + { + "name": "batch", + "value": "batch", + "description": "Indicates a file is used as input to ." + }, + { + "name": "batchOutput", + "value": "batch_output", + "description": "Indicates a file is used as output by a vector store batch operation." + }, + { + "name": "vision", + "value": "vision", + "description": "Indicates a file is used as input to a vision operation." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The requested list of files.", + "schema": { + "$ref": "#/definitions/FileListResponse" + } + } + } + }, + "post": { + "operationId": "UploadFile", + "description": "Uploads a file for use by other operations.", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "name": "file", + "in": "formData", + "description": "The file data (not filename) to upload.", + "required": true, + "type": "file" + }, + { + "name": "purpose", + "in": "formData", + "description": "The intended purpose of the file.", + "required": true, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch", + "batch_output", + "vision" + ], + "x-ms-enum": { + "name": "FilePurpose", + "modelAsString": true, + "values": [ + { + "name": "fineTune", + "value": "fine-tune", + "description": "Indicates a file is used for fine tuning input." + }, + { + "name": "fineTuneResults", + "value": "fine-tune-results", + "description": "Indicates a file is used for fine tuning results." + }, + { + "name": "assistants", + "value": "assistants", + "description": "Indicates a file is used as input to assistants." + }, + { + "name": "assistantsOutput", + "value": "assistants_output", + "description": "Indicates a file is used as output by assistants." + }, + { + "name": "batch", + "value": "batch", + "description": "Indicates a file is used as input to ." + }, + { + "name": "batchOutput", + "value": "batch_output", + "description": "Indicates a file is used as output by a vector store batch operation." + }, + { + "name": "vision", + "value": "vision", + "description": "Indicates a file is used as input to a vision operation." + } + ] + } + }, + { + "name": "filename", + "in": "formData", + "description": "A filename to associate with the uploaded data.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A representation of the uploaded file.", + "schema": { + "$ref": "#/definitions/OpenAIFile" + } + } + } + } + }, + "/files/{fileId}": { + "get": { + "operationId": "GetFile", + "description": "Returns information about a specific file. Does not retrieve file content.", + "parameters": [ + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OpenAIFile" + } + } + } + }, + "delete": { + "operationId": "DeleteFile", + "description": "Delete a previously uploaded file.", + "parameters": [ + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/FileDeletionStatus" + } + } + } + } + }, + "/files/{fileId}/content": { + "get": { + "operationId": "GetFileContent", + "description": "Returns information about a specific file. Does not retrieve file content.", + "parameters": [ + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string", + "format": "byte" + } + } + } + } + }, + "/threads": { + "post": { + "operationId": "CreateThread", + "description": "Creates a new thread. Threads contain messages and can be run by assistants.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AssistantThreadCreationOptions" + } + } + ], + "responses": { + "200": { + "description": "Information about the newly created thread.", + "schema": { + "$ref": "#/definitions/AssistantThread" + } + } + } + } + }, + "/threads/{threadId}": { + "get": { + "operationId": "GetThread", + "description": "Gets information about an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to retrieve information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Information about the requested thread.", + "schema": { + "$ref": "#/definitions/AssistantThread" + } + } + } + }, + "post": { + "operationId": "UpdateThread", + "description": "Modifies an existing thread.", + "parameters": [ + { + "$ref": "#/parameters/UpdateAssistantThreadOptions.threadId" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAssistantThreadOptions" + } + } + ], + "responses": { + "200": { + "description": "Information about the modified thread.", + "schema": { + "$ref": "#/definitions/AssistantThread" + } + } + } + }, + "delete": { + "operationId": "DeleteThread", + "description": "Deletes an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Status information about the requested thread deletion operation.", + "schema": { + "$ref": "#/definitions/ThreadDeletionStatus" + } + } + } + } + }, + "/threads/{threadId}/messages": { + "get": { + "operationId": "ListMessages", + "description": "Gets a list of messages that exist on a thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to list messages from.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "query", + "description": "Filter messages by the run ID that generated them.", + "required": false, + "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.", + "required": false, + "type": "integer", + "format": "int32", + "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.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort 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.", + "required": false, + "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.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of messages.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/ThreadMessage" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateMessage", + "description": "Creates a new message on a specified thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to create the new message on.", + "required": true, + "type": "string" + }, + { + "name": "threadMessageOptions", + "in": "body", + "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", + "required": true, + "schema": { + "$ref": "#/definitions/ThreadMessageOptions" + } + } + ], + "responses": { + "200": { + "description": "A representation of the new message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + } + }, + "/threads/{threadId}/messages/{messageId}": { + "get": { + "operationId": "GetMessage", + "description": "Gets an existing message from an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to retrieve the specified message from.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to retrieve from the specified thread.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A representation of the requested message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + }, + "post": { + "operationId": "UpdateMessage", + "description": "Modifies an existing message on an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread containing the specified message to modify.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to modify on the specified thread.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "A representation of the modified message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + } + }, + "/threads/{threadId}/runs": { + "get": { + "operationId": "ListRuns", + "description": "Gets a list of runs for a specified thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to list runs from.", + "required": true, + "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.", + "required": false, + "type": "integer", + "format": "int32", + "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.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort 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.", + "required": false, + "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.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of thread runs.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/ThreadRun" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateRun", + "description": "Creates a new run for an assistant thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to run.", + "required": true, + "type": "string" + }, + { + "name": "createRunOptions", + "in": "body", + "description": "The details for the run to create.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateRunOptions" + } + } + ], + "responses": { + "200": { + "description": "Information about the new thread run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}": { + "get": { + "operationId": "GetRun", + "description": "Gets an existing run from an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to retrieve run information from.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the thread to retrieve information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested information about the specified thread run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + }, + "post": { + "operationId": "UpdateRun", + "description": "Modifies an existing thread run.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread associated with the specified run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run to modify.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "Information about the modified run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/cancel": { + "post": { + "operationId": "CancelRun", + "description": "Cancels a run of an in progress thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread being run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run to cancel.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Updated information about the cancelled run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/steps": { + "get": { + "operationId": "ListRunSteps", + "description": "Gets a list of run steps from a thread run.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread that was run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run to list steps from.", + "required": true, + "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.", + "required": false, + "type": "integer", + "format": "int32", + "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.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort 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.", + "required": false, + "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.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of run steps.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/RunStep" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/steps/{stepId}": { + "get": { + "operationId": "GetRunStep", + "description": "Gets a single run step from a thread run.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread that was run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the specific run to retrieve the step from.", + "required": true, + "type": "string" + }, + { + "name": "stepId", + "in": "path", + "description": "The ID of the step to retrieve information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Information about the requested run step.", + "schema": { + "$ref": "#/definitions/RunStep" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/submit_tool_outputs": { + "post": { + "operationId": "SubmitToolOutputsToRun", + "description": "Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread that was run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run that requires tool outputs.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "tool_outputs": { + "type": "array", + "description": "A list of tools for which the outputs are being submitted.", + "items": { + "$ref": "#/definitions/ToolOutput" + }, + "x-ms-client-name": "toolOutputs", + "x-ms-identifiers": [] + }, + "stream": { + "type": "boolean", + "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.", + "x-nullable": true + } + }, + "required": [ + "tool_outputs" + ] + } + } + ], + "responses": { + "200": { + "description": "Updated information about the run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/runs": { + "post": { + "operationId": "CreateThreadAndRun", + "description": "Creates a new assistant thread and immediately starts a run using that new thread.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateAndRunThreadOptions" + } + } + ], + "responses": { + "200": { + "description": "Information about the newly created thread.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/vector_stores": { + "get": { + "operationId": "ListVectorStores", + "description": "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.", + "required": false, + "type": "integer", + "format": "int32", + "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.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort 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.", + "required": false, + "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.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/VectorStore" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateVectorStore", + "description": "Creates a vector store.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VectorStoreOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/VectorStore" + } + } + } + } + }, + "/vector_stores/{vectorStoreId}": { + "get": { + "operationId": "GetVectorStore", + "description": "Returns the vector store object matching the specified ID.", + "parameters": [ + { + "name": "vectorStoreId", + "in": "path", + "description": "The ID of the vector store to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/VectorStore" + } + } + } + }, + "post": { + "operationId": "ModifyVectorStore", + "description": "The ID of the vector store to modify.", + "parameters": [ + { + "name": "vectorStoreId", + "in": "path", + "description": "The ID of the vector store to modify.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VectorStoreUpdateOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/VectorStore" + } + } + } + }, + "delete": { + "operationId": "DeleteVectorStore", + "description": "Deletes the vector store object matching the specified ID.", + "parameters": [ + { + "name": "vectorStoreId", + "in": "path", + "description": "The ID of the vector store to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/VectorStoreDeletionStatus" + } + } + } + } + }, + "/vector_stores/{vectorStoreId}/file_batches": { + "post": { + "operationId": "CreateVectorStoreFileBatch", + "description": "Create a vector store file batch.", + "parameters": [ + { + "name": "vectorStoreId", + "in": "path", + "description": "The ID of the vector store for which to create a File Batch.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of File IDs that the vector store should use. Useful for tools like `file_search` that can access files.", + "minItems": 1, + "maxItems": 500, + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + } + }, + "required": [ + "file_ids" + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/VectorStoreFileBatch" + } + } + } + } + }, + "/vector_stores/{vectorStoreId}/file_batches/{batchId}": { + "get": { + "operationId": "GetVectorStoreFileBatch", + "description": "Retrieve a vector store file batch.", + "parameters": [ + { + "name": "vectorStoreId", + "in": "path", + "description": "The ID of the vector store that the file batch belongs to.", + "required": true, + "type": "string" + }, + { + "name": "batchId", + "in": "path", + "description": "The ID of the file batch being retrieved.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/VectorStoreFileBatch" + } + } + } + } + }, + "/vector_stores/{vectorStoreId}/file_batches/{batchId}/cancel": { + "post": { + "operationId": "CancelVectorStoreFileBatch", + "description": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", + "parameters": [ + { + "name": "vectorStoreId", + "in": "path", + "description": "The ID of the vector store that the file batch belongs to.", + "required": true, + "type": "string" + }, + { + "name": "batchId", + "in": "path", + "description": "The ID of the file batch to cancel.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/VectorStoreFileBatch" + } + } + } + } + }, + "/vector_stores/{vectorStoreId}/file_batches/{batchId}/files": { + "get": { + "operationId": "ListVectorStoreFileBatchFiles", + "description": "Returns a list of vector store files in a batch.", + "parameters": [ + { + "name": "vectorStoreId", + "in": "path", + "description": "The ID of the vector store that the file batch belongs to.", + "required": true, + "type": "string" + }, + { + "name": "batchId", + "in": "path", + "description": "The ID of the file batch that the files belong to.", + "required": true, + "type": "string" + }, + { + "name": "filter", + "in": "query", + "description": "Filter by file status.", + "required": false, + "type": "string", + "enum": [ + "in_progress", + "completed", + "failed", + "cancelled" + ], + "x-ms-enum": { + "name": "VectorStoreFileStatusFilter", + "modelAsString": true, + "values": [ + { + "name": "inProgress", + "value": "in_progress", + "description": "Retrieve only files that are currently being processed" + }, + { + "name": "completed", + "value": "completed", + "description": "Retrieve only files that have been successfully processed" + }, + { + "name": "failed", + "value": "failed", + "description": "Retrieve only files that have failed to process" + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Retrieve only files that were cancelled" + } + ] + } + }, + { + "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.", + "required": false, + "type": "integer", + "format": "int32", + "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.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort 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.", + "required": false, + "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.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/VectorStoreFile" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + } + }, + "/vector_stores/{vectorStoreId}/files": { + "get": { + "operationId": "ListVectorStoreFiles", + "description": "Returns a list of vector store files.", + "parameters": [ + { + "name": "vectorStoreId", + "in": "path", + "description": "The ID of the vector store that the files belong to.", + "required": true, + "type": "string" + }, + { + "name": "filter", + "in": "query", + "description": "Filter by file status.", + "required": false, + "type": "string", + "enum": [ + "in_progress", + "completed", + "failed", + "cancelled" + ], + "x-ms-enum": { + "name": "VectorStoreFileStatusFilter", + "modelAsString": true, + "values": [ + { + "name": "inProgress", + "value": "in_progress", + "description": "Retrieve only files that are currently being processed" + }, + { + "name": "completed", + "value": "completed", + "description": "Retrieve only files that have been successfully processed" + }, + { + "name": "failed", + "value": "failed", + "description": "Retrieve only files that have failed to process" + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Retrieve only files that were cancelled" + } + ] + } + }, + { + "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.", + "required": false, + "type": "integer", + "format": "int32", + "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.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort 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.", + "required": false, + "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.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/VectorStoreFile" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateVectorStoreFile", + "description": "Create a vector store file by attaching a file to a vector store.", + "parameters": [ + { + "name": "vectorStoreId", + "in": "path", + "description": "The ID of the vector store for which to create a File.", + "required": true, + "type": "string" + }, + { + "name": "file_id", + "in": "body", + "description": "A File ID that the vector store should use. Useful for tools like `file_search` that can access files.", + "required": true, + "schema": { + "type": "string" + }, + "x-ms-client-name": "fileId" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/VectorStoreFile" + } + } + } + } + }, + "/vector_stores/{vectorStoreId}/files/{fileId}": { + "get": { + "operationId": "GetVectorStoreFile", + "description": "Retrieves a vector store file.", + "parameters": [ + { + "name": "vectorStoreId", + "in": "path", + "description": "The ID of the vector store that the file belongs to.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The ID of the file being retrieved.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/VectorStoreFile" + } + } + } + }, + "delete": { + "operationId": "DeleteVectorStoreFile", + "description": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted.\nTo delete the file, use the delete file endpoint.", + "parameters": [ + { + "name": "vectorStoreId", + "in": "path", + "description": "The ID of the vector store that the file belongs to.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to delete its relationship to the vector store.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/VectorStoreFileDeletionStatus" + } + } + } + } + } + }, + "definitions": { + "Assistant": { + "type": "object", + "description": "Represents an assistant that can call the model and use tools.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always assistant.", + "enum": [ + "assistant" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "name": { + "type": "string", + "description": "The name of the assistant.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "The description of the assistant.", + "x-nullable": true + }, + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "instructions": { + "type": "string", + "description": "The system instructions for the assistant to use.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The collection of tools enabled for the assistant.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "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`\ntool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/ToolResources" + } + ], + "x-ms-client-name": "toolResources" + }, + "temperature": { + "type": "number", + "format": "float", + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random,\nwhile lower values like 0.2 will make it more focused and deterministic.", + "default": 1, + "x-nullable": true + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.\nSo 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.", + "default": 1, + "x-nullable": true, + "x-ms-client-name": "topP" + }, + "response_format": { + "$ref": "#/definitions/AssistantsApiResponseFormatOption", + "description": "The response format of the tool calls used by this assistant.", + "x-nullable": true, + "x-ms-client-name": "responseFormat" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "name", + "description", + "model", + "instructions", + "tools", + "tool_resources", + "temperature", + "top_p", + "metadata" + ] + }, + "AssistantCreationOptions": { + "type": "object", + "description": "The request details to use when creating a new assistant.", + "properties": { + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "name": { + "type": "string", + "description": "The name of the new assistant.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "The description of the new assistant.", + "x-nullable": true + }, + "instructions": { + "type": "string", + "description": "The system instructions for the new assistant to use.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The collection of tools to enable for the new assistant.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "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`\ntool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/CreateToolResourcesOptions" + } + ], + "x-ms-client-name": "toolResources" + }, + "temperature": { + "type": "number", + "format": "float", + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random,\nwhile lower values like 0.2 will make it more focused and deterministic.", + "default": 1, + "x-nullable": true + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.\nSo 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.", + "default": 1, + "x-nullable": true, + "x-ms-client-name": "topP" + }, + "response_format": { + "$ref": "#/definitions/AssistantsApiResponseFormatOption", + "description": "The response format of the tool calls used by this assistant.", + "x-nullable": true, + "x-ms-client-name": "responseFormat" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "model" + ] + }, + "AssistantDeletionStatus": { + "type": "object", + "description": "The status of an assistant deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'assistant.deleted'.", + "enum": [ + "assistant.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "AssistantThread": { + "type": "object", + "description": "Information about a single thread associated with an assistant.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread'.", + "enum": [ + "thread" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "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\nof tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list\nof vector store IDs.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/ToolResources" + } + ], + "x-ms-client-name": "toolResources" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "tool_resources", + "metadata" + ] + }, + "AssistantThreadCreationOptions": { + "type": "object", + "description": "The details used to create a new assistant thread.", + "properties": { + "messages": { + "type": "array", + "description": "The initial messages to associate with the new thread.", + "items": { + "$ref": "#/definitions/ThreadMessageOptions" + }, + "x-ms-identifiers": [] + }, + "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\ntype of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires\na list of vector store IDs.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/CreateToolResourcesOptions" + } + ], + "x-ms-client-name": "toolResources" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "AssistantsApiResponseFormatOption": {}, + "AssistantsApiToolChoiceOption": {}, + "CodeInterpreterToolDefinition": { + "type": "object", + "description": "The input definition information for a code interpreter tool as used to configure an assistant.", + "allOf": [ + { + "$ref": "#/definitions/ToolDefinition" + } + ], + "x-ms-discriminator-value": "code_interpreter" + }, + "CodeInterpreterToolResource": { + "type": "object", + "description": "A set of resources that are used by the `code_interpreter` tool.", + "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\nassociated with the tool.", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + } + }, + "required": [ + "file_ids" + ] + }, + "CreateAndRunThreadOptions": { + "type": "object", + "description": "The details used when creating and immediately running a new assistant thread.", + "properties": { + "assistant_id": { + "type": "string", + "description": "The ID of the assistant for which the thread should be created.", + "x-ms-client-name": "assistantId" + }, + "thread": { + "$ref": "#/definitions/AssistantThreadCreationOptions", + "description": "The details used to create the new thread. If no thread is provided, an empty one will be created." + }, + "model": { + "type": "string", + "description": "The overridden model that the assistant should use to run the thread.", + "x-nullable": true + }, + "instructions": { + "type": "string", + "description": "The overridden system instructions the assistant should use to run the thread.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The overridden list of enabled tools the assistant should use to run the thread.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "tool_resources": { + "type": "object", + "description": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/UpdateToolResourcesOptions" + } + ], + "x-ms-client-name": "toolResources" + }, + "stream": { + "type": "boolean", + "description": "If `true`, returns a stream of events that happen during the Run as server-sent events,\nterminating when the Run enters a terminal state with a `data: [DONE]` message." + }, + "temperature": { + "type": "number", + "format": "float", + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output\nmore random, while lower values like 0.2 will make it more focused and deterministic.", + "default": 1, + "x-nullable": true + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model\nconsiders the results of the tokens with top_p probability mass. So 0.1 means only the tokens\ncomprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.", + "default": 1, + "x-nullable": true, + "x-ms-client-name": "topP" + }, + "max_prompt_tokens": { + "type": "integer", + "format": "int32", + "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\nthe number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified,\nthe run will end with status `incomplete`. See `incomplete_details` for more info.", + "x-nullable": true, + "x-ms-client-name": "maxPromptTokens" + }, + "max_completion_tokens": { + "type": "integer", + "format": "int32", + "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\nthe number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens\nspecified, the run will end with status `incomplete`. See `incomplete_details` for more info.", + "x-nullable": true, + "x-ms-client-name": "maxCompletionTokens" + }, + "truncation_strategy": { + "type": "object", + "description": "The strategy to use for dropping messages as the context windows moves forward.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/TruncationObject" + } + ], + "x-ms-client-name": "truncationStrategy" + }, + "tool_choice": { + "$ref": "#/definitions/AssistantsApiToolChoiceOption", + "description": "Controls whether or not and which tool is called by the model.", + "x-nullable": true, + "x-ms-client-name": "toolChoice" + }, + "response_format": { + "$ref": "#/definitions/AssistantsApiResponseFormatOption", + "description": "Specifies the format that the model must output.", + "x-nullable": true, + "x-ms-client-name": "responseFormat" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "assistant_id" + ] + }, + "CreateCodeInterpreterToolResourceOptions": { + "type": "object", + "description": "A set of resources that will be used by the `code_interpreter` tool. Request object.", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool.", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + } + } + }, + "CreateFileSearchToolResourceOptions": {}, + "CreateRunOptions": { + "type": "object", + "description": "The details used when creating a new run of an assistant thread.", + "properties": { + "assistant_id": { + "type": "string", + "description": "The ID of the assistant that should run the thread.", + "x-ms-client-name": "assistantId" + }, + "model": { + "type": "string", + "description": "The overridden model name that the assistant should use to run the thread.", + "x-nullable": true + }, + "instructions": { + "type": "string", + "description": "The overridden system instructions that the assistant should use to run the thread.", + "x-nullable": true + }, + "additional_instructions": { + "type": "string", + "description": "Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior\non a per-run basis without overriding other instructions.", + "x-nullable": true, + "x-ms-client-name": "additionalInstructions" + }, + "additional_messages": { + "type": "array", + "description": "Adds additional messages to the thread before creating the run.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ThreadMessage" + }, + "x-ms-client-name": "additionalMessages" + }, + "tools": { + "type": "array", + "description": "The overridden list of enabled tools that the assistant should use to run the thread.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "stream": { + "type": "boolean", + "description": "If `true`, returns a stream of events that happen during the Run as server-sent events,\nterminating when the Run enters a terminal state with a `data: [DONE]` message." + }, + "temperature": { + "type": "number", + "format": "float", + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output\nmore random, while lower values like 0.2 will make it more focused and deterministic.", + "default": 1, + "x-nullable": true + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model\nconsiders the results of the tokens with top_p probability mass. So 0.1 means only the tokens\ncomprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.", + "default": 1, + "x-nullable": true, + "x-ms-client-name": "topP" + }, + "max_prompt_tokens": { + "type": "integer", + "format": "int32", + "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\nthe number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified,\nthe run will end with status `incomplete`. See `incomplete_details` for more info.", + "x-nullable": true, + "x-ms-client-name": "maxPromptTokens" + }, + "max_completion_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort\nto use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of\ncompletion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.", + "x-nullable": true, + "x-ms-client-name": "maxCompletionTokens" + }, + "truncation_strategy": { + "type": "object", + "description": "The strategy to use for dropping messages as the context windows moves forward.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/TruncationObject" + } + ], + "x-ms-client-name": "truncationStrategy" + }, + "tool_choice": { + "$ref": "#/definitions/AssistantsApiToolChoiceOption", + "description": "Controls whether or not and which tool is called by the model.", + "x-nullable": true, + "x-ms-client-name": "toolChoice" + }, + "response_format": { + "$ref": "#/definitions/AssistantsApiResponseFormatOption", + "description": "Specifies the format that the model must output.", + "x-nullable": true, + "x-ms-client-name": "responseFormat" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "assistant_id" + ] + }, + "CreateToolResourcesOptions": { + "type": "object", + "description": "Request object. A set of resources that are used by the assistant's tools. The resources are specific to the\ntype of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search`\ntool requires a list of vector store IDs.", + "properties": { + "code_interpreter": { + "$ref": "#/definitions/CreateCodeInterpreterToolResourceOptions", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files\nassociated with the tool.", + "x-ms-client-name": "codeInterpreter" + }, + "file_search": { + "$ref": "#/definitions/CreateFileSearchToolResourceOptions", + "description": "A list of vector stores or their IDs made available to the `file_search` tool.", + "x-ms-client-name": "fileSearch" + } + } + }, + "FileDeletionStatus": { + "type": "object", + "description": "A status response from a file deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'file'.", + "enum": [ + "file" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "FileListResponse": { + "type": "object", + "description": "The response data from a file list operation.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always 'list'.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The files returned for the request.", + "items": { + "$ref": "#/definitions/OpenAIFile" + } + } + }, + "required": [ + "object", + "data" + ] + }, + "FilePurpose": { + "type": "string", + "description": "The possible values denoting the intended usage of a file.", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch", + "batch_output", + "vision" + ], + "x-ms-enum": { + "name": "FilePurpose", + "modelAsString": true, + "values": [ + { + "name": "fineTune", + "value": "fine-tune", + "description": "Indicates a file is used for fine tuning input." + }, + { + "name": "fineTuneResults", + "value": "fine-tune-results", + "description": "Indicates a file is used for fine tuning results." + }, + { + "name": "assistants", + "value": "assistants", + "description": "Indicates a file is used as input to assistants." + }, + { + "name": "assistantsOutput", + "value": "assistants_output", + "description": "Indicates a file is used as output by assistants." + }, + { + "name": "batch", + "value": "batch", + "description": "Indicates a file is used as input to ." + }, + { + "name": "batchOutput", + "value": "batch_output", + "description": "Indicates a file is used as output by a vector store batch operation." + }, + { + "name": "vision", + "value": "vision", + "description": "Indicates a file is used as input to a vision operation." + } + ] + } + }, + "FileSearchToolDefinition": { + "type": "object", + "description": "The input definition information for a file search tool as used to configure an assistant.", + "allOf": [ + { + "$ref": "#/definitions/ToolDefinition" + } + ], + "x-ms-discriminator-value": "file_search" + }, + "FileSearchToolResource": { + "type": "object", + "description": "A set of resources that are used by the `file_search` tool.", + "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\nstore attached to the assistant.", + "maxItems": 1, + "items": { + "type": "string" + }, + "x-ms-client-name": "vectorStoreIds" + } + } + }, + "FileState": { + "type": "string", + "description": "The state of the file.", + "enum": [ + "uploaded", + "pending", + "running", + "processed", + "error", + "deleting", + "deleted" + ], + "x-ms-enum": { + "name": "FileState", + "modelAsString": true, + "values": [ + { + "name": "uploaded", + "value": "uploaded", + "description": "The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for\ncompatibility. It can be categorized as an inactive state." + }, + { + "name": "pending", + "value": "pending", + "description": "The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state." + }, + { + "name": "running", + "value": "running", + "description": "The operation has started to be processed. It can be categorized as an active state." + }, + { + "name": "processed", + "value": "processed", + "description": "The operation has successfully processed and is ready for consumption. It can be categorized as a terminal state." + }, + { + "name": "error", + "value": "error", + "description": "The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state." + }, + { + "name": "deleting", + "value": "deleting", + "description": "The entity is in the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility.\nIt can be categorized as an active state." + }, + { + "name": "deleted", + "value": "deleted", + "description": "The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a\nterminal state." + } + ] + } + }, + "FunctionDefinition": { + "type": "object", + "description": "The input definition information for a function.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to be called." + }, + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "parameters": { + "description": "The parameters the functions accepts, described as a JSON Schema object." + } + }, + "required": [ + "name", + "parameters" + ] + }, + "FunctionToolDefinition": { + "type": "object", + "description": "The input definition information for a function tool as used to configure an assistant.", + "properties": { + "function": { + "$ref": "#/definitions/FunctionDefinition", + "description": "The definition of the concrete function that the function tool should call." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/ToolDefinition" + } + ], + "x-ms-discriminator-value": "function" + }, + "IncompleteRunDetails": { + "type": "string", + "description": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "enum": [ + "max_completion_tokens", + "max_prompt_tokens" + ], + "x-ms-enum": { + "name": "IncompleteRunDetails", + "modelAsString": true, + "values": [ + { + "name": "maxCompletionTokens", + "value": "max_completion_tokens", + "description": "Maximum completion tokens exceeded" + }, + { + "name": "maxPromptTokens", + "value": "max_prompt_tokens", + "description": "Maximum prompt tokens exceeded" + } + ] + } + }, + "MessageAttachment": { + "type": "object", + "description": "This describes to which tools a file has been attached.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file to attach to the message.", + "x-ms-client-name": "fileId" + }, + "tools": { + "type": "array", + "description": "The tools to add to this file.", + "items": { + "$ref": "#/definitions/MessageAttachmentToolDefinition" + } + } + }, + "required": [ + "file_id", + "tools" + ] + }, + "MessageAttachmentToolDefinition": { + "x-nullable": false + }, + "MessageContent": { + "type": "object", + "description": "An abstract representation of a single item of thread message content.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "MessageImageFileContent": { + "type": "object", + "description": "A representation of image file content in a thread message.", + "properties": { + "image_file": { + "$ref": "#/definitions/MessageImageFileDetails", + "description": "The image file for this thread message content item.", + "x-ms-client-name": "imageFile" + } + }, + "required": [ + "image_file" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageContent" + } + ], + "x-ms-discriminator-value": "image_file" + }, + "MessageImageFileDetails": { + "type": "object", + "description": "An image reference, as represented in thread message content.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID for the file associated with this image.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "MessageIncompleteDetails": { + "type": "object", + "description": "Information providing additional detail about a message entering an incomplete status.", + "properties": { + "reason": { + "$ref": "#/definitions/MessageIncompleteDetailsReason", + "description": "The provided reason describing why the message was marked as incomplete." + } + }, + "required": [ + "reason" + ] + }, + "MessageIncompleteDetailsReason": { + "type": "string", + "description": "A set of reasons describing why a message is marked as incomplete.", + "enum": [ + "content_filter", + "max_tokens", + "run_cancelled", + "run_failed", + "run_expired" + ], + "x-ms-enum": { + "name": "MessageIncompleteDetailsReason", + "modelAsString": true, + "values": [ + { + "name": "contentFilter", + "value": "content_filter", + "description": "The run generating the message was terminated due to content filter flagging." + }, + { + "name": "maxTokens", + "value": "max_tokens", + "description": "The run generating the message exhausted available tokens before completion." + }, + { + "name": "runCancelled", + "value": "run_cancelled", + "description": "The run generating the message was cancelled before completion." + }, + { + "name": "runFailed", + "value": "run_failed", + "description": "The run generating the message failed." + }, + { + "name": "runExpired", + "value": "run_expired", + "description": "The run generating the message expired." + } + ] + } + }, + "MessageRole": { + "type": "string", + "description": "The possible values for roles attributed to messages in a thread.", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "MessageRole", + "modelAsString": true, + "values": [ + { + "name": "user", + "value": "user", + "description": "The role representing the end-user." + }, + { + "name": "assistant", + "value": "assistant", + "description": "The role representing the assistant." + } + ] + } + }, + "MessageStatus": { + "type": "string", + "description": "The possible execution status values for a thread message.", + "enum": [ + "in_progress", + "incomplete", + "completed" + ], + "x-ms-enum": { + "name": "MessageStatus", + "modelAsString": true, + "values": [ + { + "name": "inProgress", + "value": "in_progress", + "description": "A run is currently creating this message." + }, + { + "name": "incomplete", + "value": "incomplete", + "description": "This message is incomplete. See incomplete_details for more information." + }, + { + "name": "completed", + "value": "completed", + "description": "This message was successfully completed by a run." + } + ] + } + }, + "MessageTextAnnotation": { + "type": "object", + "description": "An abstract representation of an annotation to text thread message content.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + }, + "text": { + "type": "string", + "description": "The textual content associated with this text annotation item." + } + }, + "discriminator": "type", + "required": [ + "type", + "text" + ] + }, + "MessageTextContent": { + "type": "object", + "description": "A representation of a textual item of thread message content.", + "properties": { + "text": { + "$ref": "#/definitions/MessageTextDetails", + "description": "The text and associated annotations for this thread message content item." + } + }, + "required": [ + "text" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageContent" + } + ], + "x-ms-discriminator-value": "text" + }, + "MessageTextDetails": { + "type": "object", + "description": "The text and associated annotations for a single item of assistant thread message content.", + "properties": { + "value": { + "type": "string", + "description": "The text data." + }, + "annotations": { + "type": "array", + "description": "A list of annotations associated with this text.", + "items": { + "$ref": "#/definitions/MessageTextAnnotation" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "value", + "annotations" + ] + }, + "MessageTextFileCitationAnnotation": { + "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": { + "file_citation": { + "$ref": "#/definitions/MessageTextFileCitationDetails", + "description": "A citation within the message that points to a specific quote from a specific file.\nGenerated when the assistant uses the \"file_search\" tool to search files.", + "x-ms-client-name": "fileCitation" + }, + "start_index": { + "type": "integer", + "format": "int32", + "description": "The first text index associated with this text annotation.", + "x-ms-client-name": "startIndex" + }, + "end_index": { + "type": "integer", + "format": "int32", + "description": "The last text index associated with this text annotation.", + "x-ms-client-name": "endIndex" + } + }, + "required": [ + "file_citation" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTextAnnotation" + } + ], + "x-ms-discriminator-value": "file_citation" + }, + "MessageTextFileCitationDetails": { + "type": "object", + "description": "A representation of a file-based text citation, as used in a file-based annotation of text thread message content.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file associated with this citation.", + "x-ms-client-name": "fileId" + }, + "quote": { + "type": "string", + "description": "The specific quote cited in the associated file." + } + }, + "required": [ + "file_id", + "quote" + ] + }, + "MessageTextFilePathAnnotation": { + "type": "object", + "description": "A citation within the message that points to a file located at a specific path.", + "properties": { + "file_path": { + "$ref": "#/definitions/MessageTextFilePathDetails", + "description": "A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.", + "x-ms-client-name": "filePath" + }, + "start_index": { + "type": "integer", + "format": "int32", + "description": "The first text index associated with this text annotation.", + "x-ms-client-name": "startIndex" + }, + "end_index": { + "type": "integer", + "format": "int32", + "description": "The last text index associated with this text annotation.", + "x-ms-client-name": "endIndex" + } + }, + "required": [ + "file_path" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTextAnnotation" + } + ], + "x-ms-discriminator-value": "file_path" + }, + "MessageTextFilePathDetails": { + "type": "object", + "description": "An encapsulation of an image file ID, as used by message image content.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the specific file that the citation is from.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "OpenAIFile": { + "type": "object", + "description": "Represents an assistant that can call the model and use tools.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always 'file'.", + "enum": [ + "file" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "bytes": { + "type": "integer", + "format": "int32", + "description": "The size of the file, in bytes." + }, + "filename": { + "type": "string", + "description": "The name of the file." + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "purpose": { + "$ref": "#/definitions/FilePurpose", + "description": "The intended purpose of a file." + }, + "status": { + "$ref": "#/definitions/FileState", + "description": "The state of the file. This field is available in Azure OpenAI only." + }, + "status_details": { + "type": "string", + "description": "The error message with details in case processing of this file failed. This field is available in Azure OpenAI only.", + "x-ms-client-name": "statusDetails" + } + }, + "required": [ + "object", + "id", + "bytes", + "filename", + "created_at", + "purpose" + ] + }, + "RequiredAction": { + "type": "object", + "description": "An abstract representation of a required action for an assistant thread run to continue.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "RequiredFunctionToolCall": { + "type": "object", + "description": "A representation of a requested call to a function tool, needed by the model to continue evaluation of a run.", + "properties": { + "function": { + "$ref": "#/definitions/RequiredFunctionToolCallDetails", + "description": "Detailed information about the function to be executed by the tool that includes name and arguments." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/RequiredToolCall" + } + ], + "x-ms-discriminator-value": "function" + }, + "RequiredFunctionToolCallDetails": { + "type": "object", + "description": "The detailed information for a function invocation, as provided by a required action invoking a function tool, that includes the name of and arguments to the function.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments to use when invoking the named function, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation." + } + }, + "required": [ + "name", + "arguments" + ] + }, + "RequiredToolCall": { + "type": "object", + "description": "An abstract representation a a tool invocation needed by the model to continue a run.", + "properties": { + "type": { + "type": "string", + "description": "The object type for the required tool call." + }, + "id": { + "type": "string", + "description": "The ID of the tool call. This ID must be referenced when submitting tool outputs." + } + }, + "discriminator": "type", + "required": [ + "type", + "id" + ] + }, + "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", + "format": "int64", + "description": "Number of completion tokens used over the course of the run.", + "x-ms-client-name": "completionTokens" + }, + "prompt_tokens": { + "type": "integer", + "format": "int64", + "description": "Number of prompt tokens used over the course of the run.", + "x-ms-client-name": "promptTokens" + }, + "total_tokens": { + "type": "integer", + "format": "int64", + "description": "Total number of tokens used (prompt + completion).", + "x-ms-client-name": "totalTokens" + } + }, + "required": [ + "completion_tokens", + "prompt_tokens", + "total_tokens" + ] + }, + "RunError": { + "type": "object", + "description": "The details of an error as encountered by an assistant thread run.", + "properties": { + "code": { + "type": "string", + "description": "The status for the error." + }, + "message": { + "type": "string", + "description": "The human-readable text associated with the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "RunStatus": { + "type": "string", + "description": "Possible values for the status of an assistant thread run.", + "enum": [ + "queued", + "in_progress", + "requires_action", + "cancelling", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunStatus", + "modelAsString": true, + "values": [ + { + "name": "queued", + "value": "queued", + "description": "Represents a run that is queued to start." + }, + { + "name": "inProgress", + "value": "in_progress", + "description": "Represents a run that is in progress." + }, + { + "name": "requiresAction", + "value": "requires_action", + "description": "Represents a run that needs another operation, such as tool output submission, to continue." + }, + { + "name": "cancelling", + "value": "cancelling", + "description": "Represents a run that is in the process of cancellation." + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Represents a run that has been cancelled." + }, + { + "name": "failed", + "value": "failed", + "description": "Represents a run that failed." + }, + { + "name": "completed", + "value": "completed", + "description": "Represents a run that successfully completed." + }, + { + "name": "expired", + "value": "expired", + "description": "Represents a run that expired before it could otherwise finish." + } + ] + } + }, + "RunStep": { + "type": "object", + "description": "Detailed information about a single step of an assistant thread run.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.run.step'.", + "enum": [ + "thread.run.step" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "type": { + "$ref": "#/definitions/RunStepType", + "description": "The type of run step, which can be either message_creation or tool_calls." + }, + "assistant_id": { + "type": "string", + "description": "The ID of the assistant associated with the run step.", + "x-ms-client-name": "assistantId" + }, + "thread_id": { + "type": "string", + "description": "The ID of the thread that was run.", + "x-ms-client-name": "threadId" + }, + "run_id": { + "type": "string", + "description": "The ID of the run that this run step is a part of.", + "x-ms-client-name": "runId" + }, + "status": { + "$ref": "#/definitions/RunStepStatus", + "description": "The status of this run step." + }, + "step_details": { + "$ref": "#/definitions/RunStepDetails", + "description": "The details for this run step.", + "x-ms-client-name": "stepDetails" + }, + "last_error": { + "type": "object", + "description": "If applicable, information about the last error encountered by this run step.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RunStepError" + } + ], + "x-ms-client-name": "lastError" + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "expired_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this item expired.", + "x-nullable": true, + "x-ms-client-name": "expiredAt" + }, + "completed_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this completed.", + "x-nullable": true, + "x-ms-client-name": "completedAt" + }, + "cancelled_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this was cancelled.", + "x-nullable": true, + "x-ms-client-name": "cancelledAt" + }, + "failed_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this failed.", + "x-nullable": true, + "x-ms-client-name": "failedAt" + }, + "usage": { + "type": "object", + "description": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RunStepCompletionUsage" + } + ] + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "type", + "assistant_id", + "thread_id", + "run_id", + "status", + "step_details", + "last_error", + "created_at", + "expired_at", + "completed_at", + "cancelled_at", + "failed_at", + "metadata" + ] + }, + "RunStepCodeInterpreterImageOutput": { + "type": "object", + "description": "A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.", + "properties": { + "image": { + "$ref": "#/definitions/RunStepCodeInterpreterImageReference", + "description": "Referential information for the image associated with this output." + } + }, + "required": [ + "image" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepCodeInterpreterToolCallOutput" + } + ], + "x-ms-discriminator-value": "image" + }, + "RunStepCodeInterpreterImageReference": { + "type": "object", + "description": "An image reference emitted by a code interpreter tool in response to a tool call by the model.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file associated with this image.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "RunStepCodeInterpreterLogOutput": { + "type": "object", + "description": "A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.", + "properties": { + "logs": { + "type": "string", + "description": "The serialized log output emitted by the code interpreter." + } + }, + "required": [ + "logs" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepCodeInterpreterToolCallOutput" + } + ], + "x-ms-discriminator-value": "logs" + }, + "RunStepCodeInterpreterToolCall": { + "type": "object", + "description": "A record of a call to a code interpreter tool, issued by the model in evaluation of a defined tool, that\nrepresents inputs and outputs consumed and emitted by the code interpreter.", + "properties": { + "code_interpreter": { + "$ref": "#/definitions/RunStepCodeInterpreterToolCallDetails", + "description": "The details of the tool call to the code interpreter tool.", + "x-ms-client-name": "codeInterpreter" + } + }, + "required": [ + "code_interpreter" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepToolCall" + } + ], + "x-ms-discriminator-value": "code_interpreter" + }, + "RunStepCodeInterpreterToolCallDetails": { + "type": "object", + "description": "The detailed information about a code interpreter invocation by the model.", + "properties": { + "input": { + "type": "string", + "description": "The input provided by the model to the code interpreter tool." + }, + "outputs": { + "type": "array", + "description": "The outputs produced by the code interpreter tool back to the model in response to the tool call.", + "items": { + "$ref": "#/definitions/RunStepCodeInterpreterToolCallOutput" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "input", + "outputs" + ] + }, + "RunStepCodeInterpreterToolCallOutput": { + "type": "object", + "description": "An abstract representation of an emitted output from a code interpreter tool.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "RunStepCompletionUsage": { + "type": "object", + "description": "Usage statistics related to the run step.", + "properties": { + "completion_tokens": { + "type": "integer", + "format": "int64", + "description": "Number of completion tokens used over the course of the run step.", + "x-ms-client-name": "completionTokens" + }, + "prompt_tokens": { + "type": "integer", + "format": "int64", + "description": "Number of prompt tokens used over the course of the run step.", + "x-ms-client-name": "promptTokens" + }, + "total_tokens": { + "type": "integer", + "format": "int64", + "description": "Total number of tokens used (prompt + completion).", + "x-ms-client-name": "totalTokens" + } + }, + "required": [ + "completion_tokens", + "prompt_tokens", + "total_tokens" + ] + }, + "RunStepDetails": { + "type": "object", + "description": "An abstract representation of the details for a run step.", + "properties": { + "type": { + "$ref": "#/definitions/RunStepType", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "RunStepError": { + "type": "object", + "description": "The error information associated with a failed run step.", + "properties": { + "code": { + "$ref": "#/definitions/RunStepErrorCode", + "description": "The error code for this error." + }, + "message": { + "type": "string", + "description": "The human-readable text associated with this error." + } + }, + "required": [ + "code", + "message" + ] + }, + "RunStepErrorCode": { + "type": "string", + "description": "Possible error code values attributable to a failed run step.", + "enum": [ + "server_error", + "rate_limit_exceeded" + ], + "x-ms-enum": { + "name": "RunStepErrorCode", + "modelAsString": true, + "values": [ + { + "name": "serverError", + "value": "server_error", + "description": "Represents a server error." + }, + { + "name": "rateLimitExceeded", + "value": "rate_limit_exceeded", + "description": "Represents an error indicating configured rate limits were exceeded." + } + ] + } + }, + "RunStepFileSearchToolCall": { + "type": "object", + "description": "A record of a call to a file search tool, issued by the model in evaluation of a defined tool, that represents\nexecuted file search.", + "properties": { + "file_search": { + "type": "object", + "description": "Reserved for future use.", + "additionalProperties": { + "type": "string" + }, + "x-ms-client-name": "fileSearch" + } + }, + "required": [ + "file_search" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepToolCall" + } + ], + "x-ms-discriminator-value": "file_search" + }, + "RunStepFunctionToolCall": { + "type": "object", + "description": "A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs\nand output consumed and emitted by the specified function.", + "properties": { + "function": { + "$ref": "#/definitions/RunStepFunctionToolCallDetails", + "description": "The detailed information about the function called by the model." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepToolCall" + } + ], + "x-ms-discriminator-value": "function" + }, + "RunStepFunctionToolCallDetails": { + "type": "object", + "description": "The detailed information about the function called by the model.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments that the model requires are provided to the named function." + }, + "output": { + "type": "string", + "description": "The output of the function, only populated for function calls that have already have had their outputs submitted.", + "x-nullable": true + } + }, + "required": [ + "name", + "arguments", + "output" + ] + }, + "RunStepMessageCreationDetails": { + "type": "object", + "description": "The detailed information associated with a message creation run step.", + "properties": { + "message_creation": { + "$ref": "#/definitions/RunStepMessageCreationReference", + "description": "Information about the message creation associated with this run step.", + "x-ms-client-name": "messageCreation" + } + }, + "required": [ + "message_creation" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepDetails" + } + ], + "x-ms-discriminator-value": "message_creation" + }, + "RunStepMessageCreationReference": { + "type": "object", + "description": "The details of a message created as a part of a run step.", + "properties": { + "message_id": { + "type": "string", + "description": "The ID of the message created by this run step.", + "x-ms-client-name": "messageId" + } + }, + "required": [ + "message_id" + ] + }, + "RunStepStatus": { + "type": "string", + "description": "Possible values for the status of a run step.", + "enum": [ + "in_progress", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunStepStatus", + "modelAsString": true, + "values": [ + { + "name": "inProgress", + "value": "in_progress", + "description": "Represents a run step still in progress." + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Represents a run step that was cancelled." + }, + { + "name": "failed", + "value": "failed", + "description": "Represents a run step that failed." + }, + { + "name": "completed", + "value": "completed", + "description": "Represents a run step that successfully completed." + }, + { + "name": "expired", + "value": "expired", + "description": "Represents a run step that expired before otherwise finishing." + } + ] + } + }, + "RunStepToolCall": { + "type": "object", + "description": "An abstract representation of a detailed tool call as recorded within a run step for an existing run.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + }, + "id": { + "type": "string", + "description": "The ID of the tool call. This ID must be referenced when you submit tool outputs." + } + }, + "discriminator": "type", + "required": [ + "type", + "id" + ] + }, + "RunStepToolCallDetails": { + "type": "object", + "description": "The detailed information associated with a run step calling tools.", + "properties": { + "tool_calls": { + "type": "array", + "description": "A list of tool call details for this run step.", + "items": { + "$ref": "#/definitions/RunStepToolCall" + }, + "x-ms-client-name": "toolCalls" + } + }, + "required": [ + "tool_calls" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepDetails" + } + ], + "x-ms-discriminator-value": "tool_calls" + }, + "RunStepType": { + "type": "string", + "description": "The possible types of run steps.", + "enum": [ + "message_creation", + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepType", + "modelAsString": true, + "values": [ + { + "name": "messageCreation", + "value": "message_creation", + "description": "Represents a run step to create a message." + }, + { + "name": "toolCalls", + "value": "tool_calls", + "description": "Represents a run step that calls tools." + } + ] + } + }, + "SubmitToolOutputsAction": { + "type": "object", + "description": "The details for required tool calls that must be submitted for an assistant thread run to continue.", + "properties": { + "submit_tool_outputs": { + "$ref": "#/definitions/SubmitToolOutputsDetails", + "description": "The details describing tools that should be called to submit tool outputs.", + "x-ms-client-name": "submitToolOutputs" + } + }, + "required": [ + "submit_tool_outputs" + ], + "allOf": [ + { + "$ref": "#/definitions/RequiredAction" + } + ], + "x-ms-discriminator-value": "submit_tool_outputs" + }, + "SubmitToolOutputsDetails": { + "type": "object", + "description": "The details describing tools that should be called to submit tool outputs.", + "properties": { + "tool_calls": { + "type": "array", + "description": "The list of tool calls that must be resolved for the assistant thread run to continue.", + "items": { + "$ref": "#/definitions/RequiredToolCall" + }, + "x-ms-client-name": "toolCalls" + } + }, + "required": [ + "tool_calls" + ] + }, + "ThreadDeletionStatus": { + "type": "object", + "description": "The status of a thread deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.deleted'.", + "enum": [ + "thread.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "ThreadMessage": { + "type": "object", + "description": "A single, existing message within an assistant thread.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.message'.", + "enum": [ + "thread.message" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "thread_id": { + "type": "string", + "description": "The ID of the thread that this message belongs to.", + "x-ms-client-name": "threadId" + }, + "status": { + "$ref": "#/definitions/MessageStatus", + "description": "The status of the message." + }, + "incomplete_details": { + "type": "object", + "description": "On an incomplete message, details about why the message is incomplete.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/MessageIncompleteDetails" + } + ], + "x-ms-client-name": "incompleteDetails" + }, + "completed_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp (in seconds) for when the message was completed.", + "x-nullable": true, + "x-ms-client-name": "completedAt" + }, + "incomplete_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", + "x-nullable": true, + "x-ms-client-name": "incompleteAt" + }, + "role": { + "$ref": "#/definitions/MessageRole", + "description": "The role associated with the assistant thread message." + }, + "content": { + "type": "array", + "description": "The list of content items associated with the assistant thread message.", + "items": { + "$ref": "#/definitions/MessageContent" + }, + "x-ms-identifiers": [] + }, + "assistant_id": { + "type": "string", + "description": "If applicable, the ID of the assistant that authored this message.", + "x-nullable": true, + "x-ms-client-name": "assistantId" + }, + "run_id": { + "type": "string", + "description": "If applicable, the ID of the run associated with the authoring of this message.", + "x-nullable": true, + "x-ms-client-name": "runId" + }, + "attachments": { + "type": "array", + "description": "A list of files attached to the message, and the tools they were added to.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/MessageAttachment" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "thread_id", + "status", + "incomplete_details", + "completed_at", + "incomplete_at", + "role", + "content", + "assistant_id", + "run_id", + "attachments", + "metadata" + ] + }, + "ThreadMessageOptions": { + "type": "object", + "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", + "properties": { + "role": { + "$ref": "#/definitions/MessageRole", + "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\nthe conversation." + }, + "content": { + "type": "string", + "description": "The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via\na separate call to the create message API." + }, + "attachments": { + "type": "array", + "description": "A list of files attached to the message, and the tools they should be added to.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/MessageAttachment" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "role", + "content" + ] + }, + "ThreadRun": { + "type": "object", + "description": "Data representing a single evaluation run of an assistant thread.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.run'.", + "enum": [ + "thread.run" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "thread_id": { + "type": "string", + "description": "The ID of the thread associated with this run.", + "x-ms-client-name": "threadId" + }, + "assistant_id": { + "type": "string", + "description": "The ID of the assistant associated with the thread this run was performed against.", + "x-ms-client-name": "assistantId" + }, + "status": { + "$ref": "#/definitions/RunStatus", + "description": "The status of the assistant thread run." + }, + "required_action": { + "type": "object", + "description": "The details of the action required for the assistant thread run to continue.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RequiredAction" + } + ], + "x-ms-client-name": "requiredAction" + }, + "last_error": { + "type": "object", + "description": "The last error, if any, encountered by this assistant thread run.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RunError" + } + ], + "x-ms-client-name": "lastError" + }, + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "instructions": { + "type": "string", + "description": "The overridden system instructions used for this assistant thread run." + }, + "tools": { + "type": "array", + "description": "The overridden enabled tools used for this assistant thread run.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "expires_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this item expires.", + "x-nullable": true, + "x-ms-client-name": "expiresAt" + }, + "started_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this item was started.", + "x-nullable": true, + "x-ms-client-name": "startedAt" + }, + "completed_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this completed.", + "x-nullable": true, + "x-ms-client-name": "completedAt" + }, + "cancelled_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this was cancelled.", + "x-nullable": true, + "x-ms-client-name": "cancelledAt" + }, + "failed_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this failed.", + "x-nullable": true, + "x-ms-client-name": "failedAt" + }, + "incomplete_details": { + "$ref": "#/definitions/IncompleteRunDetails", + "description": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "x-nullable": true, + "x-ms-client-name": "incompleteDetails" + }, + "usage": { + "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.).", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RunCompletionUsage" + } + ] + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature used for this run. If not set, defaults to 1.", + "x-nullable": true + }, + "top_p": { + "type": "number", + "format": "float", + "description": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "x-nullable": true, + "x-ms-client-name": "topP" + }, + "max_prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of prompt tokens specified to have been used over the course of the run.", + "x-nullable": true, + "x-ms-client-name": "maxPromptTokens" + }, + "max_completion_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of completion tokens specified to have been used over the course of the run.", + "x-nullable": true, + "x-ms-client-name": "maxCompletionTokens" + }, + "truncation_strategy": { + "type": "object", + "description": "The strategy to use for dropping messages as the context windows moves forward.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/TruncationObject" + } + ], + "x-ms-client-name": "truncationStrategy" + }, + "tool_choice": { + "$ref": "#/definitions/AssistantsApiToolChoiceOption", + "description": "Controls whether or not and which tool is called by the model.", + "x-nullable": true, + "x-ms-client-name": "toolChoice" + }, + "response_format": { + "$ref": "#/definitions/AssistantsApiResponseFormatOption", + "description": "The response format of the tool calls used in this run.", + "x-nullable": true, + "x-ms-client-name": "responseFormat" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "thread_id", + "assistant_id", + "status", + "last_error", + "model", + "instructions", + "tools", + "created_at", + "expires_at", + "started_at", + "completed_at", + "cancelled_at", + "failed_at", + "incomplete_details", + "usage", + "max_prompt_tokens", + "max_completion_tokens", + "truncation_strategy", + "tool_choice", + "response_format", + "metadata" + ] + }, + "ToolDefinition": { + "type": "object", + "description": "An abstract representation of an input tool definition that an assistant can use.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ToolOutput": { + "type": "object", + "description": "The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.", + "properties": { + "tool_call_id": { + "type": "string", + "description": "The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.", + "x-ms-client-name": "toolCallId" + }, + "output": { + "type": "string", + "description": "The output from the tool to be submitted." + } + } + }, + "ToolResources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of\ntool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search`\ntool requires a list of vector store IDs.", + "properties": { + "code_interpreter": { + "$ref": "#/definitions/CodeInterpreterToolResource", + "description": "Resources to be used by the `code_interpreter tool` consisting of file IDs.", + "x-ms-client-name": "codeInterpreter" + }, + "file_search": { + "$ref": "#/definitions/FileSearchToolResource", + "description": "Resources to be used by the `file_search` tool consisting of vector store IDs.", + "x-ms-client-name": "fileSearch" + } + } + }, + "TruncationObject": { + "type": "object", + "description": "Controls for how a thread will be truncated prior to the run. Use this to control the initial\ncontext 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\nbe truncated to the `lastMessages` count most recent messages in the thread. When set to `auto`, messages in the middle of the thread\nwill be dropped to fit the context length of the model, `max_prompt_tokens`.", + "default": "auto", + "enum": [ + "auto", + "last_messages" + ], + "x-ms-enum": { + "name": "TruncationStrategy", + "modelAsString": true, + "values": [ + { + "name": "auto", + "value": "auto", + "description": "Default value. Messages in the middle of the thread will be dropped to fit the context length of the model." + }, + { + "name": "lastMessages", + "value": "last_messages", + "description": "The thread will truncate to the `lastMessages` count of recent messages." + } + ] + } + }, + "last_messages": { + "type": "integer", + "format": "int32", + "description": "The number of most recent messages from the thread when constructing the context for the run.", + "x-nullable": true, + "x-ms-client-name": "lastMessages" + } + }, + "required": [ + "type" + ] + }, + "UpdateAssistantOptions": { + "type": "object", + "description": "The request details to use when modifying an existing assistant.", + "properties": { + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "name": { + "type": "string", + "description": "The modified name for the assistant to use.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "The modified description for the assistant to use.", + "x-nullable": true + }, + "instructions": { + "type": "string", + "description": "The modified system instructions for the new assistant to use.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The modified collection of tools to enable for the assistant.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "tool_resources": { + "$ref": "#/definitions/UpdateToolResourcesOptions", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example,\nthe `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.", + "x-ms-client-name": "toolResources" + }, + "temperature": { + "type": "number", + "format": "float", + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random,\nwhile lower values like 0.2 will make it more focused and deterministic.", + "default": 1, + "x-nullable": true + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.\nSo 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.", + "default": 1, + "x-nullable": true, + "x-ms-client-name": "topP" + }, + "response_format": { + "$ref": "#/definitions/AssistantsApiResponseFormatOption", + "description": "The response format of the tool calls used by this assistant.", + "x-nullable": true, + "x-ms-client-name": "responseFormat" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "UpdateAssistantThreadOptions": { + "type": "object", + "description": "The details used to update an existing assistant thread", + "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\ntype of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires\na list of vector store IDs", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/UpdateToolResourcesOptions" + } + ], + "x-ms-client-name": "toolResources" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "UpdateCodeInterpreterToolResourceOptions": { + "type": "object", + "description": "Request object to update `code_interpreted` tool resources.", + "properties": { + "fileIds": { + "type": "array", + "description": "A list of file IDs to override the current list of the assistant.", + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "UpdateFileSearchToolResourceOptions": { + "type": "object", + "description": "Request object to update `file_search` tool resources.", + "properties": { + "vectorStoreIds": { + "type": "array", + "description": "A list of vector store IDs to override the current list of the assistant.", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + }, + "UpdateToolResourcesOptions": { + "type": "object", + "description": "Request object. A set of resources that are used by the assistant's tools. The resources are specific to the type of tool.\nFor example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of\nvector store IDs.", + "properties": { + "code_interpreter": { + "$ref": "#/definitions/UpdateCodeInterpreterToolResourceOptions", + "description": "Overrides the list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files\nassociated with the tool.", + "x-ms-client-name": "codeInterpreter" + }, + "file_search": { + "$ref": "#/definitions/UpdateFileSearchToolResourceOptions", + "description": "Overrides the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.", + "x-ms-client-name": "fileSearch" + } + } + }, + "VectorStore": { + "type": "object", + "description": "A vector store is a collection of processed files can be used by the `file_search` tool.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always `vector_store`", + "enum": [ + "vector_store" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp (in seconds) for when the vector store was created.", + "x-ms-client-name": "createdAt" + }, + "name": { + "type": "string", + "description": "The name of the vector store." + }, + "usage_bytes": { + "type": "integer", + "format": "int32", + "description": "The total number of bytes used by the files in the vector store.", + "x-ms-client-name": "usageBytes" + }, + "file_counts": { + "$ref": "#/definitions/VectorStoreFileCount", + "description": "Files count grouped by status processed or being processed by this vector store.", + "x-ms-client-name": "fileCounts" + }, + "status": { + "$ref": "#/definitions/VectorStoreStatus", + "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." + }, + "expires_after": { + "$ref": "#/definitions/VectorStoreExpirationPolicy", + "description": "Details on when this vector store expires", + "x-ms-client-name": "expiresAfter" + }, + "expires_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp (in seconds) for when the vector store will expire.", + "x-nullable": true, + "x-ms-client-name": "expiresAt" + }, + "last_active_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp (in seconds) for when the vector store was last active.", + "x-nullable": true, + "x-ms-client-name": "lastActiveAt" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "name", + "usage_bytes", + "file_counts", + "status", + "last_active_at", + "metadata" + ] + }, + "VectorStoreDeletionStatus": { + "type": "object", + "description": "Response object for deleting a vector store.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'vector_store.deleted'.", + "enum": [ + "vector_store.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "VectorStoreExpirationPolicy": { + "type": "object", + "description": "The expiration policy for a vector store.", + "properties": { + "anchor": { + "$ref": "#/definitions/VectorStoreExpirationPolicyAnchor", + "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`." + }, + "days": { + "type": "integer", + "format": "int32", + "description": "The anchor timestamp after which the expiration policy applies.", + "minimum": 1, + "maximum": 365 + } + }, + "required": [ + "anchor", + "days" + ] + }, + "VectorStoreExpirationPolicyAnchor": { + "type": "string", + "description": "Describes the relationship between the days and the expiration of this vector store", + "enum": [ + "last_active_at" + ], + "x-ms-enum": { + "name": "VectorStoreExpirationPolicyAnchor", + "modelAsString": true, + "values": [ + { + "name": "lastActiveAt", + "value": "last_active_at", + "description": "The expiration policy is based on the last time the vector store was active." + } + ] + } + }, + "VectorStoreFile": { + "type": "object", + "description": "Description of a file attached to a vector store.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always `vector_store.file`.", + "enum": [ + "vector_store.file" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "usage_bytes": { + "type": "integer", + "format": "int32", + "description": "The total vector store usage in bytes. Note that this may be different from the original file\nsize.", + "x-ms-client-name": "usageBytes" + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp (in seconds) for when the vector store file was created.", + "x-ms-client-name": "createdAt" + }, + "vector_store_id": { + "type": "string", + "description": "The ID of the vector store that the file is attached to.", + "x-ms-client-name": "vectorStoreId" + }, + "status": { + "$ref": "#/definitions/VectorStoreFileStatus", + "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." + }, + "last_error": { + "type": "object", + "description": "The last error associated with this vector store file. Will be `null` if there are no errors.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/VectorStoreFileError" + } + ], + "x-ms-client-name": "lastError" + } + }, + "required": [ + "id", + "object", + "usage_bytes", + "created_at", + "vector_store_id", + "status", + "last_error" + ] + }, + "VectorStoreFileBatch": { + "type": "object", + "description": "A batch of files attached to a vector store.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always `vector_store.file_batch`.", + "enum": [ + "vector_store.files_batch" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp (in seconds) for when the vector store files batch was created.", + "x-ms-client-name": "createdAt" + }, + "vector_store_id": { + "type": "string", + "description": "The ID of the vector store that the file is attached to.", + "x-ms-client-name": "vectorStoreId" + }, + "status": { + "$ref": "#/definitions/VectorStoreFileBatchStatus", + "description": "The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`." + }, + "file_counts": { + "$ref": "#/definitions/VectorStoreFileCount", + "description": "Files count grouped by status processed or being processed by this vector store.", + "x-ms-client-name": "fileCounts" + } + }, + "required": [ + "id", + "object", + "created_at", + "vector_store_id", + "status", + "file_counts" + ] + }, + "VectorStoreFileBatchStatus": { + "type": "string", + "description": "The status of the vector store file batch.", + "enum": [ + "in_progress", + "completed", + "cancelled", + "failed" + ], + "x-ms-enum": { + "name": "VectorStoreFileBatchStatus", + "modelAsString": true, + "values": [ + { + "name": "inProgress", + "value": "in_progress", + "description": "The vector store is still processing this file batch." + }, + { + "name": "completed", + "value": "completed", + "description": "the vector store file batch is ready for use." + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "The vector store file batch was cancelled." + }, + { + "name": "failed", + "value": "failed", + "description": "The vector store file batch failed to process." + } + ] + } + }, + "VectorStoreFileCount": { + "type": "object", + "description": "Counts of files processed or being processed by this vector store grouped by status.", + "properties": { + "in_progress": { + "type": "integer", + "format": "int32", + "description": "The number of files that are currently being processed.", + "x-ms-client-name": "inProgress" + }, + "completed": { + "type": "integer", + "format": "int32", + "description": "The number of files that have been successfully processed." + }, + "failed": { + "type": "integer", + "format": "int32", + "description": "The number of files that have failed to process." + }, + "cancelled": { + "type": "integer", + "format": "int32", + "description": "The number of files that were cancelled." + }, + "total": { + "type": "integer", + "format": "int32", + "description": "The total number of files." + } + }, + "required": [ + "in_progress", + "completed", + "failed", + "cancelled", + "total" + ] + }, + "VectorStoreFileDeletionStatus": { + "type": "object", + "description": "Response object for deleting a vector store file relationship.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'vector_store.deleted'.", + "enum": [ + "vector_store.file.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "VectorStoreFileError": { + "type": "object", + "description": "Details on the error that may have ocurred while processing a file for this vector store", + "properties": { + "code": { + "$ref": "#/definitions/VectorStoreFileErrorCode", + "description": "One of `server_error` or `rate_limit_exceeded`." + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "VectorStoreFileErrorCode": { + "type": "string", + "description": "Error code variants for vector store file processing", + "enum": [ + "internal_error", + "file_not_found", + "parsing_error", + "unhandled_mime_type" + ], + "x-ms-enum": { + "name": "VectorStoreFileErrorCode", + "modelAsString": true, + "values": [ + { + "name": "internalError", + "value": "internal_error", + "description": "An internal error occurred." + }, + { + "name": "fileNotFound", + "value": "file_not_found", + "description": "The file was not found." + }, + { + "name": "parsingError", + "value": "parsing_error", + "description": "The file could not be parsed." + }, + { + "name": "unhandledMimeType", + "value": "unhandled_mime_type", + "description": "The file has an unhandled mime type." + } + ] + } + }, + "VectorStoreFileStatus": { + "type": "string", + "description": "Vector store file status", + "enum": [ + "in_progress", + "completed", + "failed", + "cancelled" + ], + "x-ms-enum": { + "name": "VectorStoreFileStatus", + "modelAsString": true, + "values": [ + { + "name": "inProgress", + "value": "in_progress", + "description": "The file is currently being processed." + }, + { + "name": "completed", + "value": "completed", + "description": "The file has been successfully processed." + }, + { + "name": "failed", + "value": "failed", + "description": "The file has failed to process." + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "The file was cancelled." + } + ] + } + }, + "VectorStoreOptions": { + "type": "object", + "description": "Request object for creating a vector store.", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files.", + "maxItems": 500, + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "name": { + "type": "string", + "description": "The name of the vector store." + }, + "expires_after": { + "$ref": "#/definitions/VectorStoreExpirationPolicy", + "description": "Details on when this vector store expires", + "x-ms-client-name": "expiresAfter" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "VectorStoreStatus": { + "type": "string", + "description": "Vector store possible status", + "enum": [ + "expired", + "in_progress", + "completed" + ], + "x-ms-enum": { + "name": "VectorStoreStatus", + "modelAsString": true, + "values": [ + { + "name": "expired", + "value": "expired", + "description": "expired status indicates that this vector store has expired and is no longer available for use." + }, + { + "name": "inProgress", + "value": "in_progress", + "description": "in_progress status indicates that this vector store is still processing files." + }, + { + "name": "completed", + "value": "completed", + "description": "completed status indicates that this vector store is ready for use." + } + ] + } + }, + "VectorStoreUpdateOptions": { + "type": "object", + "description": "Request object for updating a vector store.", + "properties": { + "name": { + "type": "string", + "description": "The name of the vector store.", + "x-nullable": true + }, + "expires_after": { + "type": "object", + "description": "Details on when this vector store expires", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/VectorStoreExpirationPolicy" + } + ], + "x-ms-client-name": "expiresAfter" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": { + "UpdateAssistantOptions.assistantId": { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to modify.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "UpdateAssistantThreadOptions.threadId": { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to modify.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml index dad7788dcc2c..5d101eb1cb50 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml @@ -141,156 +141,6 @@ paths: application/json: schema: $ref: '#/components/schemas/AssistantDeletionStatus' - /assistants/{assistantId}/files: - post: - operationId: createAssistantFile - description: Attaches a previously uploaded file to an assistant for use by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to attach the file to. - schema: - type: string - responses: - '200': - description: Information about the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - file_id: - type: string - description: The ID of the previously uploaded file to attach. - required: - - file_id - get: - operationId: listAssistantFiles - description: Gets a list of files attached to a specific assistant, as used by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve the list of attached files for. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - 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 - required: false - 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 - responses: - '200': - description: The requested list of files attached to the specified assistant. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/AssistantFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}/files/{fileId}: - get: - operationId: getAssistantFile - description: Retrieves a file attached to an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant associated with the attached file. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: A representation of the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - delete: - operationId: deleteAssistantFile - description: |- - Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read - files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant from which the specified file should be unlinked. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to unlink from the specified assistant. - schema: - type: string - responses: - '200': - description: Status information about the requested file association deletion. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFileDeletionStatus' /files: get: operationId: listFiles @@ -452,12 +302,7 @@ paths: operationId: updateThread description: Modifies an existing thread. parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to modify. - schema: - type: string + - $ref: '#/components/parameters/UpdateAssistantThreadOptions.threadId' responses: '200': description: Information about the modified thread. @@ -470,14 +315,7 @@ paths: content: application/json: schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + $ref: '#/components/schemas/UpdateAssistantThreadOptions' delete: operationId: deleteThread description: Deletes an existing thread. @@ -513,34 +351,6 @@ paths: application/json: schema: $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role to associate with the new message. - content: - type: string - description: The textual content for the new message. - file_ids: - type: array - items: - type: string - description: A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - role - - content get: operationId: listMessages description: Gets a list of messages that exist on a thread. @@ -672,114 +482,6 @@ paths: type: string nullable: true description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/messages/{messageId}/files: - get: - operationId: listMessageFiles - description: Gets a list of previously uploaded files associated with a message from a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to list files from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to list files from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - 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 - required: false - 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 - responses: - '200': - description: The requested list of files associated with the specified message. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/MessageFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}/files/{fileId}: - get: - operationId: getMessageFile - description: Gets information about a file attachment to a message within a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to get information from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to get information from. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to get information about. - schema: - type: string - responses: - '200': - description: The requested file information. - content: - application/json: - schema: - $ref: '#/components/schemas/MessageFile' /threads/{threadId}/runs: post: operationId: createRun @@ -1123,6 +825,13 @@ components: description: The ID of the assistant to modify. schema: type: string + UpdateAssistantThreadOptions.threadId: + name: threadId + in: path + required: true + description: The ID of the thread to modify. + schema: + type: string schemas: Assistant: type: object @@ -1135,7 +844,6 @@ components: - model - instructions - tools - - file_ids - metadata properties: id: @@ -1171,12 +879,6 @@ components: $ref: '#/components/schemas/ToolDefinition' description: The collection of tools enabled for the assistant. default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] metadata: type: object additionalProperties: @@ -1210,12 +912,6 @@ components: $ref: '#/components/schemas/ToolDefinition' description: The collection of tools to enable for the new assistant. default: [] - file_ids: - type: array - items: - type: string - description: A list of previously uploaded file IDs to attach to the assistant. - default: [] metadata: type: object additionalProperties: @@ -1242,49 +938,6 @@ components: - assistant.deleted description: The object type, which is always 'assistant.deleted'. description: The status of an assistant deletion operation. - AssistantFile: - type: object - required: - - id - - object - - created_at - - assistant_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant.file - description: The object type, which is always 'assistant.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - assistant_id: - type: string - description: The assistant ID that the file is attached to. - description: Information about a file attached to an assistant, as used by tools that can read files. - AssistantFileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.file.deleted - description: The object type, which is always 'assistant.file.deleted'. - description: The status of an assistant file deletion operation. AssistantStreamEvent: anyOf: - type: string @@ -1342,11 +995,6 @@ components: AssistantThreadCreationOptions: type: object properties: - messages: - type: array - items: - $ref: '#/components/schemas/ThreadInitializationMessage' - description: The initial messages to associate with the new thread. metadata: type: object additionalProperties: @@ -1768,30 +1416,6 @@ components: allOf: - $ref: '#/components/schemas/MessageDeltaTextAnnotation' description: Represents a streamed file path annotation applied to a streaming text content part. - MessageFile: - type: object - required: - - id - - object - - created_at - - message_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message.file - description: The object type, which is always 'thread.message.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - message_id: - type: string - description: The ID of the message that this file is attached to. - description: Information about a file attached to an assistant thread message. MessageImageFileContent: type: object required: @@ -1935,7 +1559,7 @@ components: - $ref: '#/components/schemas/MessageTextFileCitationDetails' description: |- A citation within the message that points to a specific quote from a specific file. - Generated when the assistant uses the "retrieval" tool to search files. + Generated when the assistant uses the "file_search" tool to search files. start_index: type: integer format: int32 @@ -1946,7 +1570,7 @@ components: description: The last text index associated with this text annotation. allOf: - $ref: '#/components/schemas/MessageTextAnnotation' - 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. + 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. MessageTextFileCitationDetails: type: object required: @@ -2090,19 +1714,6 @@ components: mapping: function: '#/components/schemas/RequiredFunctionToolCall' description: An abstract representation a a tool invocation needed by the model to continue a run. - RetrievalToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a retrieval tool as used to configure an assistant. RunCompletionUsage: type: object required: @@ -2122,7 +1733,7 @@ components: type: integer format: int64 description: Total number of tokens used (prompt + completion). - description: Usage statistics related to the run. + 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.). RunError: type: object required: @@ -2542,24 +2153,6 @@ components: type: string description: The ID of the newly-created message. description: Represents the data within a streaming run step message creation response object. - RunStepDeltaRetrievalToolCall: - type: object - required: - - type - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always "retrieval." - file_search: - type: object - additionalProperties: - type: string - description: Reserved for future use. - allOf: - - $ref: '#/components/schemas/RunStepDeltaToolCall' - description: Represents a retrieval tool call within a streaming run step's tool call details. RunStepDeltaToolCall: type: object required: @@ -2581,7 +2174,6 @@ components: propertyName: type mapping: function: '#/components/schemas/RunStepDeltaFunctionToolCall' - retrieval: '#/components/schemas/RunStepDeltaRetrievalToolCall' code_interpreter: '#/components/schemas/RunStepDeltaCodeInterpreterToolCall' description: The abstract base representation of a single tool call within a streaming run step's delta tool call details. RunStepDeltaToolCallObject: @@ -2704,27 +2296,6 @@ components: type: string description: The ID of the message created by this run step. description: The details of a message created as a part of a run step. - RunStepRetrievalToolCall: - type: object - required: - - type - - retrieval - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - retrieval: - type: object - additionalProperties: - type: string - description: The key/value pairs produced by the retrieval tool. - allOf: - - $ref: '#/components/schemas/RunStepToolCall' - description: |- - A record of a call to a retrieval tool, issued by the model in evaluation of a defined tool, that represents - executed retrieval actions. RunStepStatus: anyOf: - type: string @@ -2765,7 +2336,6 @@ components: propertyName: type mapping: code_interpreter: '#/components/schemas/RunStepCodeInterpreterToolCall' - retrieval: '#/components/schemas/RunStepRetrievalToolCall' function: '#/components/schemas/RunStepFunctionToolCall' description: An abstract representation of a detailed tool call as recorded within a run step for an existing run. RunStepToolCallDetails: @@ -2814,6 +2384,7 @@ components: type: string enum: - 2024-02-15-preview + - 2024-05-01-preview description: The known set of supported API versions. SubmitToolOutputsAction: type: object @@ -2863,34 +2434,6 @@ components: - thread.deleted description: The object type, which is always 'thread.deleted'. description: The status of a thread deletion operation. - ThreadInitializationMessage: - type: object - required: - - role - - content - properties: - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role associated with the assistant thread message. Currently, only 'user' is supported when providing initial messages to a new thread. - content: - type: string - description: The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API. - file_ids: - type: array - items: - type: string - description: |- - A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can - access files. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: A single message within an assistant thread, as provided during that thread's creation for its initial state. ThreadMessage: type: object required: @@ -2904,7 +2447,8 @@ components: - incomplete_at - role - content - - file_ids + - assistant_id + - run_id - metadata properties: id: @@ -2927,8 +2471,9 @@ components: - $ref: '#/components/schemas/MessageStatus' description: The status of the message. incomplete_details: - oneOf: - - $ref: '#/components/schemas/MessageIncompleteDetailsReason' + type: object + allOf: + - $ref: '#/components/schemas/MessageIncompleteDetails' nullable: true description: On an incomplete message, details about why the message is incomplete. completed_at: @@ -2952,17 +2497,12 @@ components: description: The list of content items associated with the assistant thread message. assistant_id: type: string + nullable: true description: If applicable, the ID of the assistant that authored this message. run_id: type: string + nullable: true description: If applicable, the ID of the run associated with the authoring of this message. - file_ids: - type: array - items: - type: string - description: |- - A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can - access files. metadata: type: object additionalProperties: @@ -2982,7 +2522,6 @@ components: - model - instructions - tools - - file_ids - created_at - expires_at - started_at @@ -3035,12 +2574,6 @@ components: $ref: '#/components/schemas/ToolDefinition' description: The overridden enabled tools used for this assistant thread run. default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] created_at: type: integer format: unixtime @@ -3107,7 +2640,6 @@ components: propertyName: type mapping: code_interpreter: '#/components/schemas/CodeInterpreterToolDefinition' - retrieval: '#/components/schemas/RetrievalToolDefinition' function: '#/components/schemas/FunctionToolDefinition' description: An abstract representation of an input tool definition that an assistant can use. ToolOutput: @@ -3144,12 +2676,6 @@ components: $ref: '#/components/schemas/ToolDefinition' description: The modified collection of tools to enable for the assistant. default: [] - file_ids: - type: array - items: - type: string - description: The modified list of previously uploaded fileIDs to attach to the assistant. - default: [] metadata: type: object additionalProperties: @@ -3157,6 +2683,26 @@ components: nullable: true description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. description: The request details to use when modifying an existing assistant. + UpdateAssistantThreadOptions: + type: object + properties: + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The details used to update an existing assistant thread + VectorStoreFileBatchStatus: + anyOf: + - type: string + - type: string + enum: + - in_progress + - completed + - cancelled + - failed + description: The status of the vector store file batch. securitySchemes: ApiKeyAuth: type: apiKey diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml new file mode 100644 index 000000000000..c4bafc803e41 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml @@ -0,0 +1,4225 @@ +openapi: 3.0.0 +info: + title: Azure OpenAI + description: Azure OpenAI APIs for Assistants. + version: 2024-05-01-preview +tags: [] +paths: + /assistants: + post: + operationId: createAssistant + description: Creates a new assistant. + parameters: [] + responses: + '200': + description: The new assistant instance. + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantCreationOptions' + get: + operationId: listAssistants + description: Gets a list of assistants that were previously created. + parameters: + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + 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 + required: false + 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 + responses: + '200': + description: The requested list of assistants. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/Assistant' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /assistants/{assistantId}: + get: + operationId: getAssistant + description: Retrieves an existing assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to retrieve. + schema: + type: string + responses: + '200': + description: The requested assistant instance. + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + post: + operationId: updateAssistant + description: Modifies an existing assistant. + parameters: + - $ref: '#/components/parameters/UpdateAssistantOptions.assistantId' + responses: + '200': + description: The updated assistant instance. + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAssistantOptions' + delete: + operationId: deleteAssistant + description: Deletes an assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to delete. + schema: + type: string + responses: + '200': + description: Status information about the requested deletion operation. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantDeletionStatus' + /files: + get: + operationId: listFiles + description: Gets a list of previously uploaded files. + parameters: + - name: purpose + in: query + required: false + description: A value that, when provided, limits list results to files matching the corresponding purpose. + schema: + $ref: '#/components/schemas/FilePurpose' + responses: + '200': + description: The requested list of files. + content: + application/json: + schema: + $ref: '#/components/schemas/FileListResponse' + post: + operationId: uploadFile + description: Uploads a file for use by other operations. + parameters: [] + responses: + '200': + description: A representation of the uploaded file. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIFile' + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + purpose: + allOf: + - $ref: '#/components/schemas/FilePurpose' + description: The intended purpose of the file. + filename: + type: string + description: A filename to associate with the uploaded data. + required: + - file + - purpose + /files/{fileId}: + delete: + operationId: deleteFile + description: Delete a previously uploaded file. + parameters: + - name: fileId + in: path + required: true + description: The ID of the file to delete. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/FileDeletionStatus' + get: + operationId: getFile + description: Returns information about a specific file. Does not retrieve file content. + parameters: + - name: fileId + in: path + required: true + description: The ID of the file to retrieve. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIFile' + /files/{fileId}/content: + get: + operationId: getFileContent + description: Returns information about a specific file. Does not retrieve file content. + parameters: + - name: fileId + in: path + required: true + description: The ID of the file to retrieve. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + type: string + format: byte + /threads: + post: + operationId: createThread + description: Creates a new thread. Threads contain messages and can be run by assistants. + parameters: [] + responses: + '200': + description: Information about the newly created thread. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThread' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThreadCreationOptions' + /threads/runs: + post: + operationId: createThreadAndRun + description: Creates a new assistant thread and immediately starts a run using that new thread. + parameters: [] + responses: + '200': + description: Information about the newly created thread. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndRunThreadOptions' + /threads/{threadId}: + get: + operationId: getThread + description: Gets information about an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to retrieve information about. + schema: + type: string + responses: + '200': + description: Information about the requested thread. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThread' + post: + operationId: updateThread + description: Modifies an existing thread. + parameters: + - $ref: '#/components/parameters/UpdateAssistantThreadOptions.threadId' + responses: + '200': + description: Information about the modified thread. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThread' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAssistantThreadOptions' + delete: + operationId: deleteThread + description: Deletes an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to delete. + schema: + type: string + responses: + '200': + description: Status information about the requested thread deletion operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadDeletionStatus' + /threads/{threadId}/messages: + post: + operationId: createMessage + description: Creates a new message on a specified thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to create the new message on. + schema: + type: string + responses: + '200': + description: A representation of the new message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + requestBody: + description: A single message within an assistant thread, as provided during that thread's creation for its initial state. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessageOptions' + get: + operationId: listMessages + description: Gets a list of messages that exist on a thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to list messages from. + schema: + type: string + - name: runId + in: query + required: false + description: Filter messages by the run ID that generated them. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + 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 + required: false + 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 + responses: + '200': + description: The requested list of messages. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/ThreadMessage' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/messages/{messageId}: + get: + operationId: getMessage + description: Gets an existing message from an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to retrieve the specified message from. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to retrieve from the specified thread. + schema: + type: string + responses: + '200': + description: A representation of the requested message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + post: + operationId: updateMessage + description: Modifies an existing message on an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread containing the specified message to modify. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to modify on the specified thread. + schema: + type: string + responses: + '200': + description: A representation of the modified message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + /threads/{threadId}/runs: + post: + operationId: createRun + description: Creates a new run for an assistant thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to run. + schema: + type: string + responses: + '200': + description: Information about the new thread run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + description: The details for the run to create. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRunOptions' + get: + operationId: listRuns + description: Gets a list of runs for a specified thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to list runs from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + 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 + required: false + 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 + responses: + '200': + description: The requested list of thread runs. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/ThreadRun' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/runs/{runId}: + get: + operationId: getRun + description: Gets an existing run from an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to retrieve run information from. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the thread to retrieve information about. + schema: + type: string + responses: + '200': + description: The requested information about the specified thread run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + post: + operationId: updateRun + description: Modifies an existing thread run. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread associated with the specified run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run to modify. + schema: + type: string + responses: + '200': + description: Information about the modified run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + /threads/{threadId}/runs/{runId}/cancel: + post: + operationId: cancelRun + description: Cancels a run of an in progress thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread being run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run to cancel. + schema: + type: string + responses: + '200': + description: Updated information about the cancelled run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + /threads/{threadId}/runs/{runId}/steps: + get: + operationId: listRunSteps + description: Gets a list of run steps from a thread run. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread that was run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run to list steps from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + 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 + required: false + 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 + responses: + '200': + description: The requested list of run steps. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/RunStep' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/runs/{runId}/steps/{stepId}: + get: + operationId: getRunStep + description: Gets a single run step from a thread run. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread that was run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the specific run to retrieve the step from. + schema: + type: string + - name: stepId + in: path + required: true + description: The ID of the step to retrieve information about. + schema: + type: string + responses: + '200': + description: Information about the requested run step. + content: + application/json: + schema: + $ref: '#/components/schemas/RunStep' + /threads/{threadId}/runs/{runId}/submit_tool_outputs: + post: + operationId: submitToolOutputsToRun + description: Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread that was run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run that requires tool outputs. + schema: + type: string + responses: + '200': + description: Updated information about the run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tool_outputs: + type: array + items: + $ref: '#/components/schemas/ToolOutput' + description: A list of tools for which the outputs are being submitted. + 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 + /vector_stores: + get: + operationId: listVectorStores + description: Returns a list of vector stores. + parameters: + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + 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 + required: false + 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 + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/VectorStore' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + post: + operationId: createVectorStore + description: Creates a vector store. + parameters: [] + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStore' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreOptions' + /vector_stores/{vectorStoreId}: + get: + operationId: getVectorStore + description: Returns the vector store object matching the specified ID. + parameters: + - name: vectorStoreId + in: path + required: true + description: The ID of the vector store to retrieve. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStore' + post: + operationId: modifyVectorStore + description: The ID of the vector store to modify. + parameters: + - name: vectorStoreId + in: path + required: true + description: The ID of the vector store to modify. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStore' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreUpdateOptions' + delete: + operationId: deleteVectorStore + description: Deletes the vector store object matching the specified ID. + parameters: + - name: vectorStoreId + in: path + required: true + description: The ID of the vector store to delete. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreDeletionStatus' + /vector_stores/{vectorStoreId}/file_batches: + post: + operationId: createVectorStoreFileBatch + description: Create a vector store file batch. + parameters: + - name: vectorStoreId + in: path + required: true + description: The ID of the vector store for which to create a File Batch. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFileBatch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + file_ids: + type: array + items: + type: string + minItems: 1 + maxItems: 500 + description: A list of File IDs that the vector store should use. Useful for tools like `file_search` that can access files. + required: + - file_ids + /vector_stores/{vectorStoreId}/file_batches/{batchId}: + get: + operationId: getVectorStoreFileBatch + description: Retrieve a vector store file batch. + parameters: + - name: vectorStoreId + in: path + required: true + description: The ID of the vector store that the file batch belongs to. + schema: + type: string + - name: batchId + in: path + required: true + description: The ID of the file batch being retrieved. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFileBatch' + /vector_stores/{vectorStoreId}/file_batches/{batchId}/cancel: + post: + operationId: cancelVectorStoreFileBatch + description: Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. + parameters: + - name: vectorStoreId + in: path + required: true + description: The ID of the vector store that the file batch belongs to. + schema: + type: string + - name: batchId + in: path + required: true + description: The ID of the file batch to cancel. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFileBatch' + /vector_stores/{vectorStoreId}/file_batches/{batchId}/files: + get: + operationId: listVectorStoreFileBatchFiles + description: Returns a list of vector store files in a batch. + parameters: + - name: vectorStoreId + in: path + required: true + description: The ID of the vector store that the file batch belongs to. + schema: + type: string + - name: batchId + in: path + required: true + description: The ID of the file batch that the files belong to. + schema: + type: string + - name: filter + in: query + required: false + description: Filter by file status. + schema: + $ref: '#/components/schemas/VectorStoreFileStatusFilter' + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + 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 + required: false + 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 + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/VectorStoreFile' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /vector_stores/{vectorStoreId}/files: + get: + operationId: listVectorStoreFiles + description: Returns a list of vector store files. + parameters: + - name: vectorStoreId + in: path + required: true + description: The ID of the vector store that the files belong to. + schema: + type: string + - name: filter + in: query + required: false + description: Filter by file status. + schema: + $ref: '#/components/schemas/VectorStoreFileStatusFilter' + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + 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 + required: false + 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 + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/VectorStoreFile' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + post: + operationId: createVectorStoreFile + description: Create a vector store file by attaching a file to a vector store. + parameters: + - name: vectorStoreId + in: path + required: true + description: The ID of the vector store for which to create a File. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFile' + requestBody: + description: A File ID that the vector store should use. Useful for tools like `file_search` that can access files. + required: true + content: + application/json: + schema: + type: string + /vector_stores/{vectorStoreId}/files/{fileId}: + get: + operationId: getVectorStoreFile + description: Retrieves a vector store file. + parameters: + - name: vectorStoreId + in: path + required: true + description: The ID of the vector store that the file belongs to. + schema: + type: string + - name: fileId + in: path + required: true + description: The ID of the file being retrieved. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFile' + delete: + operationId: deleteVectorStoreFile + description: |- + 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: + - name: vectorStoreId + in: path + required: true + description: The ID of the vector store that the file belongs to. + schema: + type: string + - name: fileId + in: path + required: true + description: The ID of the file to delete its relationship to the vector store. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFileDeletionStatus' +security: + - ApiKeyAuth: [] + - OAuth2Auth: + - https://cognitiveservices.azure.com/.default +components: + parameters: + UpdateAssistantOptions.assistantId: + name: assistantId + in: path + required: true + description: The ID of the assistant to modify. + schema: + type: string + UpdateAssistantThreadOptions.threadId: + name: threadId + in: path + required: true + description: The ID of the thread to modify. + schema: + type: string + schemas: + ApiResponseFormat: + anyOf: + - type: string + - type: string + enum: + - text + - json_object + description: Possible API response formats. + Assistant: + type: object + required: + - id + - object + - created_at + - name + - description + - model + - instructions + - tools + - tool_resources + - temperature + - top_p + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - assistant + description: The object type, which is always assistant. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + name: + type: string + nullable: true + description: The name of the assistant. + description: + type: string + nullable: true + description: The description of the assistant. + model: + type: string + description: The ID of the model to use. + instructions: + type: string + nullable: true + description: The system instructions for the assistant to use. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The collection of tools enabled for the assistant. + default: [] + tool_resources: + type: object + allOf: + - $ref: '#/components/schemas/ToolResources' + nullable: true + 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. + temperature: + type: number + format: float + nullable: true + minimum: 0 + maximum: 2 + 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. + default: 1 + top_p: + type: number + format: float + nullable: true + minimum: 0 + maximum: 1 + 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. + default: 1 + response_format: + oneOf: + - $ref: '#/components/schemas/AssistantsApiResponseFormatOption' + nullable: true + description: The response format of the tool calls used by this assistant. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Represents an assistant that can call the model and use tools. + AssistantCreationOptions: + type: object + required: + - model + properties: + model: + type: string + description: The ID of the model to use. + name: + type: string + nullable: true + description: The name of the new assistant. + description: + type: string + nullable: true + description: The description of the new assistant. + instructions: + type: string + nullable: true + description: The system instructions for the new assistant to use. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The collection of tools to enable for the new assistant. + default: [] + tool_resources: + type: object + allOf: + - $ref: '#/components/schemas/CreateToolResourcesOptions' + nullable: true + 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. + temperature: + type: number + format: float + nullable: true + minimum: 0 + maximum: 2 + 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. + default: 1 + top_p: + type: number + format: float + nullable: true + minimum: 0 + maximum: 1 + 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. + default: 1 + response_format: + oneOf: + - $ref: '#/components/schemas/AssistantsApiResponseFormatOption' + nullable: true + description: The response format of the tool calls used by this assistant. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The request details to use when creating a new assistant. + AssistantDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - assistant.deleted + description: The object type, which is always 'assistant.deleted'. + description: The status of an assistant deletion operation. + AssistantStreamEvent: + anyOf: + - type: string + - anyOf: + - $ref: '#/components/schemas/ThreadStreamEvent' + - $ref: '#/components/schemas/RunStreamEvent' + - $ref: '#/components/schemas/RunStepStreamEvent' + - $ref: '#/components/schemas/MessageStreamEvent' + - $ref: '#/components/schemas/ErrorEvent' + - $ref: '#/components/schemas/DoneEvent' + description: |- + 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. + AssistantThread: + type: object + required: + - id + - object + - created_at + - tool_resources + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread + description: The object type, which is always 'thread'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + tool_resources: + type: object + allOf: + - $ref: '#/components/schemas/ToolResources' + nullable: true + 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. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Information about a single thread associated with an assistant. + AssistantThreadCreationOptions: + type: object + properties: + messages: + type: array + items: + $ref: '#/components/schemas/ThreadMessageOptions' + description: The initial messages to associate with the new thread. + tool_resources: + type: object + allOf: + - $ref: '#/components/schemas/CreateToolResourcesOptions' + nullable: true + 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. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The details used to create a new assistant thread. + AssistantsApiResponseFormat: + type: object + properties: + type: + allOf: + - $ref: '#/components/schemas/ApiResponseFormat' + description: Must be one of `text` or `json_object`. + default: text + 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. + AssistantsApiResponseFormatMode: + anyOf: + - type: string + - type: string + enum: + - auto + - none + description: Represents the mode in which the model will handle the return format of a tool call. + AssistantsApiResponseFormatOption: + anyOf: + - type: string + - $ref: '#/components/schemas/AssistantsApiResponseFormatMode' + - $ref: '#/components/schemas/AssistantsApiResponseFormat' + 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. + AssistantsApiToolChoiceOption: + anyOf: + - type: string + - $ref: '#/components/schemas/AssistantsApiToolChoiceOptionMode' + - $ref: '#/components/schemas/AssistantsNamedToolChoice' + 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. + AssistantsApiToolChoiceOptionMode: + anyOf: + - type: string + - type: string + enum: + - none + - auto + description: Specifies how the tool choice will be used + AssistantsNamedToolChoice: + type: object + required: + - type + properties: + type: + allOf: + - $ref: '#/components/schemas/AssistantsNamedToolChoiceType' + description: the type of tool. If type is `function`, the function name must be set. + function: + allOf: + - $ref: '#/components/schemas/FunctionName' + description: The name of the function to call + description: Specifies a tool the model should use. Use to force the model to call a specific tool. + AssistantsNamedToolChoiceType: + anyOf: + - type: string + - type: string + enum: + - function + - code_interpreter + - file_search + description: Available tool types for assistants named tools. + CodeInterpreterToolDefinition: + type: object + required: + - type + properties: + type: + type: string + enum: + - code_interpreter + description: The object type, which is always 'code_interpreter'. + allOf: + - $ref: '#/components/schemas/ToolDefinition' + description: The input definition information for a code interpreter tool as used to configure an assistant. + CodeInterpreterToolResource: + type: object + required: + - file_ids + properties: + file_ids: + type: array + items: + type: string + maxItems: 20 + 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: [] + description: A set of resources that are used by the `code_interpreter` tool. + CreateAndRunThreadOptions: + type: object + required: + - assistant_id + properties: + assistant_id: + type: string + description: The ID of the assistant for which the thread should be created. + thread: + allOf: + - $ref: '#/components/schemas/AssistantThreadCreationOptions' + description: The details used to create the new thread. If no thread is provided, an empty one will be created. + model: + type: string + nullable: true + description: The overridden model that the assistant should use to run the thread. + instructions: + type: string + nullable: true + description: The overridden system instructions the assistant should use to run the thread. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + nullable: true + description: The overridden list of enabled tools the assistant should use to run the thread. + tool_resources: + type: object + allOf: + - $ref: '#/components/schemas/UpdateToolResourcesOptions' + nullable: true + description: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. + stream: + type: boolean + 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. + temperature: + type: number + format: float + nullable: true + minimum: 0 + maximum: 2 + 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. + default: 1 + top_p: + type: number + format: float + nullable: true + minimum: 0 + maximum: 1 + 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. + default: 1 + max_prompt_tokens: + type: integer + format: int32 + nullable: true + minimum: 256 + 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. + max_completion_tokens: + type: integer + format: int32 + nullable: true + minimum: 256 + 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. + truncation_strategy: + type: object + allOf: + - $ref: '#/components/schemas/TruncationObject' + nullable: true + description: The strategy to use for dropping messages as the context windows moves forward. + tool_choice: + oneOf: + - $ref: '#/components/schemas/AssistantsApiToolChoiceOption' + nullable: true + description: Controls whether or not and which tool is called by the model. + response_format: + oneOf: + - $ref: '#/components/schemas/AssistantsApiResponseFormatOption' + nullable: true + description: Specifies the format that the model must output. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The details used when creating and immediately running a new assistant thread. + CreateCodeInterpreterToolResourceOptions: + type: object + properties: + file_ids: + type: array + items: + type: string + maxItems: 20 + description: A list of file IDs made available to the `code_interpreter` tool. + default: [] + description: A set of resources that will be used by the `code_interpreter` tool. Request object. + CreateFileSearchToolResourceOptions: + anyOf: + - type: array + items: + type: string + - type: array + items: + $ref: '#/components/schemas/CreateFileSearchToolResourceVectorStoreOptions' + 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. + CreateFileSearchToolResourceVectorStoreOptions: + type: object + required: + - file_ids + properties: + file_ids: + type: array + items: + type: string + maxItems: 10000 + description: A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: File IDs associated to the vector store to be passed to the helper. + CreateRunOptions: + type: object + required: + - assistant_id + properties: + assistant_id: + type: string + description: The ID of the assistant that should run the thread. + model: + type: string + nullable: true + description: The overridden model name that the assistant should use to run the thread. + instructions: + type: string + nullable: true + description: The overridden system instructions that the assistant should use to run the thread. + additional_instructions: + type: string + nullable: true + description: |- + Additional instructions to append 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. + additional_messages: + type: array + items: + $ref: '#/components/schemas/ThreadMessage' + nullable: true + description: Adds additional messages to the thread before creating the run. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + nullable: true + description: The overridden list of enabled tools that the assistant should use to run the thread. + stream: + type: boolean + 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. + temperature: + type: number + format: float + nullable: true + minimum: 0 + maximum: 2 + 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. + default: 1 + top_p: + type: number + format: float + nullable: true + minimum: 0 + maximum: 1 + 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. + default: 1 + max_prompt_tokens: + type: integer + format: int32 + nullable: true + minimum: 256 + 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. + max_completion_tokens: + type: integer + format: int32 + nullable: true + minimum: 256 + 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. + truncation_strategy: + type: object + allOf: + - $ref: '#/components/schemas/TruncationObject' + nullable: true + description: The strategy to use for dropping messages as the context windows moves forward. + tool_choice: + oneOf: + - $ref: '#/components/schemas/AssistantsApiToolChoiceOption' + nullable: true + description: Controls whether or not and which tool is called by the model. + response_format: + oneOf: + - $ref: '#/components/schemas/AssistantsApiResponseFormatOption' + nullable: true + description: Specifies the format that the model must output. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The details used when creating a new run of an assistant thread. + CreateToolResourcesOptions: + type: object + properties: + code_interpreter: + allOf: + - $ref: '#/components/schemas/CreateCodeInterpreterToolResourceOptions' + 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. + file_search: + allOf: + - $ref: '#/components/schemas/CreateFileSearchToolResourceOptions' + description: A list of vector stores or their IDs made available to the `file_search` tool. + description: |- + Request object. 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. + DoneEvent: + anyOf: + - type: string + - type: string + enum: + - done + description: Terminal event indicating the successful end of a stream. + ErrorEvent: + anyOf: + - type: string + - type: string + enum: + - error + description: Terminal event indicating a server side error while streaming. + FileDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - file + description: The object type, which is always 'file'. + description: A status response from a file deletion operation. + FileListResponse: + type: object + required: + - object + - data + properties: + object: + type: string + enum: + - list + description: The object type, which is always 'list'. + data: + type: array + items: + $ref: '#/components/schemas/OpenAIFile' + description: The files returned for the request. + description: The response data from a file list operation. + FilePurpose: + anyOf: + - type: string + - type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + - batch + - batch_output + - vision + description: The possible values denoting the intended usage of a file. + FileSearchToolDefinition: + type: object + required: + - type + properties: + type: + type: string + enum: + - file_search + description: The object type, which is always 'file_search'. + allOf: + - $ref: '#/components/schemas/ToolDefinition' + description: The input definition information for a file search tool as used to configure an assistant. + FileSearchToolResource: + type: object + properties: + vector_store_ids: + type: array + items: + type: string + maxItems: 1 + description: |- + The ID of the vector store attached to this assistant. There can be a maximum of 1 vector + store attached to the assistant. + description: A set of resources that are used by the `file_search` tool. + FileState: + anyOf: + - type: string + - type: string + enum: + - uploaded + - pending + - running + - processed + - error + - deleting + - deleted + description: The state of the file. + FunctionDefinition: + type: object + required: + - name + - parameters + properties: + name: + type: string + description: The name of the function to be called. + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + parameters: + description: The parameters the functions accepts, described as a JSON Schema object. + description: The input definition information for a function. + FunctionName: + type: object + required: + - name + properties: + name: + type: string + description: The name of the function to call + description: The function name that will be used, if using the `funtion` tool + FunctionToolDefinition: + type: object + required: + - type + - function + properties: + type: + type: string + enum: + - function + description: The object type, which is always 'function'. + function: + allOf: + - $ref: '#/components/schemas/FunctionDefinition' + description: The definition of the concrete function that the function tool should call. + allOf: + - $ref: '#/components/schemas/ToolDefinition' + description: The input definition information for a function tool as used to configure an assistant. + IncompleteRunDetails: + anyOf: + - type: string + - type: string + enum: + - max_completion_tokens + - max_prompt_tokens + description: The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. + ListSortOrder: + anyOf: + - type: string + - type: string + enum: + - asc + - desc + description: The available sorting options when requesting a list of response objects. + MessageAttachment: + type: object + required: + - file_id + - tools + properties: + file_id: + type: string + description: The ID of the file to attach to the message. + tools: + type: array + items: + $ref: '#/components/schemas/MessageAttachmentToolDefinition' + description: The tools to add to this file. + description: This describes to which tools a file has been attached. + MessageAttachmentToolDefinition: + anyOf: + - $ref: '#/components/schemas/CodeInterpreterToolDefinition' + - $ref: '#/components/schemas/FileSearchToolDefinition' + description: The possible tools to which files will be added by this message + MessageContent: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/MessageTextContent' + image_file: '#/components/schemas/MessageImageFileContent' + description: An abstract representation of a single item of thread message content. + MessageDelta: + type: object + required: + - role + - content + properties: + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + description: The entity that produced the message. + content: + type: array + items: + $ref: '#/components/schemas/MessageDeltaContent' + description: The content of the message as an array of text and/or images. + description: Represents the typed 'delta' payload within a streaming message delta chunk. + MessageDeltaChunk: + type: object + required: + - id + - object + - delta + properties: + id: + type: string + description: The identifier of the message, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.message.delta + description: The object type, which is always `thread.message.delta`. + delta: + allOf: + - $ref: '#/components/schemas/MessageDelta' + description: The delta containing the fields that have changed on the Message. + description: Represents a message delta i.e. any changed fields on a message during streaming. + MessageDeltaContent: + type: object + required: + - index + - type + properties: + index: + type: integer + format: int32 + description: The index of the content part of the message. + type: + type: string + description: The type of content for this content part. + discriminator: + propertyName: type + mapping: + image_file: '#/components/schemas/MessageDeltaImageFileContent' + text: '#/components/schemas/MessageDeltaTextContentObject' + description: The abstract base representation of a partial streamed message content payload. + MessageDeltaImageFileContent: + type: object + required: + - type + properties: + type: + type: string + enum: + - image_file + description: The type of content for this content part, which is always "image_file." + image_file: + allOf: + - $ref: '#/components/schemas/MessageDeltaImageFileContentObject' + description: The image_file data. + allOf: + - $ref: '#/components/schemas/MessageDeltaContent' + description: Represents a streamed image file content part within a streaming message delta chunk. + MessageDeltaImageFileContentObject: + type: object + properties: + file_id: + type: string + description: The file ID of the image in the message content. + description: Represents the 'image_file' payload within streaming image file content. + MessageDeltaTextAnnotation: + type: object + required: + - index + - type + properties: + index: + type: integer + format: int32 + description: The index of the annotation within a text content part. + type: + type: string + description: The type of the text content annotation. + discriminator: + propertyName: type + mapping: + file_citation: '#/components/schemas/MessageDeltaTextFileCitationAnnotationObject' + file_path: '#/components/schemas/MessageDeltaTextFilePathAnnotationObject' + description: The abstract base representation of a streamed text content part's text annotation. + MessageDeltaTextContent: + type: object + properties: + value: + type: string + description: The data that makes up the text. + annotations: + type: array + items: + $ref: '#/components/schemas/MessageDeltaTextAnnotation' + description: Annotations for the text. + description: Represents the data of a streamed text content part within a streaming message delta chunk. + MessageDeltaTextContentObject: + type: object + required: + - type + properties: + type: + type: string + enum: + - text + description: The type of content for this content part, which is always "text." + text: + allOf: + - $ref: '#/components/schemas/MessageDeltaTextContent' + description: The text content details. + allOf: + - $ref: '#/components/schemas/MessageDeltaContent' + description: Represents a streamed text content part within a streaming message delta chunk. + MessageDeltaTextFileCitationAnnotation: + type: object + properties: + file_id: + type: string + description: The ID of the specific file the citation is from. + quote: + type: string + description: The specific quote in the cited file. + description: Represents the data of a streamed file citation as applied to a streaming text content part. + MessageDeltaTextFileCitationAnnotationObject: + type: object + required: + - type + properties: + type: + type: string + enum: + - file_citation + description: The type of the text content annotation, which is always "file_citation." + file_citation: + allOf: + - $ref: '#/components/schemas/MessageDeltaTextFileCitationAnnotation' + description: The file citation information. + text: + type: string + description: The text in the message content that needs to be replaced + start_index: + type: integer + format: int32 + description: The start index of this annotation in the content text. + end_index: + type: integer + format: int32 + description: The end index of this annotation in the content text. + allOf: + - $ref: '#/components/schemas/MessageDeltaTextAnnotation' + description: Represents a streamed file citation applied to a streaming text content part. + MessageDeltaTextFilePathAnnotation: + type: object + properties: + file_id: + type: string + description: The file ID for the annotation. + description: Represents the data of a streamed file path annotation as applied to a streaming text content part. + MessageDeltaTextFilePathAnnotationObject: + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path + description: The type of the text content annotation, which is always "file_path." + file_path: + allOf: + - $ref: '#/components/schemas/MessageDeltaTextFilePathAnnotation' + description: The file path information. + start_index: + type: integer + format: int32 + description: The start index of this annotation in the content text. + end_index: + type: integer + format: int32 + description: The end index of this annotation in the content text. + text: + type: string + description: The text in the message content that needs to be replaced + allOf: + - $ref: '#/components/schemas/MessageDeltaTextAnnotation' + description: Represents a streamed file path annotation applied to a streaming text content part. + MessageImageFileContent: + type: object + required: + - type + - image_file + properties: + type: + type: string + enum: + - image_file + description: The object type, which is always 'image_file'. + image_file: + allOf: + - $ref: '#/components/schemas/MessageImageFileDetails' + description: The image file for this thread message content item. + allOf: + - $ref: '#/components/schemas/MessageContent' + description: A representation of image file content in a thread message. + MessageImageFileDetails: + type: object + required: + - file_id + properties: + file_id: + type: string + description: The ID for the file associated with this image. + description: An image reference, as represented in thread message content. + MessageIncompleteDetails: + type: object + required: + - reason + properties: + reason: + allOf: + - $ref: '#/components/schemas/MessageIncompleteDetailsReason' + description: The provided reason describing why the message was marked as incomplete. + description: Information providing additional detail about a message entering an incomplete status. + MessageIncompleteDetailsReason: + anyOf: + - type: string + - type: string + enum: + - content_filter + - max_tokens + - run_cancelled + - run_failed + - run_expired + description: A set of reasons describing why a message is marked as incomplete. + MessageRole: + anyOf: + - type: string + - type: string + enum: + - user + - assistant + description: The possible values for roles attributed to messages in a thread. + MessageStatus: + anyOf: + - type: string + - type: string + enum: + - in_progress + - incomplete + - completed + description: The possible execution status values for a thread message. + MessageStreamEvent: + anyOf: + - type: string + - type: string + enum: + - thread.message.created + - thread.message.in_progress + - thread.message.delta + - thread.message.completed + - thread.message.incomplete + description: Message operation related streaming events + MessageTextAnnotation: + type: object + required: + - type + - text + properties: + type: + type: string + description: The object type. + text: + type: string + description: The textual content associated with this text annotation item. + discriminator: + propertyName: type + mapping: + file_citation: '#/components/schemas/MessageTextFileCitationAnnotation' + file_path: '#/components/schemas/MessageTextFilePathAnnotation' + description: An abstract representation of an annotation to text thread message content. + MessageTextContent: + type: object + required: + - type + - text + properties: + type: + type: string + enum: + - text + description: The object type, which is always 'text'. + text: + allOf: + - $ref: '#/components/schemas/MessageTextDetails' + description: The text and associated annotations for this thread message content item. + allOf: + - $ref: '#/components/schemas/MessageContent' + description: A representation of a textual item of thread message content. + MessageTextDetails: + type: object + required: + - value + - annotations + properties: + value: + type: string + description: The text data. + annotations: + type: array + items: + $ref: '#/components/schemas/MessageTextAnnotation' + description: A list of annotations associated with this text. + description: The text and associated annotations for a single item of assistant thread message content. + MessageTextFileCitationAnnotation: + type: object + required: + - type + - file_citation + properties: + type: + type: string + enum: + - file_citation + description: The object type, which is always 'file_citation'. + file_citation: + allOf: + - $ref: '#/components/schemas/MessageTextFileCitationDetails' + description: |- + A citation within the message that points to a specific quote from a specific file. + Generated when the assistant uses the "file_search" tool to search files. + start_index: + type: integer + format: int32 + description: The first text index associated with this text annotation. + end_index: + type: integer + format: int32 + description: The last text index associated with this text annotation. + allOf: + - $ref: '#/components/schemas/MessageTextAnnotation' + 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. + MessageTextFileCitationDetails: + type: object + required: + - file_id + - quote + properties: + file_id: + type: string + description: The ID of the file associated with this citation. + quote: + type: string + description: The specific quote cited in the associated file. + description: A representation of a file-based text citation, as used in a file-based annotation of text thread message content. + MessageTextFilePathAnnotation: + type: object + required: + - type + - file_path + properties: + type: + type: string + enum: + - file_path + description: The object type, which is always 'file_path'. + file_path: + allOf: + - $ref: '#/components/schemas/MessageTextFilePathDetails' + description: A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. + start_index: + type: integer + format: int32 + description: The first text index associated with this text annotation. + end_index: + type: integer + format: int32 + description: The last text index associated with this text annotation. + allOf: + - $ref: '#/components/schemas/MessageTextAnnotation' + description: A citation within the message that points to a file located at a specific path. + MessageTextFilePathDetails: + type: object + required: + - file_id + properties: + file_id: + type: string + description: The ID of the specific file that the citation is from. + description: An encapsulation of an image file ID, as used by message image content. + OpenAIFile: + type: object + required: + - object + - id + - bytes + - filename + - created_at + - purpose + properties: + object: + type: string + enum: + - file + description: The object type, which is always 'file'. + id: + type: string + description: The identifier, which can be referenced in API endpoints. + bytes: + type: integer + format: int32 + description: The size of the file, in bytes. + filename: + type: string + description: The name of the file. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + purpose: + allOf: + - $ref: '#/components/schemas/FilePurpose' + description: The intended purpose of a file. + status: + allOf: + - $ref: '#/components/schemas/FileState' + description: The state of the file. This field is available in Azure OpenAI only. + status_details: + type: string + description: The error message with details in case processing of this file failed. This field is available in Azure OpenAI only. + description: Represents an assistant that can call the model and use tools. + RequiredAction: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + submit_tool_outputs: '#/components/schemas/SubmitToolOutputsAction' + description: An abstract representation of a required action for an assistant thread run to continue. + RequiredFunctionToolCall: + type: object + required: + - type + - function + properties: + type: + type: string + enum: + - function + description: The object type of the required tool call. Always 'function' for function tools. + function: + allOf: + - $ref: '#/components/schemas/RequiredFunctionToolCallDetails' + description: Detailed information about the function to be executed by the tool that includes name and arguments. + allOf: + - $ref: '#/components/schemas/RequiredToolCall' + description: A representation of a requested call to a function tool, needed by the model to continue evaluation of a run. + RequiredFunctionToolCallDetails: + type: object + required: + - name + - arguments + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments to use when invoking the named function, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation. + description: The detailed information for a function invocation, as provided by a required action invoking a function tool, that includes the name of and arguments to the function. + RequiredToolCall: + type: object + required: + - type + - id + properties: + type: + type: string + description: The object type for the required tool call. + id: + type: string + description: The ID of the tool call. This ID must be referenced when submitting tool outputs. + discriminator: + propertyName: type + mapping: + function: '#/components/schemas/RequiredFunctionToolCall' + description: An abstract representation a a tool invocation needed by the model to continue a run. + RunCompletionUsage: + type: object + required: + - completion_tokens + - prompt_tokens + - total_tokens + properties: + completion_tokens: + type: integer + format: int64 + description: Number of completion tokens used over the course of the run. + prompt_tokens: + type: integer + format: int64 + description: Number of prompt tokens used over the course of the run. + total_tokens: + type: integer + format: int64 + description: Total number of tokens used (prompt + completion). + 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.). + RunError: + type: object + required: + - code + - message + properties: + code: + type: string + description: The status for the error. + message: + type: string + description: The human-readable text associated with the error. + description: The details of an error as encountered by an assistant thread run. + RunStatus: + anyOf: + - type: string + - type: string + enum: + - queued + - in_progress + - requires_action + - cancelling + - cancelled + - failed + - completed + - expired + description: Possible values for the status of an assistant thread run. + RunStep: + type: object + required: + - id + - object + - type + - assistant_id + - thread_id + - run_id + - status + - step_details + - last_error + - created_at + - expired_at + - completed_at + - cancelled_at + - failed_at + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.run.step + description: The object type, which is always 'thread.run.step'. + type: + allOf: + - $ref: '#/components/schemas/RunStepType' + description: The type of run step, which can be either message_creation or tool_calls. + assistant_id: + type: string + description: The ID of the assistant associated with the run step. + thread_id: + type: string + description: The ID of the thread that was run. + run_id: + type: string + description: The ID of the run that this run step is a part of. + status: + allOf: + - $ref: '#/components/schemas/RunStepStatus' + description: The status of this run step. + step_details: + allOf: + - $ref: '#/components/schemas/RunStepDetails' + description: The details for this run step. + last_error: + type: object + allOf: + - $ref: '#/components/schemas/RunStepError' + nullable: true + description: If applicable, information about the last error encountered by this run step. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + expired_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp, in seconds, representing when this item expired. + completed_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp, in seconds, representing when this completed. + cancelled_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp, in seconds, representing when this was cancelled. + failed_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp, in seconds, representing when this failed. + usage: + type: object + allOf: + - $ref: '#/components/schemas/RunStepCompletionUsage' + nullable: true + description: Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Detailed information about a single step of an assistant thread run. + RunStepCodeInterpreterImageOutput: + type: object + required: + - type + - image + properties: + type: + type: string + enum: + - image + description: The object type, which is always 'image'. + image: + allOf: + - $ref: '#/components/schemas/RunStepCodeInterpreterImageReference' + description: Referential information for the image associated with this output. + allOf: + - $ref: '#/components/schemas/RunStepCodeInterpreterToolCallOutput' + description: A representation of an image output emitted by a code interpreter tool in response to a tool call by the model. + RunStepCodeInterpreterImageReference: + type: object + required: + - file_id + properties: + file_id: + type: string + description: The ID of the file associated with this image. + description: An image reference emitted by a code interpreter tool in response to a tool call by the model. + RunStepCodeInterpreterLogOutput: + type: object + required: + - type + - logs + properties: + type: + type: string + enum: + - logs + description: The object type, which is always 'logs'. + logs: + type: string + description: The serialized log output emitted by the code interpreter. + allOf: + - $ref: '#/components/schemas/RunStepCodeInterpreterToolCallOutput' + description: A representation of a log output emitted by a code interpreter tool in response to a tool call by the model. + RunStepCodeInterpreterToolCall: + type: object + required: + - type + - code_interpreter + properties: + type: + type: string + enum: + - code_interpreter + description: The object type, which is always 'code_interpreter'. + code_interpreter: + allOf: + - $ref: '#/components/schemas/RunStepCodeInterpreterToolCallDetails' + description: The details of the tool call to the code interpreter tool. + allOf: + - $ref: '#/components/schemas/RunStepToolCall' + description: |- + A record of a call to a code interpreter tool, issued by the model in evaluation of a defined tool, that + represents inputs and outputs consumed and emitted by the code interpreter. + RunStepCodeInterpreterToolCallDetails: + type: object + required: + - input + - outputs + properties: + input: + type: string + description: The input provided by the model to the code interpreter tool. + outputs: + type: array + items: + $ref: '#/components/schemas/RunStepCodeInterpreterToolCallOutput' + description: The outputs produced by the code interpreter tool back to the model in response to the tool call. + description: The detailed information about a code interpreter invocation by the model. + RunStepCodeInterpreterToolCallOutput: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + logs: '#/components/schemas/RunStepCodeInterpreterLogOutput' + image: '#/components/schemas/RunStepCodeInterpreterImageOutput' + description: An abstract representation of an emitted output from a code interpreter tool. + RunStepCompletionUsage: + type: object + required: + - completion_tokens + - prompt_tokens + - total_tokens + properties: + completion_tokens: + type: integer + format: int64 + description: Number of completion tokens used over the course of the run step. + prompt_tokens: + type: integer + format: int64 + description: Number of prompt tokens used over the course of the run step. + total_tokens: + type: integer + format: int64 + description: Total number of tokens used (prompt + completion). + description: Usage statistics related to the run step. + RunStepDelta: + type: object + properties: + step_details: + allOf: + - $ref: '#/components/schemas/RunStepDeltaDetail' + description: The details of the run step. + description: Represents the delta payload in a streaming run step delta chunk. + RunStepDeltaChunk: + type: object + required: + - id + - object + - delta + properties: + id: + type: string + description: The identifier of the run step, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.run.step.delta + description: The object type, which is always `thread.run.step.delta`. + delta: + allOf: + - $ref: '#/components/schemas/RunStepDelta' + description: The delta containing the fields that have changed on the run step. + description: Represents a run step delta i.e. any changed fields on a run step during streaming. + RunStepDeltaCodeInterpreterDetailItemObject: + type: object + properties: + input: + type: string + description: The input into the Code Interpreter tool call. + outputs: + type: array + items: + $ref: '#/components/schemas/RunStepDeltaCodeInterpreterOutput' + 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. + description: Represents the Code Interpreter tool call data in a streaming run step's tool calls. + RunStepDeltaCodeInterpreterImageOutput: + type: object + required: + - type + properties: + type: + type: string + enum: + - image + description: The object type, which is always "image." + image: + allOf: + - $ref: '#/components/schemas/RunStepDeltaCodeInterpreterImageOutputObject' + description: The image data for the Code Interpreter tool call output. + allOf: + - $ref: '#/components/schemas/RunStepDeltaCodeInterpreterOutput' + description: Represents an image output as produced the Code interpreter tool and as represented in a streaming run step's delta tool calls collection. + RunStepDeltaCodeInterpreterImageOutputObject: + type: object + properties: + file_id: + type: string + description: The file ID for the image. + description: Represents the data for a streaming run step's Code Interpreter tool call image output. + RunStepDeltaCodeInterpreterLogOutput: + type: object + required: + - type + properties: + type: + type: string + enum: + - logs + description: The type of the object, which is always "logs." + logs: + type: string + description: The text output from the Code Interpreter tool call. + allOf: + - $ref: '#/components/schemas/RunStepDeltaCodeInterpreterOutput' + description: Represents a log output as produced by the Code Interpreter tool and as represented in a streaming run step's delta tool calls collection. + RunStepDeltaCodeInterpreterOutput: + type: object + required: + - index + - type + properties: + index: + type: integer + format: int32 + description: The index of the output in the streaming run step tool call's Code Interpreter outputs array. + type: + type: string + description: The type of the streaming run step tool call's Code Interpreter output. + discriminator: + propertyName: type + mapping: + logs: '#/components/schemas/RunStepDeltaCodeInterpreterLogOutput' + image: '#/components/schemas/RunStepDeltaCodeInterpreterImageOutput' + description: The abstract base representation of a streaming run step tool call's Code Interpreter tool output. + RunStepDeltaCodeInterpreterToolCall: + type: object + required: + - type + properties: + type: + type: string + enum: + - code_interpreter + description: The object type, which is always "code_interpreter." + code_interpreter: + allOf: + - $ref: '#/components/schemas/RunStepDeltaCodeInterpreterDetailItemObject' + description: The Code Interpreter data for the tool call. + allOf: + - $ref: '#/components/schemas/RunStepDeltaToolCall' + description: Represents a Code Interpreter tool call within a streaming run step's tool call details. + RunStepDeltaDetail: + type: object + required: + - type + properties: + type: + type: string + description: The object type for the run step detail object. + discriminator: + propertyName: type + mapping: + message_creation: '#/components/schemas/RunStepDeltaMessageCreation' + tool_calls: '#/components/schemas/RunStepDeltaToolCallObject' + description: Represents a single run step detail item in a streaming run step's delta payload. + RunStepDeltaFileSearchToolCall: + type: object + required: + - type + properties: + type: + type: string + enum: + - file_search + description: The object type, which is always "file_search." + file_search: + type: object + additionalProperties: + type: string + description: Reserved for future use. + allOf: + - $ref: '#/components/schemas/RunStepDeltaToolCall' + description: Represents a file search tool call within a streaming run step's tool call details. + RunStepDeltaFunction: + type: object + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments passed to the function as input. + output: + type: string + nullable: true + description: The output of the function, null if outputs have not yet been submitted. + description: Represents the function data in a streaming run step delta's function tool call. + RunStepDeltaFunctionToolCall: + type: object + required: + - type + properties: + type: + type: string + enum: + - function + description: The object type, which is always "function." + function: + allOf: + - $ref: '#/components/schemas/RunStepDeltaFunction' + description: The function data for the tool call. + allOf: + - $ref: '#/components/schemas/RunStepDeltaToolCall' + description: Represents a function tool call within a streaming run step's tool call details. + RunStepDeltaMessageCreation: + type: object + required: + - type + properties: + type: + type: string + enum: + - message_creation + description: The object type, which is always "message_creation." + message_creation: + allOf: + - $ref: '#/components/schemas/RunStepDeltaMessageCreationObject' + description: The message creation data. + allOf: + - $ref: '#/components/schemas/RunStepDeltaDetail' + description: Represents a message creation within a streaming run step delta. + RunStepDeltaMessageCreationObject: + type: object + properties: + message_id: + type: string + description: The ID of the newly-created message. + description: Represents the data within a streaming run step message creation response object. + RunStepDeltaToolCall: + type: object + required: + - index + - id + - type + properties: + index: + type: integer + format: int32 + description: The index of the tool call detail in the run step's tool_calls array. + id: + type: string + description: The ID of the tool call, used when submitting outputs to the run. + type: + type: string + description: The type of the tool call detail item in a streaming run step's details. + discriminator: + propertyName: type + mapping: + function: '#/components/schemas/RunStepDeltaFunctionToolCall' + file_search: '#/components/schemas/RunStepDeltaFileSearchToolCall' + code_interpreter: '#/components/schemas/RunStepDeltaCodeInterpreterToolCall' + description: The abstract base representation of a single tool call within a streaming run step's delta tool call details. + RunStepDeltaToolCallObject: + type: object + required: + - type + properties: + type: + type: string + enum: + - tool_calls + description: The object type, which is always "tool_calls." + tool_calls: + type: array + items: + $ref: '#/components/schemas/RunStepDeltaToolCall' + description: The collection of tool calls for the tool call detail item. + allOf: + - $ref: '#/components/schemas/RunStepDeltaDetail' + description: Represents an invocation of tool calls as part of a streaming run step. + RunStepDetails: + type: object + required: + - type + properties: + type: + allOf: + - $ref: '#/components/schemas/RunStepType' + description: The object type. + discriminator: + propertyName: type + mapping: + message_creation: '#/components/schemas/RunStepMessageCreationDetails' + tool_calls: '#/components/schemas/RunStepToolCallDetails' + description: An abstract representation of the details for a run step. + RunStepError: + type: object + required: + - code + - message + properties: + code: + allOf: + - $ref: '#/components/schemas/RunStepErrorCode' + description: The error code for this error. + message: + type: string + description: The human-readable text associated with this error. + description: The error information associated with a failed run step. + RunStepErrorCode: + anyOf: + - type: string + - type: string + enum: + - server_error + - rate_limit_exceeded + description: Possible error code values attributable to a failed run step. + RunStepFileSearchToolCall: + type: object + required: + - type + - file_search + properties: + type: + type: string + enum: + - file_search + description: The object type, which is always 'file_search'. + file_search: + type: object + additionalProperties: + type: string + description: Reserved for future use. + allOf: + - $ref: '#/components/schemas/RunStepToolCall' + description: |- + A record of a call to a file search tool, issued by the model in evaluation of a defined tool, that represents + executed file search. + RunStepFunctionToolCall: + type: object + required: + - type + - function + properties: + type: + type: string + enum: + - function + description: The object type, which is always 'function'. + function: + allOf: + - $ref: '#/components/schemas/RunStepFunctionToolCallDetails' + description: The detailed information about the function called by the model. + allOf: + - $ref: '#/components/schemas/RunStepToolCall' + description: |- + A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs + and output consumed and emitted by the specified function. + RunStepFunctionToolCallDetails: + type: object + required: + - name + - arguments + - output + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments that the model requires are provided to the named function. + output: + type: string + nullable: true + description: The output of the function, only populated for function calls that have already have had their outputs submitted. + description: The detailed information about the function called by the model. + RunStepMessageCreationDetails: + type: object + required: + - type + - message_creation + properties: + type: + type: string + enum: + - message_creation + description: The object type, which is always 'message_creation'. + message_creation: + allOf: + - $ref: '#/components/schemas/RunStepMessageCreationReference' + description: Information about the message creation associated with this run step. + allOf: + - $ref: '#/components/schemas/RunStepDetails' + description: The detailed information associated with a message creation run step. + RunStepMessageCreationReference: + type: object + required: + - message_id + properties: + message_id: + type: string + description: The ID of the message created by this run step. + description: The details of a message created as a part of a run step. + RunStepStatus: + anyOf: + - type: string + - type: string + enum: + - in_progress + - cancelled + - failed + - completed + - expired + description: Possible values for the status of a run step. + RunStepStreamEvent: + anyOf: + - type: string + - type: string + enum: + - thread.run.step.created + - thread.run.step.in_progress + - thread.run.step.delta + - thread.run.step.completed + - thread.run.step.failed + - thread.run.step.cancelled + - thread.run.step.expired + description: Run step operation related streaming events + RunStepToolCall: + type: object + required: + - type + - id + properties: + type: + type: string + description: The object type. + id: + type: string + description: The ID of the tool call. This ID must be referenced when you submit tool outputs. + discriminator: + propertyName: type + mapping: + code_interpreter: '#/components/schemas/RunStepCodeInterpreterToolCall' + file_search: '#/components/schemas/RunStepFileSearchToolCall' + function: '#/components/schemas/RunStepFunctionToolCall' + description: An abstract representation of a detailed tool call as recorded within a run step for an existing run. + RunStepToolCallDetails: + type: object + required: + - type + - tool_calls + properties: + type: + type: string + enum: + - tool_calls + description: The object type, which is always 'tool_calls'. + tool_calls: + type: array + items: + $ref: '#/components/schemas/RunStepToolCall' + description: A list of tool call details for this run step. + allOf: + - $ref: '#/components/schemas/RunStepDetails' + description: The detailed information associated with a run step calling tools. + RunStepType: + anyOf: + - type: string + - type: string + enum: + - message_creation + - tool_calls + description: The possible types of run steps. + RunStreamEvent: + anyOf: + - type: string + - type: string + enum: + - thread.run.created + - thread.run.queued + - thread.run.in_progress + - thread.run.requires_action + - thread.run.completed + - thread.run.failed + - thread.run.cancelling + - thread.run.cancelled + - thread.run.expired + description: Run operation related streaming events + ServiceApiVersions: + type: string + enum: + - 2024-02-15-preview + - 2024-05-01-preview + description: The known set of supported API versions. + SubmitToolOutputsAction: + type: object + required: + - type + - submit_tool_outputs + properties: + type: + type: string + enum: + - submit_tool_outputs + description: The object type, which is always 'submit_tool_outputs'. + submit_tool_outputs: + allOf: + - $ref: '#/components/schemas/SubmitToolOutputsDetails' + description: The details describing tools that should be called to submit tool outputs. + allOf: + - $ref: '#/components/schemas/RequiredAction' + description: The details for required tool calls that must be submitted for an assistant thread run to continue. + SubmitToolOutputsDetails: + type: object + required: + - tool_calls + properties: + tool_calls: + type: array + items: + $ref: '#/components/schemas/RequiredToolCall' + description: The list of tool calls that must be resolved for the assistant thread run to continue. + description: The details describing tools that should be called to submit tool outputs. + ThreadDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - thread.deleted + description: The object type, which is always 'thread.deleted'. + description: The status of a thread deletion operation. + ThreadMessage: + type: object + required: + - id + - object + - created_at + - thread_id + - status + - incomplete_details + - completed_at + - incomplete_at + - role + - content + - assistant_id + - run_id + - attachments + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.message + description: The object type, which is always 'thread.message'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + thread_id: + type: string + description: The ID of the thread that this message belongs to. + status: + allOf: + - $ref: '#/components/schemas/MessageStatus' + description: The status of the message. + incomplete_details: + type: object + allOf: + - $ref: '#/components/schemas/MessageIncompleteDetails' + nullable: true + description: On an incomplete message, details about why the message is incomplete. + completed_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp (in seconds) for when the message was completed. + incomplete_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp (in seconds) for when the message was marked as incomplete. + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + description: The role associated with the assistant thread message. + content: + type: array + items: + $ref: '#/components/schemas/MessageContent' + description: The list of content items associated with the assistant thread message. + assistant_id: + type: string + nullable: true + description: If applicable, the ID of the assistant that authored this message. + run_id: + type: string + nullable: true + description: If applicable, the ID of the run associated with the authoring of this message. + attachments: + type: array + items: + $ref: '#/components/schemas/MessageAttachment' + nullable: true + description: A list of files attached to the message, and the tools they were added to. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: A single, existing message within an assistant thread. + ThreadMessageOptions: + type: object + required: + - role + - content + properties: + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + 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 + description: |- + The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via + a separate call to the create message API. + attachments: + type: array + items: + $ref: '#/components/schemas/MessageAttachment' + nullable: true + description: A list of files attached to the message, and the tools they should be added to. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: A single message within an assistant thread, as provided during that thread's creation for its initial state. + ThreadRun: + type: object + required: + - id + - object + - thread_id + - assistant_id + - status + - last_error + - model + - instructions + - tools + - created_at + - expires_at + - started_at + - completed_at + - cancelled_at + - failed_at + - incomplete_details + - usage + - max_prompt_tokens + - max_completion_tokens + - truncation_strategy + - tool_choice + - response_format + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.run + description: The object type, which is always 'thread.run'. + thread_id: + type: string + description: The ID of the thread associated with this run. + assistant_id: + type: string + description: The ID of the assistant associated with the thread this run was performed against. + status: + allOf: + - $ref: '#/components/schemas/RunStatus' + description: The status of the assistant thread run. + required_action: + type: object + allOf: + - $ref: '#/components/schemas/RequiredAction' + nullable: true + description: The details of the action required for the assistant thread run to continue. + last_error: + type: object + allOf: + - $ref: '#/components/schemas/RunError' + nullable: true + description: The last error, if any, encountered by this assistant thread run. + model: + type: string + description: The ID of the model to use. + instructions: + type: string + description: The overridden system instructions used for this assistant thread run. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The overridden enabled tools used for this assistant thread run. + default: [] + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + expires_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp, in seconds, representing when this item expires. + started_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp, in seconds, representing when this item was started. + completed_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp, in seconds, representing when this completed. + cancelled_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp, in seconds, representing when this was cancelled. + failed_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp, in seconds, representing when this failed. + incomplete_details: + oneOf: + - $ref: '#/components/schemas/IncompleteRunDetails' + nullable: true + description: Details on why the run is incomplete. Will be `null` if the run is not incomplete. + usage: + type: object + allOf: + - $ref: '#/components/schemas/RunCompletionUsage' + nullable: true + 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.). + temperature: + type: number + format: float + nullable: true + description: The sampling temperature used for this run. If not set, defaults to 1. + top_p: + type: number + format: float + nullable: true + description: The nucleus sampling value used for this run. If not set, defaults to 1. + max_prompt_tokens: + type: integer + format: int32 + nullable: true + minimum: 256 + description: The maximum number of prompt tokens specified to have been used over the course of the run. + max_completion_tokens: + type: integer + format: int32 + nullable: true + minimum: 256 + description: The maximum number of completion tokens specified to have been used over the course of the run. + truncation_strategy: + type: object + allOf: + - $ref: '#/components/schemas/TruncationObject' + nullable: true + description: The strategy to use for dropping messages as the context windows moves forward. + tool_choice: + oneOf: + - $ref: '#/components/schemas/AssistantsApiToolChoiceOption' + nullable: true + description: Controls whether or not and which tool is called by the model. + response_format: + oneOf: + - $ref: '#/components/schemas/AssistantsApiResponseFormatOption' + nullable: true + description: The response format of the tool calls used in this run. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Data representing a single evaluation run of an assistant thread. + ThreadStreamEvent: + anyOf: + - type: string + - type: string + enum: + - thread.created + description: Thread operation related streaming events + ToolDefinition: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + code_interpreter: '#/components/schemas/CodeInterpreterToolDefinition' + file_search: '#/components/schemas/FileSearchToolDefinition' + function: '#/components/schemas/FunctionToolDefinition' + description: An abstract representation of an input tool definition that an assistant can use. + ToolOutput: + type: object + properties: + tool_call_id: + type: string + description: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. + output: + type: string + description: The output from the tool to be submitted. + description: The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. + ToolResources: + type: object + properties: + code_interpreter: + allOf: + - $ref: '#/components/schemas/CodeInterpreterToolResource' + description: Resources to be used by the `code_interpreter tool` consisting of file IDs. + file_search: + allOf: + - $ref: '#/components/schemas/FileSearchToolResource' + description: Resources to be used by the `file_search` tool consisting of vector store IDs. + 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. + TruncationObject: + type: object + required: + - type + properties: + type: + allOf: + - $ref: '#/components/schemas/TruncationStrategy' + 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 `lastMessages` count 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`. + default: auto + last_messages: + type: integer + format: int32 + nullable: true + minimum: 1 + description: The number of most recent messages from the thread when constructing the context for the run. + description: |- + Controls for how a thread will be truncated prior to the run. Use this to control the initial + context window of the run. + TruncationStrategy: + anyOf: + - type: string + - type: string + enum: + - auto + - last_messages + description: Possible truncation strategies for the thread. + UpdateAssistantOptions: + type: object + properties: + model: + type: string + description: The ID of the model to use. + name: + type: string + nullable: true + description: The modified name for the assistant to use. + description: + type: string + nullable: true + description: The modified description for the assistant to use. + instructions: + type: string + nullable: true + description: The modified system instructions for the new assistant to use. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The modified collection of tools to enable for the assistant. + default: [] + tool_resources: + allOf: + - $ref: '#/components/schemas/UpdateToolResourcesOptions' + 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. + temperature: + type: number + format: float + nullable: true + minimum: 0 + maximum: 2 + 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. + default: 1 + top_p: + type: number + format: float + nullable: true + minimum: 0 + maximum: 1 + 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. + default: 1 + response_format: + oneOf: + - $ref: '#/components/schemas/AssistantsApiResponseFormatOption' + nullable: true + description: The response format of the tool calls used by this assistant. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The request details to use when modifying an existing assistant. + UpdateAssistantThreadOptions: + type: object + properties: + tool_resources: + type: object + allOf: + - $ref: '#/components/schemas/UpdateToolResourcesOptions' + nullable: true + 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 + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The details used to update an existing assistant thread + UpdateCodeInterpreterToolResourceOptions: + type: object + properties: + fileIds: + type: array + items: + type: string + maxItems: 20 + description: A list of file IDs to override the current list of the assistant. + description: Request object to update `code_interpreted` tool resources. + UpdateFileSearchToolResourceOptions: + type: object + properties: + vectorStoreIds: + type: array + items: + type: string + maxItems: 1 + description: A list of vector store IDs to override the current list of the assistant. + description: Request object to update `file_search` tool resources. + UpdateToolResourcesOptions: + type: object + properties: + code_interpreter: + allOf: + - $ref: '#/components/schemas/UpdateCodeInterpreterToolResourceOptions' + 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. + file_search: + allOf: + - $ref: '#/components/schemas/UpdateFileSearchToolResourceOptions' + description: Overrides the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + description: |- + Request object. 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. + VectorStore: + type: object + required: + - id + - object + - created_at + - name + - usage_bytes + - file_counts + - status + - last_active_at + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - vector_store + description: The object type, which is always `vector_store` + created_at: + type: integer + format: unixtime + description: The Unix timestamp (in seconds) for when the vector store was created. + name: + type: string + description: The name of the vector store. + usage_bytes: + type: integer + format: int32 + description: The total number of bytes used by the files in the vector store. + file_counts: + allOf: + - $ref: '#/components/schemas/VectorStoreFileCount' + description: Files count grouped by status processed or being processed by this vector store. + status: + allOf: + - $ref: '#/components/schemas/VectorStoreStatus' + 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. + expires_after: + allOf: + - $ref: '#/components/schemas/VectorStoreExpirationPolicy' + description: Details on when this vector store expires + expires_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp (in seconds) for when the vector store will expire. + last_active_at: + type: integer + format: unixtime + nullable: true + description: The Unix timestamp (in seconds) for when the vector store was last active. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: A vector store is a collection of processed files can be used by the `file_search` tool. + VectorStoreDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - vector_store.deleted + description: The object type, which is always 'vector_store.deleted'. + description: Response object for deleting a vector store. + VectorStoreExpirationPolicy: + type: object + required: + - anchor + - days + properties: + anchor: + allOf: + - $ref: '#/components/schemas/VectorStoreExpirationPolicyAnchor' + description: 'Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.' + days: + type: integer + format: int32 + minimum: 1 + maximum: 365 + description: The anchor timestamp after which the expiration policy applies. + description: The expiration policy for a vector store. + VectorStoreExpirationPolicyAnchor: + anyOf: + - type: string + - type: string + enum: + - last_active_at + description: Describes the relationship between the days and the expiration of this vector store + VectorStoreFile: + type: object + required: + - id + - object + - usage_bytes + - created_at + - vector_store_id + - status + - last_error + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - vector_store.file + description: The object type, which is always `vector_store.file`. + usage_bytes: + type: integer + format: int32 + description: |- + The total vector store usage in bytes. Note that this may be different from the original file + size. + created_at: + type: integer + format: unixtime + description: The Unix timestamp (in seconds) for when the vector store file was created. + vector_store_id: + type: string + description: The ID of the vector store that the file is attached to. + status: + allOf: + - $ref: '#/components/schemas/VectorStoreFileStatus' + 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. + last_error: + type: object + allOf: + - $ref: '#/components/schemas/VectorStoreFileError' + nullable: true + description: The last error associated with this vector store file. Will be `null` if there are no errors. + description: Description of a file attached to a vector store. + VectorStoreFileBatch: + type: object + required: + - id + - object + - created_at + - vector_store_id + - status + - file_counts + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - vector_store.files_batch + description: The object type, which is always `vector_store.file_batch`. + created_at: + type: integer + format: unixtime + description: The Unix timestamp (in seconds) for when the vector store files batch was created. + vector_store_id: + type: string + description: The ID of the vector store that the file is attached to. + status: + allOf: + - $ref: '#/components/schemas/VectorStoreFileBatchStatus' + description: The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`. + file_counts: + allOf: + - $ref: '#/components/schemas/VectorStoreFileCount' + description: Files count grouped by status processed or being processed by this vector store. + description: A batch of files attached to a vector store. + VectorStoreFileBatchStatus: + anyOf: + - type: string + - type: string + enum: + - in_progress + - completed + - cancelled + - failed + description: The status of the vector store file batch. + VectorStoreFileCount: + type: object + required: + - in_progress + - completed + - failed + - cancelled + - total + properties: + in_progress: + type: integer + format: int32 + description: The number of files that are currently being processed. + completed: + type: integer + format: int32 + description: The number of files that have been successfully processed. + failed: + type: integer + format: int32 + description: The number of files that have failed to process. + cancelled: + type: integer + format: int32 + description: The number of files that were cancelled. + total: + type: integer + format: int32 + description: The total number of files. + description: Counts of files processed or being processed by this vector store grouped by status. + VectorStoreFileDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - vector_store.file.deleted + description: The object type, which is always 'vector_store.deleted'. + description: Response object for deleting a vector store file relationship. + VectorStoreFileError: + type: object + required: + - code + - message + properties: + code: + allOf: + - $ref: '#/components/schemas/VectorStoreFileErrorCode' + description: One of `server_error` or `rate_limit_exceeded`. + message: + type: string + description: A human-readable description of the error. + description: Details on the error that may have ocurred while processing a file for this vector store + VectorStoreFileErrorCode: + anyOf: + - type: string + - type: string + enum: + - internal_error + - file_not_found + - parsing_error + - unhandled_mime_type + description: Error code variants for vector store file processing + VectorStoreFileStatus: + anyOf: + - type: string + - type: string + enum: + - in_progress + - completed + - failed + - cancelled + description: Vector store file status + VectorStoreFileStatusFilter: + anyOf: + - type: string + - type: string + enum: + - in_progress + - completed + - failed + - cancelled + description: Query parameter filter for vector store file retrieval endpoint + VectorStoreOptions: + type: object + properties: + file_ids: + type: array + items: + type: string + maxItems: 500 + description: A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files. + name: + type: string + description: The name of the vector store. + expires_after: + allOf: + - $ref: '#/components/schemas/VectorStoreExpirationPolicy' + description: Details on when this vector store expires + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Request object for creating a vector store. + VectorStoreStatus: + anyOf: + - type: string + - type: string + enum: + - expired + - in_progress + - completed + description: Vector store possible status + VectorStoreUpdateOptions: + type: object + properties: + name: + type: string + nullable: true + description: The name of the vector store. + expires_after: + type: object + allOf: + - $ref: '#/components/schemas/VectorStoreExpirationPolicy' + nullable: true + description: Details on when this vector store expires + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Request object for updating a vector store. + securitySchemes: + ApiKeyAuth: + type: apiKey + in: header + name: api-key + OAuth2Auth: + type: oauth2 + flows: + implicit: + authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize + scopes: + https://cognitiveservices.azure.com/.default: '' +servers: + - url: '{endpoint}' + description: Azure OpenAI APIs for Assistants. + variables: + endpoint: + default: '' + description: An OpenAI endpoint supporting assistants functionality. From 01d18325fad3bfeaca7d22e1fbdf554a7810b70d Mon Sep 17 00:00:00 2001 From: YunsongB <39966392+YunsongB@users.noreply.github.com> Date: Fri, 31 May 2024 11:41:41 -0600 Subject: [PATCH 15/49] Fix spec error for OpenAI api ver 2024-05-01-preview; (#29293) Co-authored-by: Yunsong Bai --- .../authoring/preview/2024-05-01-preview/azureopenai.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.yaml index a35b53de7aca..58c54bbc32e5 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.yaml +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.yaml @@ -1171,10 +1171,10 @@ definitions: innerErrors: type: array items: - type: string + type: string IngestionJobProgress: title: IngestionJobProgress - type: object + type: object required: - stageProgress properties: From f4c6c8697c59f966db0d1e36b62df3af3bca9065 Mon Sep 17 00:00:00 2001 From: Mark Cowlishaw Date: Fri, 31 May 2024 16:42:11 -0700 Subject: [PATCH 16/49] Fix deprecated linter reference (#29294) --- specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml b/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml index 055df028743e..d165ce086157 100644 --- a/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml +++ b/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml @@ -1,6 +1,6 @@ linter: extends: - - "@azure-tools/typespec-azure-resource-manager/all" + - "@azure-tools/typespec-azure-rulesets/resource-manager" emit: - "@azure-tools/typespec-autorest" options: From 92a02c9755fa3b2359df8dfc031babcddf6d91ba Mon Sep 17 00:00:00 2001 From: "Alex Matei (Microsoft)" <168020294+almat-msft@users.noreply.github.com> Date: Fri, 31 May 2024 19:39:07 -0700 Subject: [PATCH 17/49] Added Common Types, Managed Identity v6 (#29155) --- .../v6/managedidentity.json | 110 +++ .../resource-management/v6/types.json | 681 ++++++++++++++++++ 2 files changed, 791 insertions(+) create mode 100644 specification/common-types/resource-management/v6/managedidentity.json create mode 100644 specification/common-types/resource-management/v6/types.json diff --git a/specification/common-types/resource-management/v6/managedidentity.json b/specification/common-types/resource-management/v6/managedidentity.json new file mode 100644 index 000000000000..f7c187e1147d --- /dev/null +++ b/specification/common-types/resource-management/v6/managedidentity.json @@ -0,0 +1,110 @@ +{ + "swagger": "2.0", + "info": { + "version": "6.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "UserAssignedIdentity": { + "type": "object", + "description": "User assigned identity properties", + "properties": { + "principalId": { + "description": "The principal ID of the assigned identity.", + "format": "uuid", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client ID of the assigned identity.", + "format": "uuid", + "type": "string", + "readOnly": true + } + } + }, + "ManagedServiceIdentityType": { + "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true + } + }, + "ManagedServiceIdentity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "$ref": "#/definitions/ManagedServiceIdentityType" + }, + "userAssignedIdentities": { + "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity", + "x-nullable": true + } + } + }, + "required": [ + "type" + ] + }, + "SystemAssignedServiceIdentityType": { + "description": "Type of managed service identity (either system assigned, or none).", + "enum": [ + "None", + "SystemAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "SystemAssignedServiceIdentityType", + "modelAsString": true + } + }, + "SystemAssignedServiceIdentity": { + "description": "Managed service identity (either system assigned, or none)", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "$ref": "#/definitions/SystemAssignedServiceIdentityType" + } + }, + "required": [ + "type" + ] + } + } +} diff --git a/specification/common-types/resource-management/v6/types.json b/specification/common-types/resource-management/v6/types.json new file mode 100644 index 000000000000..94cb1a2d63c8 --- /dev/null +++ b/specification/common-types/resource-management/v6/types.json @@ -0,0 +1,681 @@ +{ + "swagger": "2.0", + "info": { + "version": "6.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "Resource": { + "title": "Resource", + "description": "Common fields that are returned in the response for all Azure Resource Manager resources", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" + }, + "systemData": { + "readOnly": true, + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "#/definitions/systemData" + } + }, + "x-ms-azure-resource": true + }, + "AzureEntityResource": { + "x-ms-client-name": "AzureEntityResource", + "title": "Entity Resource", + "description": "The resource model definition for an Azure Resource Manager resource with an etag.", + "type": "object", + "properties": { + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "TrackedResource": { + "title": "Tracked Resource", + "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "title": "Proxy Resource", + "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ResourceModelWithAllowedPropertySet": { + "description": "The resource model definition containing the full set of allowed properties for a resource. Except properties bag, there cannot be a top level property outside of this set.", + "type": "object", + "properties": { + "managedBy": { + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "kind": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", + "pattern": "^[-\\w\\._,\\(\\)]+$" + }, + "etag": { + "readOnly": true, + "type": "string", + "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. 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. " + }, + "identity": { + "$ref": "./managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "plan": { + "$ref": "#/definitions/Plan" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "SkuTier": { + "type": "string", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + }, + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." + }, + "Sku": { + "description": "The resource model definition representing SKU", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. E.g. P3. It is typically a letter+number code" + }, + "tier": { + "$ref": "#/definitions/SkuTier" + }, + "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" + ] + }, + "Plan": { + "type": "object", + "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." + } + }, + "description": "Plan for the resource.", + "required": [ + "name", + "publisher", + "product" + ] + }, + "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." + } + } + }, + "ErrorResponse": { + "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.).", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "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." + }, + "Operation": { + "title": "REST API Operation", + "description": "Details of a REST API operation, returned from the Resource Provider Operations API", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"", + "type": "string", + "readOnly": true + }, + "isDataAction": { + "description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.", + "type": "boolean", + "readOnly": true + }, + "display": { + "description": "Localized display information for this particular operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.", + "type": "string", + "readOnly": true + } + } + }, + "origin": { + "description": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"", + "type": "string", + "readOnly": true, + "enum": [ + "user", + "system", + "user,system" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true + } + }, + "actionType": { + "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", + "type": "string", + "readOnly": true, + "enum": [ + "Internal" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + } + } + }, + "OperationListResult": { + "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of operations supported by the resource provider", + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + } + }, + "OperationStatusResult": { + "description": "The current status of an async operation.", + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "description": "Fully qualified ID for the async operation.", + "type": "string", + "format": "arm-id" + }, + "resourceId": { + "description": "Fully qualified ID of the resource against which the original async operation was started.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "name": { + "description": "Name of the async operation.", + "type": "string" + }, + "status": { + "description": "Operation status.", + "type": "string" + }, + "percentComplete": { + "description": "Percent of the operation that is complete.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation.", + "type": "string", + "format": "date-time" + }, + "operations": { + "description": "The operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationStatusResult" + } + }, + "error": { + "description": "If present, details of the operation error.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "locationData": { + "description": "Metadata pertaining to the geographic location of the resource.", + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 256, + "description": "A canonical name for the geographic or physical location." + }, + "city": { + "type": "string", + "description": "The city or locality where the resource is located." + }, + "district": { + "type": "string", + "description": "The district, state, or province where the resource is located." + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region where the resource is located" + } + }, + "required": [ + "name" + ] + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "encryptionProperties": { + "description": "Configuration of key for data encryption", + "type": "object", + "properties": { + "status": { + "description": "Indicates whether or not the encryption is enabled for container registry.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Key vault properties." + } + } + }, + "KeyVaultProperties": { + "type": "object", + "properties": { + "keyIdentifier": { + "description": "Key vault uri to access the encryption key.", + "type": "string" + }, + "identity": { + "description": "The client ID of the identity which will be used to access key vault.", + "type": "string" + } + } + }, + "CheckNameAvailabilityRequest": { + "description": "The check availability request body.", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource for which availability needs to be checked.", + "type": "string" + }, + "type": { + "description": "The resource type.", + "type": "string" + } + } + }, + "CheckNameAvailabilityResponse": { + "description": "The check availability result.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates if the resource name is available.", + "type": "boolean" + }, + "reason": { + "description": "The reason why the given name is not available.", + "type": "string", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "CheckNameAvailabilityReason", + "modelAsString": true + } + }, + "message": { + "description": "Detailed reason why the given name is available.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "The ID of the target subscription. The value must be an UUID." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation.", + "minLength": 1 + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ManagementGroupNameParameter": { + "name": "managementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the management group. The name is case insensitive.", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ScopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope at which the operation is performed.", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "TenantIdParameter": { + "name": "tenantId", + "in": "path", + "description": "The Azure tenant ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of an ongoing async operation.", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure region.", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "If-Match": { + "name": "ifMatch", + "in": "header", + "required": true, + "type": "string", + "description": "The If-Match header that makes a request conditional.", + "x-ms-parameter-location": "method" + }, + "If-None-Match": { + "name": "ifNoneMatch", + "in": "header", + "required": true, + "type": "string", + "description": "The If-None-Match header that makes a request conditional.", + "x-ms-parameter-location": "method" + } + } +} From cd47418616e7308f2aa1797a6b2bd3750dc8f8a6 Mon Sep 17 00:00:00 2001 From: Asaf Levi <100200009+asaflevi-ms@users.noreply.github.com> Date: Mon, 3 Jun 2024 10:28:33 +0300 Subject: [PATCH 18/49] Add Entra ID OAuthe2 token support (#29032) * Add AAD OAuthe2 token support * EntraIdToken * Update specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp Co-authored-by: catalinaperalta * remove suppression * update spec after merge --------- Co-authored-by: koen-mertens <138520871+koen-mertens@users.noreply.github.com> Co-authored-by: catalinaperalta --- .../HealthInsights.OpenAPI/service.tsp | 7 ++++++- .../HealthInsights/stable/2024-04-01/openapi.json | 15 +++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp b/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp index d58ea4d9417c..69e543791ba8 100644 --- a/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp @@ -16,13 +16,18 @@ using TypeSpec.Versioning; endpoint: url, } ) -@useAuth(AzureKey) +@useAuth(AzureKey | EntraIdToken) namespace AzureHealthInsights; @doc("The secret key for your Azure Cognitive Services subscription.") model AzureKey is ApiKeyAuth; +@doc("The Microsoft Entra Id Flow") +model EntraIdToken + is Azure.Core.AadOauth2Auth<["https://cognitiveservices.azure.com/.default"]>; + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "https://github.com/Azure/typespec-azure/issues/3107" enum ApiVersion { @useDependency(Azure.Core.Versions.v1_0_Preview_2) v2024_04_01: "2024-04-01", diff --git a/specification/ai/data-plane/HealthInsights/stable/2024-04-01/openapi.json b/specification/ai/data-plane/HealthInsights/stable/2024-04-01/openapi.json index 517353153cee..9e49f8375fbd 100644 --- a/specification/ai/data-plane/HealthInsights/stable/2024-04-01/openapi.json +++ b/specification/ai/data-plane/HealthInsights/stable/2024-04-01/openapi.json @@ -37,6 +37,11 @@ "security": [ { "AzureKey": [] + }, + { + "EntraIdToken": [ + "https://cognitiveservices.azure.com/.default" + ] } ], "securityDefinitions": { @@ -45,6 +50,16 @@ "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": [ From bf9738223ed8c1c25485980b74cfb8ef4158b847 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Mon, 3 Jun 2024 17:44:55 +0800 Subject: [PATCH 19/49] Update readme.python.md (#29301) --- specification/mysql/resource-manager/readme.python.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/mysql/resource-manager/readme.python.md b/specification/mysql/resource-manager/readme.python.md index db6653d8d86f..5562369742c2 100644 --- a/specification/mysql/resource-manager/readme.python.md +++ b/specification/mysql/resource-manager/readme.python.md @@ -23,16 +23,16 @@ Generate all API versions currently shipped for this package ```yaml $(python) clear-output-folder: true batch: - - tag: package-flexibleserver-2023-12-01-preview + - tag: package-flexibleserver-2024-02-01-preview - tag: package-2020-01-01 ``` -### Tag: package-flexibleserver-2023-12-01-preview and python +### Tag: package-flexibleserver-2024-02-01-preview and python -These settings apply only when `--tag=package-flexibleserver-2023-12-01-preview --python` is specified on the command line. +These settings apply only when `--tag=package-flexibleserver-2024-02-01-preview --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-flexibleserver-2023-12-01-preview' && $(python) +``` yaml $(tag) == 'package-flexibleserver-2024-02-01-preview' && $(python) namespace: azure.mgmt.rdbms.mysql_flexibleservers output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql_flexibleservers ``` @@ -50,4 +50,4 @@ output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mys ``` yaml $(python) modelerfour: lenient-model-deduplication: true -``` \ No newline at end of file +``` From 871324004185488ac0beddf5cab7165e7432f317 Mon Sep 17 00:00:00 2001 From: Libba Lawrence Date: Mon, 3 Jun 2024 12:43:59 -0700 Subject: [PATCH 20/49] [EG] GA client.tsp updates (#29208) * try this * ver * update * details * update * renew locks result rename * add new version - testing * remove diff * ga version * update * try alias * all operations mark as internal to allow for topic/sub customization * remove * tsp format * alias change * details * changes * after merge required regen * nit * try * tsp format * edits off of lang * only python * nit * Fixing some names for Go, based on Go arch feedback. * One more rename * Update specification/eventgrid/Azure.Messaging.EventGrid/client.tsp * fixing go diff * update * update internal --------- Co-authored-by: ripark --- .../Azure.Messaging.EventGrid/client.tsp | 146 +++++++++++++++++- .../Azure.Messaging.EventGrid/main.tsp | 36 ++--- .../preview/2023-06-01-preview/EventGrid.json | 99 +++++------- .../preview/2023-10-01-preview/EventGrid.json | 132 +++++++--------- .../stable/2023-11-01/EventGrid.json | 99 +++++------- .../stable/2024-06-01/EventGrid.json | 132 +++++++--------- 6 files changed, 351 insertions(+), 293 deletions(-) diff --git a/specification/eventgrid/Azure.Messaging.EventGrid/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid/client.tsp index a070743629c9..c5bfa4531cdd 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid/client.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid/client.tsp @@ -1,8 +1,148 @@ import "@azure-tools/typespec-client-generator-core"; import "./main.tsp"; +import "@typespec/versioning"; using Azure.ClientGenerator.Core; +using Microsoft.EventGrid; -@@access(Microsoft.EventGrid.publishCloudEvent, Access.internal, "python"); -@@access(Microsoft.EventGrid.publishCloudEvents, Access.internal, "python"); -@@access(Microsoft.EventGrid.receiveCloudEvents, Access.internal, "python"); +@TypeSpec.Versioning.useDependency(ServiceApiVersions.v2024_06_01) +namespace Customizations { + @client( + { + name: "EventGridPublisherClient", + service: Microsoft.EventGrid, + }, + "python" + ) + interface Client1 { + send is publishCloudEvent; + sendEvents is publishCloudEvents; + } + + @client( + { + name: "EventGridConsumerClient", + service: Microsoft.EventGrid, + }, + "python" + ) + interface Client2 { + receive is receiveCloudEvents; + acknowledge is acknowledgeCloudEvents; + release is releaseCloudEvents; + reject is rejectCloudEvents; + renewLocks is renewCloudEventLocks; + } + + @client( + { + name: "EventGridSenderClient", + service: Microsoft.EventGrid, + }, + "csharp" + ) + interface ClientSender { + send is publishCloudEvent; + sendEvents is publishCloudEvents; + } + + @client( + { + name: "EventGridReceiverClient", + service: Microsoft.EventGrid, + }, + "csharp" + ) + interface ClientReceiver { + receive is receiveCloudEvents; + acknowledge is acknowledgeCloudEvents; + release is releaseCloudEvents; + reject is rejectCloudEvents; + renewLocks is renewCloudEventLocks; + } + + @client( + { + name: "EventGridSenderClient", + service: Microsoft.EventGrid, + }, + "java" + ) + interface ClientSender2 { + send is publishCloudEvent; + sendEvents is publishCloudEvents; + } + + @client( + { + name: "EventGridReceiverClient", + service: Microsoft.EventGrid, + }, + "java" + ) + interface ClientReceiver2 { + receive is receiveCloudEvents; + acknowledge is acknowledgeCloudEvents; + release is releaseCloudEvents; + reject is rejectCloudEvents; + renewLocks is renewCloudEventLocks; + } + + @client( + { + name: "SenderClient", + service: Microsoft.EventGrid, + }, + "go" + ) + interface ClientSenderGo { + sendEvent is publishCloudEvent; + sendEvents is publishCloudEvents; + } + + @client( + { + name: "ReceiverClient", + service: Microsoft.EventGrid, + }, + "go" + ) + interface ClientReceiverGo { + receiveEvents is receiveCloudEvents; + acknowledgeEvents is acknowledgeCloudEvents; + releaseEvents is releaseCloudEvents; + rejectEvents is rejectCloudEvents; + renewEventLocks is renewCloudEventLocks; + } +} + +// All Language customizations + +// publishCloudEvent access level +@@access(publishCloudEvent, Access.internal, "python"); + +// publishCloudEvents access level +@@access(publishCloudEvents, Access.internal, "python"); + +@@access(receiveCloudEvents, Access.internal, "python"); +@@access(acknowledgeCloudEvents, Access.internal, "python"); +@@access(releaseCloudEvents, Access.internal, "python"); +@@access(rejectCloudEvents, Access.internal, "python"); +@@access(renewCloudEventLocks, Access.internal, "python"); + +@@access(AcknowledgeResult, Access.public); +@@access(ReleaseResult, Access.public); +@@access(RejectResult, Access.public); +@@access(RenewCloudEventLocksResult, Access.public); +@@access(ReleaseDelay, Access.public); +@@access(FailedLockToken, Access.public); + +@@clientName(ReleaseDelay.By0Seconds, "NoDelay"); +@@clientName(ReleaseDelay.By10Seconds, "TenSeconds"); +@@clientName(ReleaseDelay.By3600Seconds, "OneHour"); +@@clientName(ReleaseDelay.By600Seconds, "TenMinutes"); +@@clientName(ReleaseDelay.By60Seconds, "OneMinute"); + +@@clientName(RenewCloudEventLocksResult, "RenewLocksResult"); + +@@clientName(ReceiveResult.value, "details"); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid/main.tsp b/specification/eventgrid/Azure.Messaging.EventGrid/main.tsp index cf6989f96ada..38cb94d4dfb1 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid/main.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid/main.tsp @@ -189,29 +189,25 @@ namespace Microsoft.EventGrid { succeededLockTokens: string[]; } - @doc("Array of lock tokens for the corresponding received Cloud Events to be released.") - model ReleaseOptions { + alias ReleaseOptions = { @doc("Array of lock tokens.") lockTokens: string[]; - } + }; - @doc("Array of lock tokens for the corresponding received Cloud Events to be acknowledged.") - model AcknowledgeOptions { + alias AcknowledgeOptions = { @doc("Array of lock tokens.") lockTokens: string[]; - } + }; - @doc("Array of lock tokens for the corresponding received Cloud Events to be rejected.") - model RejectOptions { + alias RejectOptions = { @doc("Array of lock tokens.") lockTokens: string[]; - } + }; - @doc("Array of lock tokens for the corresponding received Cloud Events to be renewed.") - model RenewLockOptions { + alias RenewLockOptions = { @doc("Array of lock tokens.") lockTokens: string[]; - } + }; @doc("Topic Resource.") @resource("topics") @@ -304,9 +300,7 @@ namespace Microsoft.EventGrid { op acknowledgeCloudEvents is StandardOperations.ResourceAction< EventSubscription, { - @doc("AcknowledgeOptions.") - @bodyRoot - acknowledgeOptions: AcknowledgeOptions; + ...AcknowledgeOptions; }, AcknowledgeResult >; @@ -319,9 +313,7 @@ namespace Microsoft.EventGrid { op releaseCloudEvents is StandardOperations.ResourceAction< EventSubscription, { - @doc("ReleaseOptions") - @bodyRoot - releaseOptions: ReleaseOptions; + ...ReleaseOptions; @added(ServiceApiVersions.v2023_10_01_preview) @removed(ServiceApiVersions.v2023_11_01) @@ -341,9 +333,7 @@ namespace Microsoft.EventGrid { op rejectCloudEvents is StandardOperations.ResourceAction< EventSubscription, { - @doc("RejectOptions") - @bodyRoot - rejectOptions: RejectOptions; + ...RejectOptions; }, RejectResult >; @@ -358,9 +348,7 @@ namespace Microsoft.EventGrid { op renewCloudEventLocks is StandardOperations.ResourceAction< EventSubscription, { - @doc("RenewLockOptions") - @bodyRoot - renewLockOptions: RenewLockOptions; + ...RenewLockOptions; }, RenewCloudEventLocksResult >; diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json index fa584d6142f6..b9576d96b25f 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json @@ -195,12 +195,23 @@ "type": "string" }, { - "name": "acknowledgeOptions", + "name": "body", "in": "body", - "description": "AcknowledgeOptions.", "required": true, "schema": { - "$ref": "#/definitions/AcknowledgeOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -254,12 +265,23 @@ "type": "string" }, { - "name": "releaseOptions", + "name": "body", "in": "body", - "description": "ReleaseOptions", "required": true, "schema": { - "$ref": "#/definitions/ReleaseOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -313,12 +335,23 @@ "type": "string" }, { - "name": "rejectOptions", + "name": "body", "in": "body", - "description": "RejectOptions", "required": true, "schema": { - "$ref": "#/definitions/RejectOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -411,22 +444,6 @@ } }, "definitions": { - "AcknowledgeOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be acknowledged.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] - }, "AcknowledgeResult": { "type": "object", "description": "The result of the Acknowledge operation.", @@ -642,22 +659,6 @@ "value" ] }, - "RejectOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be rejected.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] - }, "RejectResult": { "type": "object", "description": "The result of the Reject operation.", @@ -683,22 +684,6 @@ "succeededLockTokens" ] }, - "ReleaseOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be released.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] - }, "ReleaseResult": { "type": "object", "description": "The result of the Release operation.", diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-10-01-preview/EventGrid.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-10-01-preview/EventGrid.json index 10eee342b74c..ae498f775cfc 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-10-01-preview/EventGrid.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-10-01-preview/EventGrid.json @@ -195,12 +195,23 @@ "type": "string" }, { - "name": "acknowledgeOptions", + "name": "body", "in": "body", - "description": "AcknowledgeOptions.", "required": true, "schema": { - "$ref": "#/definitions/AcknowledgeOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -299,12 +310,23 @@ } }, { - "name": "releaseOptions", + "name": "body", "in": "body", - "description": "ReleaseOptions", "required": true, "schema": { - "$ref": "#/definitions/ReleaseOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -358,12 +380,23 @@ "type": "string" }, { - "name": "rejectOptions", + "name": "body", "in": "body", - "description": "RejectOptions", "required": true, "schema": { - "$ref": "#/definitions/RejectOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -417,12 +450,23 @@ "type": "string" }, { - "name": "renewLockOptions", + "name": "body", "in": "body", - "description": "RenewLockOptions", "required": true, "schema": { - "$ref": "#/definitions/RenewLockOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -515,22 +559,6 @@ } }, "definitions": { - "AcknowledgeOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be acknowledged.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] - }, "AcknowledgeResult": { "type": "object", "description": "The result of the Acknowledge operation.", @@ -746,22 +774,6 @@ "value" ] }, - "RejectOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be rejected.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] - }, "RejectResult": { "type": "object", "description": "The result of the Reject operation.", @@ -787,22 +799,6 @@ "succeededLockTokens" ] }, - "ReleaseOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be released.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] - }, "ReleaseResult": { "type": "object", "description": "The result of the Release operation.", @@ -852,22 +848,6 @@ "failedLockTokens", "succeededLockTokens" ] - }, - "RenewLockOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be renewed.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] } }, "parameters": { diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2023-11-01/EventGrid.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2023-11-01/EventGrid.json index 0610921c0773..1b210dacbd9c 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2023-11-01/EventGrid.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2023-11-01/EventGrid.json @@ -195,12 +195,23 @@ "type": "string" }, { - "name": "acknowledgeOptions", + "name": "body", "in": "body", - "description": "AcknowledgeOptions.", "required": true, "schema": { - "$ref": "#/definitions/AcknowledgeOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -254,12 +265,23 @@ "type": "string" }, { - "name": "releaseOptions", + "name": "body", "in": "body", - "description": "ReleaseOptions", "required": true, "schema": { - "$ref": "#/definitions/ReleaseOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -313,12 +335,23 @@ "type": "string" }, { - "name": "rejectOptions", + "name": "body", "in": "body", - "description": "RejectOptions", "required": true, "schema": { - "$ref": "#/definitions/RejectOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -411,22 +444,6 @@ } }, "definitions": { - "AcknowledgeOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be acknowledged.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] - }, "AcknowledgeResult": { "type": "object", "description": "The result of the Acknowledge operation.", @@ -642,22 +659,6 @@ "value" ] }, - "RejectOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be rejected.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] - }, "RejectResult": { "type": "object", "description": "The result of the Reject operation.", @@ -683,22 +684,6 @@ "succeededLockTokens" ] }, - "ReleaseOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be released.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] - }, "ReleaseResult": { "type": "object", "description": "The result of the Release operation.", diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-06-01/EventGrid.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-06-01/EventGrid.json index 375c891dc857..100c60db8cd4 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-06-01/EventGrid.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-06-01/EventGrid.json @@ -195,12 +195,23 @@ "type": "string" }, { - "name": "acknowledgeOptions", + "name": "body", "in": "body", - "description": "AcknowledgeOptions.", "required": true, "schema": { - "$ref": "#/definitions/AcknowledgeOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -299,12 +310,23 @@ } }, { - "name": "releaseOptions", + "name": "body", "in": "body", - "description": "ReleaseOptions", "required": true, "schema": { - "$ref": "#/definitions/ReleaseOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -358,12 +380,23 @@ "type": "string" }, { - "name": "rejectOptions", + "name": "body", "in": "body", - "description": "RejectOptions", "required": true, "schema": { - "$ref": "#/definitions/RejectOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -417,12 +450,23 @@ "type": "string" }, { - "name": "renewLockOptions", + "name": "body", "in": "body", - "description": "RenewLockOptions", "required": true, "schema": { - "$ref": "#/definitions/RenewLockOptions" + "type": "object", + "properties": { + "lockTokens": { + "type": "array", + "description": "Array of lock tokens.", + "items": { + "type": "string" + } + } + }, + "required": [ + "lockTokens" + ] } } ], @@ -515,22 +559,6 @@ } }, "definitions": { - "AcknowledgeOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be acknowledged.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] - }, "AcknowledgeResult": { "type": "object", "description": "The result of the Acknowledge operation.", @@ -746,22 +774,6 @@ "value" ] }, - "RejectOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be rejected.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] - }, "RejectResult": { "type": "object", "description": "The result of the Reject operation.", @@ -787,22 +799,6 @@ "succeededLockTokens" ] }, - "ReleaseOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be released.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] - }, "ReleaseResult": { "type": "object", "description": "The result of the Release operation.", @@ -852,22 +848,6 @@ "failedLockTokens", "succeededLockTokens" ] - }, - "RenewLockOptions": { - "type": "object", - "description": "Array of lock tokens for the corresponding received Cloud Events to be renewed.", - "properties": { - "lockTokens": { - "type": "array", - "description": "Array of lock tokens.", - "items": { - "type": "string" - } - } - }, - "required": [ - "lockTokens" - ] } }, "parameters": { From a58614a53ecd06c6e6638b58c407d5bd8e61c009 Mon Sep 17 00:00:00 2001 From: Libba Lawrence Date: Mon, 3 Jun 2024 12:44:29 -0700 Subject: [PATCH 21/49] [EG] System events reformat (#28706) * refactor * updayrd * format * add apicenter * update new events * tsp format * new events * modelAsString for Media Union as False * tsp format * Revert "tsp format" This reverts commit 1a01cf8de33e48e80ccde56cf1748f68a4ff86b8. * Revert "modelAsString for Media Union as False" This reverts commit 6b605812192def3ba6baef1894f53ea5ea71c854. * remove ReadOnly * rename resources * remove duplicate vault * remove Optional from Nullable Types part 1 * add csharp to x-ms-client-names * typo * swagger typo * formatting * Client Name Overrides JS EG System Events * Adding in renames for Go * fix RecordingDurationMs casing * Fixing something that Libba refused to for like months now. * Removing SystemEvents from the constant names * Should be a number == float64. * Field name is labelOperator, not operator. (as shown here: https://github.com/Azure/azure-rest-api-specs/blob/0a8300f818c1df4018e2586540bed4c72c7c5375/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L2120) * Field is state, not selectorState: https://github.com/Azure/azure-rest-api-specs/blob/0a8300f818c1df4018e2586540bed4c72c7c5375/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L2171 * More renames to bring us to par with what we had before. * Adding in some docs that were missing for unions. * format * fix warnigns * moving around clientNames * spellcheck * try to update csharp clientNames * tsp format * missing labelValue x-ms-client-name * format * nit typo * update csharp --------- Co-authored-by: Sarangan Rajamanickam Co-authored-by: ripark --- cSpell.json | 6 + .../{ => Microsoft.AVS}/AVS.tsp | 6 +- .../Microsoft.AVS/client.tsp | 91 + .../Microsoft.ApiCenter/ApiCenter.tsp | 35 + .../Microsoft.ApiCenter/client.tsp | 23 + .../ApiManagement.tsp | 0 .../Microsoft.ApiManagement/client.tsp | 161 ++ .../AppConfiguration.tsp | 0 .../Microsoft.AppConfiguration/client.tsp | 35 + .../{ => Microsoft.Cache}/RedisCache.tsp | 2 +- .../Microsoft.Cache/client.tsp | 29 + .../AzureCommunicationServices.tsp | 454 ++++- .../Microsoft.Communication/client.tsp | 513 +++++ .../ContainerRegistry.tsp | 16 +- .../Microsoft.ContainerRegistry/client.tsp | 77 + .../ContainerService.tsp | 0 .../Microsoft.ContainerService/client.tsp | 53 + .../{ => Microsoft.DataBox}/DataBox.tsp | 4 +- .../Microsoft.DataBox/client.tsp | 25 + .../{ => Microsoft.Devices}/IotHub.tsp | 20 +- .../Microsoft.Devices/client.tsp | 77 + .../{ => Microsoft.EventGrid}/EventGrid.tsp | 25 +- .../Microsoft.EventGrid/client.tsp | 65 + .../{ => Microsoft.EventHub}/EventHub.tsp | 4 +- .../Microsoft.EventHub/client.tsp | 11 + .../HealthcareApis.tsp | 6 +- .../Microsoft.HealthcareApis/client.tsp | 53 + .../{ => Microsoft.KeyVault}/KeyVault.tsp | 2 +- .../Microsoft.KeyVault/client.tsp | 65 + .../MachineLearningServices.tsp | 20 +- .../client.tsp | 35 + .../{ => Microsoft.Maps}/Maps.tsp | 2 +- .../Microsoft.Maps/client.tsp | 31 + .../{ => Microsoft.Media}/MediaServices.tsp | 102 +- .../Microsoft.Media/client.tsp | 171 ++ .../PolicyInsights.tsp | 2 +- .../Microsoft.PolicyInsights/client.tsp | 23 + .../ResourceNotifications.tsp | 14 +- .../client.tsp | 59 + .../{ => Microsoft.Resources}/Resources.tsp | 26 +- .../Microsoft.Resources/client.tsp | 63 + .../{ => Microsoft.ServiceBus}/ServiceBus.tsp | 0 .../Microsoft.ServiceBus/client.tsp | 29 + .../SignalRService.tsp | 2 +- .../Microsoft.SignalRService/client.tsp | 17 + .../{ => Microsoft.Storage}/Storage.tsp | 26 +- .../Microsoft.Storage/client.tsp | 107 + .../{ => Microsoft.Web}/Web.tsp | 14 +- .../Microsoft.Web/client.tsp | 103 + .../client.tsp | 1717 +---------------- .../main.tsp | 47 +- .../propertyNameOverride.tsp | 119 +- .../propertyNameOverrideCsharp.tsp | 206 ++ .../propertyNameOverrideGo.tsp | 592 ++++++ .../propertyNameOverrideJs.tsp | 167 ++ .../stable/2024-01-01/SystemEvents.json | 1563 ++++++++++++--- 56 files changed, 4790 insertions(+), 2325 deletions(-) rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.AVS}/AVS.tsp (93%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AVS/client.tsp create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiCenter/ApiCenter.tsp create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiCenter/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.ApiManagement}/ApiManagement.tsp (100%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiManagement/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.AppConfiguration}/AppConfiguration.tsp (100%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AppConfiguration/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.Cache}/RedisCache.tsp (97%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Cache/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.Communication}/AzureCommunicationServices.tsp (76%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.ContainerRegistry}/ContainerRegistry.tsp (93%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerRegistry/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.ContainerService}/ContainerService.tsp (100%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerService/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.DataBox}/DataBox.tsp (94%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.DataBox/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.Devices}/IotHub.tsp (94%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Devices/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.EventGrid}/EventGrid.tsp (90%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventGrid/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.EventHub}/EventHub.tsp (92%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventHub/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.HealthcareApis}/HealthcareApis.tsp (99%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.HealthcareApis/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.KeyVault}/KeyVault.tsp (98%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.KeyVault/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.MachineLearningServices}/MachineLearningServices.tsp (92%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.MachineLearningServices/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.Maps}/Maps.tsp (98%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Maps/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.Media}/MediaServices.tsp (88%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.PolicyInsights}/PolicyInsights.tsp (98%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.PolicyInsights/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.ResourceNotifications}/ResourceNotifications.tsp (91%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ResourceNotifications/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.Resources}/Resources.tsp (87%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Resources/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.ServiceBus}/ServiceBus.tsp (100%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ServiceBus/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.SignalRService}/SignalRService.tsp (97%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.SignalRService/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.Storage}/Storage.tsp (95%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Storage/client.tsp rename specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/{ => Microsoft.Web}/Web.tsp (96%) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Web/client.tsp create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideGo.tsp create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJs.tsp diff --git a/cSpell.json b/cSpell.json index ae2a6b889726..0af01c9ee4c6 100644 --- a/cSpell.json +++ b/cSpell.json @@ -378,6 +378,12 @@ "clientsession" ] }, + { + "filename": "**/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json", + "words": [ + "whatsapp" + ] + }, { "filename": "**/specification/eventgrid/data-plane/Microsoft.EventGrid/**/EventGrid.json", "words": [ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/AVS.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AVS/AVS.tsp similarity index 93% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/AVS.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AVS/AVS.tsp index 2ef13e50eb5b..deae256ada7b 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/AVS.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AVS/AVS.tsp @@ -39,11 +39,15 @@ model AvsClusterFailedEventData extends AvsClusterEventData { failureMessage?: string; } +/** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionStarted event. */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." +model AvsScriptExecutionStartedEventData extends AvsScriptExecutionEventData {} + /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFinished event. */ #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." model AvsScriptExecutionFinishedEventData extends AvsScriptExecutionEventData { /** Named outputs of completed execution, if any. */ - namedOutputs?: Record; + namedOutputs: Record; } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionCancelled event. */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AVS/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AVS/client.tsp new file mode 100644 index 000000000000..3809c94f7ef5 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AVS/client.tsp @@ -0,0 +1,91 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudUpdatingEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudUpdatingEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudFailedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudFailedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsClusterCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsClusterCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsClusterDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsClusterDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsClusterUpdatingEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsClusterUpdatingEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsClusterUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsClusterUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsClusterFailedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsClusterFailedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionStartedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionStartedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionFinishedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionFinishedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionCancelledEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionCancelledEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionFailedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionFailedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AvsClusterEventData, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AvsClusterEventData, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionEventData, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiCenter/ApiCenter.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiCenter/ApiCenter.tsp new file mode 100644 index 000000000000..db7c17afdadc --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiCenter/ApiCenter.tsp @@ -0,0 +1,35 @@ +/** Describes the schema of the Azure API Center events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ +namespace Microsoft.EventGrid.SystemEvents; + +/** Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionAdded event. */ +model ApiCenterApiDefinitionAddedEventData { + /** API definition title. */ + title?: string; + + /** API definition description. */ + description?: string; + + /** API definition specification. */ + specification: ApiCenterApiSpecification; +} + +/** Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionUpdated event. */ +model ApiCenterApiDefinitionUpdatedEventData { + /** API definition title. */ + title?: string; + + /** API definition description. */ + description?: string; + + /** API definition specification. */ + specification: ApiCenterApiSpecification; +} + +/** API specification details. */ +model ApiCenterApiSpecification { + /** Specification name. */ + name?: string; + + /** Specification version. */ + version?: string; +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiCenter/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiCenter/client.tsp new file mode 100644 index 000000000000..efcf1c1ab7c7 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiCenter/client.tsp @@ -0,0 +1,23 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.ApiCenterApiDefinitionAddedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiCenterApiDefinitionAddedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiCenterApiDefinitionUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiCenterApiDefinitionUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiCenterApiSpecification, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiCenterApiSpecification, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/ApiManagement.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiManagement/ApiManagement.tsp similarity index 100% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/ApiManagement.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiManagement/ApiManagement.tsp diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiManagement/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiManagement/client.tsp new file mode 100644 index 000000000000..fce0ed6f41e5 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ApiManagement/client.tsp @@ -0,0 +1,161 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementUserCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementUserCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementUserUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementUserUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementUserDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementUserDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementSubscriptionCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementSubscriptionCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementSubscriptionUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementSubscriptionUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementSubscriptionDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementSubscriptionDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementProductCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementProductCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementProductUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementProductUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementProductDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementProductDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementApiCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementApiCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementApiUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementApiUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementApiDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementApiDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementApiReleaseCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementApiReleaseCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementApiReleaseUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementApiReleaseUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementApiReleaseDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementApiReleaseDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayHostnameConfigurationCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayHostnameConfigurationCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayHostnameConfigurationUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayHostnameConfigurationUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayHostnameConfigurationDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayHostnameConfigurationDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCertificateAuthorityCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCertificateAuthorityCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCertificateAuthorityUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCertificateAuthorityUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCertificateAuthorityDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCertificateAuthorityDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayApiAddedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayApiAddedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayApiRemovedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayApiRemovedEventData, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/AppConfiguration.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AppConfiguration/AppConfiguration.tsp similarity index 100% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/AppConfiguration.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AppConfiguration/AppConfiguration.tsp diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AppConfiguration/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AppConfiguration/client.tsp new file mode 100644 index 000000000000..35fbae302bfd --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.AppConfiguration/client.tsp @@ -0,0 +1,35 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.AppConfigurationKeyValueModifiedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AppConfigurationKeyValueModifiedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AppConfigurationKeyValueDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AppConfigurationKeyValueDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AppConfigurationSnapshotEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AppConfigurationSnapshotEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AppConfigurationSnapshotCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AppConfigurationSnapshotCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AppConfigurationSnapshotModifiedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AppConfigurationSnapshotModifiedEventData, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/RedisCache.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Cache/RedisCache.tsp similarity index 97% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/RedisCache.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Cache/RedisCache.tsp index 23b11d1a29c0..d797c05a7602 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/RedisCache.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Cache/RedisCache.tsp @@ -2,7 +2,7 @@ namespace Microsoft.EventGrid.SystemEvents { alias RedisBaseEventData = { /** The time at which the event occurred. */ - timestamp?: utcDateTime; + timestamp: utcDateTime; /** The name of this event. */ name?: string; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Cache/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Cache/client.tsp new file mode 100644 index 000000000000..8d1d9ec30d62 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Cache/client.tsp @@ -0,0 +1,29 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.RedisPatchingCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.RedisPatchingCompletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.RedisScalingCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.RedisScalingCompletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.RedisExportRDBCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.RedisExportRDBCompletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.RedisImportRDBCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.RedisImportRDBCompletedEventData, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/AzureCommunicationServices.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp similarity index 76% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/AzureCommunicationServices.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp index a92fe86b11f7..69b9b1966ffb 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/AzureCommunicationServices.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp @@ -4,10 +4,10 @@ namespace Microsoft.EventGrid.SystemEvents; /** Schema of the Data property of an EventGridEvent for an Microsoft.Communication.IncomingCall event */ model AcsIncomingCallEventData { /** The communication identifier of the target user. */ - to?: CommunicationIdentifierModel; + to: CommunicationIdentifierModel; /** The communication identifier of the user who initiated the call. */ - from?: CommunicationIdentifierModel; + from: CommunicationIdentifierModel; /** The Id of the server call */ serverCallId?: string; @@ -16,7 +16,7 @@ model AcsIncomingCallEventData { callerDisplayName?: string; /** Custom Context of Incoming Call */ - customContext?: AcsIncomingCallCustomContext; + customContext: AcsIncomingCallCustomContext; /** Signed incoming call context. */ incomingCallContext?: string; @@ -28,7 +28,7 @@ model AcsIncomingCallEventData { /** Schema of the Data property of an EventGridEvent for an Microsoft.Communication.UserDisconnected event. */ model AcsUserDisconnectedEventData { /** The communication identifier of the user who was disconnected */ - userCommunicationIdentifier?: CommunicationIdentifierModel; + userCommunicationIdentifier: CommunicationIdentifierModel; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceived event. */ @@ -51,7 +51,7 @@ model AcsChatMessageEditedEventData extends AcsChatMessageEventBaseProperties { ...AcsChatMessageBaseEventData; /** The time at which the message was edited */ - editTime?: utcDateTime; + editTime: utcDateTime; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEditedInThread event. */ @@ -61,14 +61,14 @@ model AcsChatMessageEditedInThreadEventData ...AcsChatMessageBaseEventData; /** The time at which the message was edited */ - editTime?: utcDateTime; + editTime: utcDateTime; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeleted event. */ #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." model AcsChatMessageDeletedEventData extends AcsChatMessageEventBaseProperties { /** The time at which the message was deleted */ - deleteTime?: utcDateTime; + deleteTime: utcDateTime; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeletedInThread event. */ @@ -76,7 +76,7 @@ model AcsChatMessageDeletedEventData extends AcsChatMessageEventBaseProperties { model AcsChatMessageDeletedInThreadEventData extends AcsChatMessageEventInThreadBaseProperties { /** The time at which the message was deleted */ - deleteTime?: utcDateTime; + deleteTime: utcDateTime; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreatedWithUser event. */ @@ -112,17 +112,17 @@ model AcsChatThreadDeletedEventData model AcsChatThreadPropertiesUpdatedPerUserEventData extends AcsChatThreadEventBaseProperties { /** The communication identifier of the user who updated the thread properties */ - editedByCommunicationIdentifier?: CommunicationIdentifierModel; + editedByCommunicationIdentifier: CommunicationIdentifierModel; /** The time at which the properties of the thread were updated */ - editTime?: utcDateTime; + editTime: utcDateTime; /** The thread metadata */ - metadata?: Record; + metadata: Record; /** The updated thread properties */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "The type of properties is object with additionalProperties: object" - properties?: Record; + properties: Record; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdated event. */ @@ -144,13 +144,13 @@ model AcsChatParticipantAddedToThreadWithUserEventData model AcsChatParticipantRemovedFromThreadWithUserEventData extends AcsChatThreadEventBaseProperties { /** The time at which the user was removed to the thread */ - time?: utcDateTime; + time: utcDateTime; /** The communication identifier of the user who removed the user */ - removedByCommunicationIdentifier?: CommunicationIdentifierModel; + removedByCommunicationIdentifier: CommunicationIdentifierModel; /** The details of the user who was removed */ - participantRemoved?: AcsChatThreadParticipantProperties; + participantRemoved: AcsChatThreadParticipantProperties; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantAdded event. */ @@ -168,13 +168,13 @@ model AcsChatParticipantAddedToThreadEventData model AcsChatParticipantRemovedFromThreadEventData extends AcsChatEventInThreadBaseProperties { /** The time at which the user was removed to the thread */ - time?: utcDateTime; + time: utcDateTime; /** The communication identifier of the user who removed the user */ - removedByCommunicationIdentifier?: CommunicationIdentifierModel; + removedByCommunicationIdentifier: CommunicationIdentifierModel; /** The details of the user who was removed */ - participantRemoved?: AcsChatThreadParticipantProperties; + participantRemoved: AcsChatThreadParticipantProperties; /** The version of the thread */ version?: int64; @@ -190,10 +190,10 @@ model AcsSmsDeliveryReportReceivedEventData extends AcsSmsEventBaseProperties { deliveryStatusDetails?: string; /** List of details of delivery attempts made */ - deliveryAttempts?: AcsSmsDeliveryAttemptProperties[]; + deliveryAttempts: AcsSmsDeliveryAttemptProperties[]; /** The time at which the SMS delivery report was received */ - receivedTimestamp?: utcDateTime; + receivedTimestamp: utcDateTime; /** Customer Content */ tag?: string; @@ -206,29 +206,29 @@ model AcsSmsReceivedEventData extends AcsSmsEventBaseProperties { message?: string; /** The time at which the SMS was received */ - receivedTimestamp?: utcDateTime; + receivedTimestamp: utcDateTime; } //TODO: This might need some fixing /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RecordingFileStatusUpdated event. */ model AcsRecordingFileStatusUpdatedEventData { /** The details of recording storage information */ - recordingStorageInfo?: AcsRecordingStorageInfoProperties; + recordingStorageInfo: AcsRecordingStorageInfoProperties; /** The time at which the recording started */ - recordingStartTime?: utcDateTime; + recordingStartTime: utcDateTime; /** The recording duration in milliseconds */ recordingDurationMs?: int64; /** The recording content type- AudioVideo, or Audio */ - recordingContentType?: recordingContentType; + recordingContentType: recordingContentType; /** The recording channel type - Mixed, Unmixed */ - recordingChannelType?: recordingChannelType; + recordingChannelType: recordingChannelType; /** The recording format type - Mp4, Mp3, Wav */ - recordingFormatType?: recordingFormatType; + recordingFormatType: recordingFormatType; /** The reason for ending recording session */ sessionEndReason?: string; @@ -246,13 +246,13 @@ model AcsEmailDeliveryReportReceivedEventData { messageId?: string; /** The status of the email. Any value other than Delivered is considered failed. */ - status?: AcsEmailDeliveryReportStatus; + status: AcsEmailDeliveryReportStatus; /** Detailed information about the status if any */ - deliveryStatusDetails?: AcsEmailDeliveryReportStatusDetails; + deliveryStatusDetails: AcsEmailDeliveryReportStatusDetails; /** The time at which the email delivery report received timestamp */ - deliveryAttemptTimeStamp?: utcDateTime; + deliveryAttemptTimeStamp: utcDateTime; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailEngagementTrackingReportReceived event. */ @@ -267,7 +267,7 @@ model AcsEmailEngagementTrackingReportReceivedEventData { messageId?: string; /** The time at which the user interacted with the email */ - userActionTimeStamp?: utcDateTime; + userActionTimeStamp: utcDateTime; /** The context of the type of engagement user had with email */ engagementContext?: string; @@ -276,7 +276,7 @@ model AcsEmailEngagementTrackingReportReceivedEventData { userAgent?: string; /** The type of engagement user have with email */ - engagementType?: AcsUserEngagement; + engagementType: AcsUserEngagement; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCancelled event */ @@ -296,14 +296,14 @@ model AcsRouterJobClassificationFailedEventData extends AcsRouterJobEventData { classificationPolicyId?: string; /** Router Job Classification Failed Errors */ - errors?: AcsRouterCommunicationError[]; + errors: AcsRouterCommunicationError[]; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassified event */ #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." model AcsRouterJobClassifiedEventData extends AcsRouterJobEventData { /** Router Job Queue Info */ - queueDetails?: AcsRouterQueueDetails; + queueDetails: AcsRouterQueueDetails; /** Router Job Classification Policy Id */ classificationPolicyId?: string; @@ -312,7 +312,7 @@ model AcsRouterJobClassifiedEventData extends AcsRouterJobEventData { priority?: int32; /** Router Job Attached Worker Selector */ - attachedWorkerSelectors?: AcsRouterWorkerSelector[]; + attachedWorkerSelectors: AcsRouterWorkerSelector[]; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClosed event */ @@ -359,17 +359,17 @@ model AcsRouterJobQueuedEventData extends AcsRouterJobEventData { priority?: int32; /** Router Job Queued Attached Worker Selector */ - attachedWorkerSelectors?: AcsRouterWorkerSelector[]; + attachedWorkerSelectors: AcsRouterWorkerSelector[]; /** Router Job Queued Requested Worker Selector */ - requestedWorkerSelectors?: AcsRouterWorkerSelector[]; + requestedWorkerSelectors: AcsRouterWorkerSelector[]; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobReceived event */ #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." model AcsRouterJobReceivedEventData extends AcsRouterJobEventData { /** Router Job Received Job Status */ - jobStatus?: AcsRouterJobStatus; + jobStatus: AcsRouterJobStatus; /** Router Job Classification Policy Id */ classificationPolicyId?: string; @@ -378,10 +378,10 @@ model AcsRouterJobReceivedEventData extends AcsRouterJobEventData { priority?: int32; /** Router Job Received Requested Worker Selectors */ - requestedWorkerSelectors?: AcsRouterWorkerSelector[]; + requestedWorkerSelectors: AcsRouterWorkerSelector[]; /** Router Job Received Scheduled Time in UTC */ - scheduledOn?: utcDateTime; + scheduledOn: utcDateTime; /** Unavailable For Matching for Router Job Received */ unavailableForMatching: boolean; @@ -435,14 +435,14 @@ model AcsRouterJobSchedulingFailedEventData extends AcsRouterJobEventData { priority?: int32; /** Router Job Scheduling Failed Attached Worker Selector Expired */ - expiredAttachedWorkerSelectors?: AcsRouterWorkerSelector[]; + expiredAttachedWorkerSelectors: AcsRouterWorkerSelector[]; /** Router Job Scheduling Failed Requested Worker Selector Expired */ - expiredRequestedWorkerSelectors?: AcsRouterWorkerSelector[]; + expiredRequestedWorkerSelectors: AcsRouterWorkerSelector[]; /** Router Job Scheduling Failed Scheduled Time in UTC */ // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. - scheduledOn?: utcDateTime; + scheduledOn: utcDateTime; /** Router Job Scheduling Failed Reason */ failureReason?: string; @@ -465,14 +465,14 @@ model AcsRouterJobWaitingForActivationEventData extends AcsRouterJobEventData { priority?: int32; /** Router Job Waiting For Activation Worker Selector Expired */ - expiredAttachedWorkerSelectors?: AcsRouterWorkerSelector[]; + expiredAttachedWorkerSelectors: AcsRouterWorkerSelector[]; /** Router Job Waiting For Activation Requested Worker Selector Expired */ - expiredRequestedWorkerSelectors?: AcsRouterWorkerSelector[]; + expiredRequestedWorkerSelectors: AcsRouterWorkerSelector[]; /** Router Job Waiting For Activation Scheduled Time in UTC */ // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. - scheduledOn?: utcDateTime; + scheduledOn: utcDateTime; /** Router Job Waiting For Activation Unavailable For Matching */ unavailableForMatching: boolean; @@ -483,10 +483,10 @@ model AcsRouterJobWaitingForActivationEventData extends AcsRouterJobEventData { model AcsRouterJobWorkerSelectorsExpiredEventData extends AcsRouterJobEventData { /** Router Job Worker Selectors Expired Requested Worker Selectors */ - expiredRequestedWorkerSelectors?: AcsRouterWorkerSelector[]; + expiredRequestedWorkerSelectors: AcsRouterWorkerSelector[]; /** Router Job Worker Selectors Expired Attached Worker Selectors */ - expiredAttachedWorkerSelectors?: AcsRouterWorkerSelector[]; + expiredAttachedWorkerSelectors: AcsRouterWorkerSelector[]; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeleted event */ @@ -515,16 +515,16 @@ model AcsRouterWorkerOfferAcceptedEventData extends AcsRouterWorkerEventData { jobPriority?: int32; /** Router Worker Offer Accepted Worker Labels */ - workerLabels?: Record; + workerLabels: Record; /** Router Worker Offer Accepted Worker Tags */ - workerTags?: Record; + workerTags: Record; /** Router Worker Offer Accepted Job Labels */ - jobLabels?: Record; + jobLabels: Record; /** Router Worker Offer Accepted Job Tags */ - jobTags?: Record; + jobTags: Record; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferDeclined event */ @@ -560,24 +560,24 @@ model AcsRouterWorkerOfferIssuedEventData extends AcsRouterWorkerEventData { jobPriority?: int32; /** Router Worker Offer Issued Worker Labels */ - workerLabels?: Record; + workerLabels: Record; /** Router Worker Offer Issued Time in UTC */ // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. - offeredOn?: utcDateTime; + offeredOn: utcDateTime; /** Router Worker Offer Issued Expiration Time in UTC */ // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. - expiresOn?: utcDateTime; + expiresOn: utcDateTime; /** Router Worker Offer Issued Worker Tags */ - workerTags?: Record; + workerTags: Record; /** Router Worker Offer Issued Job Labels */ - jobLabels?: Record; + jobLabels: Record; /** Router Worker Offer Issued Job Tags */ - jobTags?: Record; + jobTags: Record; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferRevoked event */ @@ -596,19 +596,19 @@ model AcsRouterWorkerRegisteredEventData { workerId?: string; /** Router Worker Registered Queue Info */ - queueAssignments?: AcsRouterQueueDetails[]; + queueAssignments: AcsRouterQueueDetails[]; /** Router Worker Registered Channel Configuration */ - channelConfigurations?: AcsRouterChannelConfiguration[]; + channelConfigurations: AcsRouterChannelConfiguration[]; /** Router Worker Register Total Capacity */ totalCapacity?: int32; /** Router Worker Registered Labels */ - labels?: Record; + labels: Record; /** Router Worker Registered Tags */ - tags?: Record; + tags: Record; } // Base Properties @@ -619,10 +619,10 @@ model AcsRouterJobEventData extends AcsRouterEventData { queueId?: string; /** Router Job events Labels */ - labels?: Record; + labels: Record; /** Router Jobs events Tags */ - tags?: Record; + tags: Record; } /** Schema of common properties of all Router Worker events */ @@ -665,7 +665,7 @@ model AcsRouterQueueDetails { name?: string; /** Router Queue Labels */ - labels?: Record; + labels: Record; } /** Router Communication Error */ @@ -680,10 +680,10 @@ model AcsRouterCommunicationError { target?: string; /** Router Communication Inner Error */ - innererror?: AcsRouterCommunicationError; + innererror: AcsRouterCommunicationError; /** List of Router Communication Errors */ - details?: AcsRouterCommunicationError[]; + details: AcsRouterCommunicationError[]; } /** Router Job Worker Selector */ @@ -692,21 +692,20 @@ model AcsRouterWorkerSelector { key?: string; /** Router Job Worker Selector Label Operator */ - operator?: AcsRouterLabelOperator; + labelOperator: AcsRouterLabelOperator; /** Router Job Worker Selector Value */ #suppress "@azure-tools/typespec-azure-core/no-unknown" "The type of labelValue is object" - labelValue?: unknown; + value: unknown; /** Router Job Worker Selector Time to Live in Seconds */ - @encode("ISO8601") // TODO verify this is timespan in C# - ttlSeconds?: duration; + ttlSeconds: float64; /** Router Job Worker Selector State */ - selectorState?: AcsRouterWorkerSelectorState; + state: AcsRouterWorkerSelectorState; /** Router Job Worker Selector Expiration Time */ - expirationTime?: utcDateTime; + expirationTime: utcDateTime; } alias AcsChatMessageBaseEventData = { @@ -714,56 +713,56 @@ alias AcsChatMessageBaseEventData = { messageBody?: string; /** The chat message metadata */ - metadata?: Record; + metadata: Record; }; alias AcsChatThreadBaseEventData = { /** The communication identifier of the user who created the thread */ - createdByCommunicationIdentifier?: CommunicationIdentifierModel; + createdByCommunicationIdentifier: CommunicationIdentifierModel; /** The thread properties */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "The type of properties is object with additionalProperties: object" - properties?: Record; + properties: Record; /** The thread metadata */ - metadata?: Record; + metadata: Record; /** The list of properties of participants who are part of the thread */ - participants?: AcsChatThreadParticipantProperties[]; + participants: AcsChatThreadParticipantProperties[]; }; alias AcsChatThreadDeletedBaseEventData = { /** The communication identifier of the user who deleted the thread */ - deletedByCommunicationIdentifier?: CommunicationIdentifierModel; + deletedByCommunicationIdentifier: CommunicationIdentifierModel; /** The deletion time of the thread */ - deleteTime?: utcDateTime; + deleteTime: utcDateTime; }; alias AcsChatThreadPropertiesBaseEventData = { /** The communication identifier of the user who updated the thread properties */ - editedByCommunicationIdentifier?: CommunicationIdentifierModel; + editedByCommunicationIdentifier: CommunicationIdentifierModel; /** The time at which the properties of the thread were updated */ - editTime?: utcDateTime; + editTime: utcDateTime; /** The updated thread properties */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "The type of properties is object with additionalProperties: object" - properties?: Record; + properties: Record; /** The thread metadata */ - metadata?: Record; + metadata: Record; }; alias AcsChatParticipantBaseEventData = { /** The time at which the user was added to the thread */ - time?: utcDateTime; + time: utcDateTime; /** The communication identifier of the user who added the user */ - addedByCommunicationIdentifier?: CommunicationIdentifierModel; + addedByCommunicationIdentifier: CommunicationIdentifierModel; /** The details of the user who was added */ - participantAdded?: AcsChatThreadParticipantProperties; + participantAdded: AcsChatThreadParticipantProperties; }; /** Recording content type */ @@ -869,7 +868,7 @@ model AcsEmailDeliveryReportStatusDetails { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." model AcsChatThreadEventBaseProperties extends AcsChatEventBaseProperties { /** The original creation time of the thread */ - createTime?: utcDateTime; + createTime: utcDateTime; /** The version of the thread */ version?: int64; @@ -880,7 +879,7 @@ model AcsChatThreadEventBaseProperties extends AcsChatEventBaseProperties { model AcsChatThreadEventInThreadBaseProperties extends AcsChatEventInThreadBaseProperties { /** The original creation time of the thread */ - createTime?: utcDateTime; + createTime: utcDateTime; /** The version of the thread */ version?: int64; @@ -893,13 +892,13 @@ model AcsChatMessageEventBaseProperties extends AcsChatEventBaseProperties { messageId?: string; /** The communication identifier of the sender */ - senderCommunicationIdentifier?: CommunicationIdentifierModel; + senderCommunicationIdentifier: CommunicationIdentifierModel; /** The display name of the sender */ senderDisplayName?: string; /** The original compose time of the message */ - composeTime?: utcDateTime; + composeTime: utcDateTime; /** The type of the message */ type?: string; @@ -916,13 +915,13 @@ model AcsChatMessageEventInThreadBaseProperties messageId?: string; /** The communication identifier of the sender */ - senderCommunicationIdentifier?: CommunicationIdentifierModel; + senderCommunicationIdentifier: CommunicationIdentifierModel; /** The display name of the sender */ senderDisplayName?: string; /** The original compose time of the message */ - composeTime?: utcDateTime; + composeTime: utcDateTime; /** The type of the message */ type?: string; @@ -943,7 +942,7 @@ model AcsChatEventInThreadBaseProperties { /** Schema of common properties of all chat events */ model AcsChatEventBaseProperties { /** The communication identifier of the target user */ - recipientCommunicationIdentifier?: CommunicationIdentifierModel; + recipientCommunicationIdentifier: CommunicationIdentifierModel; ...AcsChatEventInThreadBaseProperties; } @@ -954,10 +953,10 @@ model AcsChatThreadParticipantProperties { displayName?: string; /** The communication identifier of the user */ - participantCommunicationIdentifier?: CommunicationIdentifierModel; + participantCommunicationIdentifier: CommunicationIdentifierModel; /** The metadata of the user */ - metadata?: Record; + metadata: Record; } /** Schema of common properties of all SMS events */ @@ -975,7 +974,7 @@ model AcsSmsEventBaseProperties { /** Schema for details of a delivery attempt */ model AcsSmsDeliveryAttemptProperties { /** TimeStamp when delivery was attempted */ - timestamp?: utcDateTime; + timestamp: utcDateTime; /** Number of segments that were successfully delivered */ segmentsSucceeded?: int32; @@ -987,7 +986,7 @@ model AcsSmsDeliveryAttemptProperties { /** Schema for all properties of Recording Storage Information. */ model AcsRecordingStorageInfoProperties { /** List of details of recording chunks information */ - recordingChunks?: AcsRecordingChunkInfoProperties[]; + recordingChunks: AcsRecordingChunkInfoProperties[]; } /** Schema for all properties of Recording Chunk Information. */ @@ -1014,10 +1013,10 @@ model AcsRecordingChunkInfoProperties { /** Custom Context of Incoming Call */ model AcsIncomingCallCustomContext { /** Sip Headers for incoming call */ - sipHeaders?: Record; + sipHeaders: Record; /** Voip Headers for incoming call */ - voipHeaders?: Record; + voipHeaders: Record; } /** The type of engagement user have with email. */ @@ -1033,17 +1032,49 @@ union AcsUserEngagement { /** Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model must be interpreted as a union: Apart from rawId, at most one further property may be set. */ model CommunicationIdentifierModel { + /** The identifier kind. Only required in responses. */ + kind: CommunicationIdentifierModelKind; + /** Raw Id of the identifier. Optional in requests, required in responses. */ rawId?: string; /** The communication user. */ - communicationUser?: CommunicationUserIdentifierModel; + communicationUser: CommunicationUserIdentifierModel; /** The phone number. */ - phoneNumber?: PhoneNumberIdentifierModel; + phoneNumber: PhoneNumberIdentifierModel; /** The Microsoft Teams user. */ - microsoftTeamsUser?: MicrosoftTeamsUserIdentifierModel; + microsoftTeamsUser: MicrosoftTeamsUserIdentifierModel; + + /** The Microsoft Teams application. */ + microsoftTeamsApp: MicrosoftTeamsAppIdentifierModel; +} + +/** Communication model identifier kind */ +union CommunicationIdentifierModelKind { + /** Unknown */ + "unknown", + + /** Communication User */ + "communicationUser", + + /** Phone Number */ + "phoneNumber", + + /** Microsoft Teams User */ + "microsoftTeamsUser", + + string, +} + +/** A Microsoft Teams application. */ +model MicrosoftTeamsAppIdentifierModel { + /** The Id of the Microsoft Teams application */ + appId: string; + + /** The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. */ + cloud: CommunicationCloudEnvironmentModel; } /** A Microsoft Teams user. */ @@ -1055,7 +1086,7 @@ model MicrosoftTeamsUserIdentifierModel { isAnonymous?: boolean; /** The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. */ - cloud?: CommunicationCloudEnvironmentModel; + cloud: CommunicationCloudEnvironmentModel; } /** A phone number. */ @@ -1070,6 +1101,223 @@ model CommunicationUserIdentifierModel { id: string; } +/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerUpdated event. */ +model AcsRouterWorkerUpdatedEventData { + /** Router Worker Updated Worker Id */ + workerId?: string; + + /** Router Worker Updated Queue Info */ + queueAssignments: AcsRouterQueueDetails[]; + + /** Router Worker Updated Channel Configuration */ + channelConfigurations: AcsRouterChannelConfiguration[]; + + /** Router Worker Updated Total Capacity */ + totalCapacity?: int32; + + /** Router Worker Updated Labels */ + labels: Record; + + /** Router Worker Updated Tags */ + tags: Record; + + /** Router Worker Properties Updated */ + updatedWorkerProperties: AcsRouterUpdatedWorkerProperty[]; +} + +/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated event. */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." +model AcsMessageDeliveryStatusUpdatedEventData extends AcsMessageEventData { + /** The message id */ + messageId?: string; + + /** The updated message status */ + status: AcsMessageDeliveryStatus; + + /** The updated message channel type */ + channelType: AcsMessageChannelKind; +} + +/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageReceived event. */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." +model AcsMessageReceivedEventData extends AcsMessageEventData { + /** The message content */ + content?: string; + + /** The message channel type */ + channelType: AcsMessageChannelKind; + + /** The received message media content */ + media: AcsMessageMediaContent; + + /** The received message context */ + context: AcsMessageContext; + + /** The received message button content */ + button: AcsMessageButtonContent; + + /** The received message interactive content */ + interactive: AcsMessageInteractiveContent; +} + +/** Message Media Content */ +model AcsMessageMediaContent { + /** The MIME type of the file this media represents */ + mimeType?: string; + + /** The media identifier */ + id?: string; + + /** The filename of the underlying media file as specified when uploaded */ + fileName?: string; + + /** The caption for the media object, if supported and provided */ + caption?: string; +} + +/** Message Context */ +model AcsMessageContext { + /** The WhatsApp ID for the customer who replied to an inbound message. */ + from?: string; + + /** The message ID for the sent message for an inbound reply */ + id?: string; +} + +/** Message Button Content */ +model AcsMessageButtonContent { + /** The Text of the button */ + text?: string; + + /** The Payload of the button which was clicked by the user, setup by the business */ + payload?: string; +} + +/** Message Interactive Content */ +model AcsMessageInteractiveContent { + /** The Message interactive reply type */ + type: AcsInteractiveReplyKind; + + /** The Message Sent when a customer clicks a button */ + buttonReply: AcsMessageInteractiveButtonReplyContent; + + /** The Message Sent when a customer selects an item from a list */ + listReply: AcsMessageInteractiveListReplyContent; +} + +/** Message Interactive button reply content for a user to business message */ +model AcsMessageInteractiveButtonReplyContent { + /** The ID of the button */ + id?: string; + + /** The title of the button */ + title?: string; +} + +/** Message Interactive list reply content for a user to business message */ +model AcsMessageInteractiveListReplyContent { + /** The ID of the selected list item */ + id?: string; + + /** The title of the selected list item */ + title?: string; + + /** The description of the selected row */ + description?: string; +} + +/** Schema of common properties of all chat thread events */ +model AcsMessageEventData { + /** The message sender */ + from?: string; + + /** The message recipient */ + to?: string; + + /** The time message was received */ + receivedTimeStamp: utcDateTime; + + /** The channel event error */ + error: AcsMessageChannelEventError; +} + +/** Message Channel Event Error */ +model AcsMessageChannelEventError { + /** The channel error code */ + channelCode?: string; + + /** The channel error message */ + channelMessage?: string; +} + +/** Interactive reply kind */ +union AcsInteractiveReplyKind { + /** Messaged interactive reply type is ButtonReply */ + "buttonReply", + + /** Messaged interactive reply type is ListReply */ + "listReply", + + /** Messaged interactive reply type is Unknown */ + "unknown", + + string, +} + +/** Message channel kind */ +union AcsMessageChannelKind { + /** Updated message channel type is WhatsApp */ + "whatsapp", + + string, +} + +/** Message delivery status */ +union AcsMessageDeliveryStatus { + /** Read */ + "read", + + /** Delivered */ + "delivered", + + /** Failed */ + "failed", + + /** Sent */ + "sent", + + /** Warning */ + "warning", + + /** Unknown */ + "unknown", + + string, +} + +/** Worker properties that can be updated */ +union AcsRouterUpdatedWorkerProperty { + /** AvailableForOffers */ + "AvailableForOffers", + + /** TotalCapacity */ + "TotalCapacity", + + /** QueueAssignments */ + "QueueAssignments", + + /** Labels */ + "Labels", + + /** Tags */ + "Tags", + + /** ChannelConfigurations */ + "ChannelConfigurations", + + string, +} + /** Communication cloud environment model. */ union CommunicationCloudEnvironmentModel { /** Public */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/client.tsp new file mode 100644 index 000000000000..71570ba1be06 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/client.tsp @@ -0,0 +1,513 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.AcsIncomingCallEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsIncomingCallEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsUserDisconnectedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsUserDisconnectedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageReceivedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageReceivedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageReceivedInThreadEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageReceivedInThreadEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageEditedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageEditedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageEditedInThreadEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageEditedInThreadEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageDeletedInThreadEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageDeletedInThreadEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadCreatedWithUserEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadCreatedWithUserEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadWithUserDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadWithUserDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadPropertiesUpdatedPerUserEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadPropertiesUpdatedPerUserEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadPropertiesUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadPropertiesUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatParticipantAddedToThreadWithUserEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatParticipantAddedToThreadWithUserEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatParticipantRemovedFromThreadWithUserEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatParticipantRemovedFromThreadWithUserEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatParticipantAddedToThreadEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatParticipantAddedToThreadEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatParticipantRemovedFromThreadEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatParticipantRemovedFromThreadEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsSmsDeliveryReportReceivedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsSmsDeliveryReportReceivedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsSmsReceivedEventData, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsSmsReceivedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRecordingFileStatusUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRecordingFileStatusUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportReceivedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportReceivedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsEmailEngagementTrackingReportReceivedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsEmailEngagementTrackingReportReceivedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobCancelledEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobCancelledEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobClassificationFailedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobClassificationFailedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobClassifiedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobClassifiedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobClosedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobClosedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobCompletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobExceptionTriggeredEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobExceptionTriggeredEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobQueuedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobQueuedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobReceivedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobReceivedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobSchedulingFailedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobSchedulingFailedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobUnassignedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobUnassignedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobWaitingForActivationEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobWaitingForActivationEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobWorkerSelectorsExpiredEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobWorkerSelectorsExpiredEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerDeregisteredEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerDeregisteredEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferAcceptedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferAcceptedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferDeclinedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferDeclinedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferExpiredEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferExpiredEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferIssuedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferIssuedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferRevokedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferRevokedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerRegisteredEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerRegisteredEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobEventData, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobEventData, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterEventData, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterEventData, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterChannelConfiguration, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterChannelConfiguration, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterQueueDetails, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterQueueDetails, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterCommunicationError, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterCommunicationError, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerSelector, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerSelector, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportStatusDetails, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportStatusDetails, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadEventBaseProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadEventBaseProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadEventInThreadBaseProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadEventInThreadBaseProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageEventBaseProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageEventBaseProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageEventInThreadBaseProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageEventInThreadBaseProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatEventInThreadBaseProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatEventInThreadBaseProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatEventBaseProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatEventBaseProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadParticipantProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadParticipantProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsSmsEventBaseProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsSmsEventBaseProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsSmsDeliveryAttemptProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsSmsDeliveryAttemptProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRecordingStorageInfoProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRecordingStorageInfoProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRecordingChunkInfoProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRecordingChunkInfoProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsIncomingCallCustomContext, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsIncomingCallCustomContext, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.CommunicationIdentifierModel, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.CommunicationIdentifierModel, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MicrosoftTeamsAppIdentifierModel, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MicrosoftTeamsAppIdentifierModel, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MicrosoftTeamsUserIdentifierModel, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MicrosoftTeamsUserIdentifierModel, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.PhoneNumberIdentifierModel, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.PhoneNumberIdentifierModel, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.CommunicationUserIdentifierModel, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.CommunicationUserIdentifierModel, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageDeliveryStatusUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageDeliveryStatusUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageReceivedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageReceivedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageMediaContent, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageMediaContent, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageContext, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageContext, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageButtonContent, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageButtonContent, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageInteractiveContent, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageInteractiveContent, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageInteractiveButtonReplyContent, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageInteractiveButtonReplyContent, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageInteractiveListReplyContent, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageInteractiveListReplyContent, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageEventData, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageEventData, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageChannelEventError, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageChannelEventError, + Access.public +); +//Enums +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobStatus, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobStatus, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.recordingContentType, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.recordingContentType, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.recordingChannelType, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.recordingChannelType, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.recordingFormatType, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.recordingFormatType, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterLabelOperator, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterLabelOperator, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerSelectorState, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerSelectorState, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportStatus, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportStatus, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsUserEngagement, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsUserEngagement, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.CommunicationIdentifierModelKind, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.CommunicationIdentifierModelKind, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsInteractiveReplyKind, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsInteractiveReplyKind, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageChannelKind, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageChannelKind, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.AcsMessageDeliveryStatus, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsMessageDeliveryStatus, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterUpdatedWorkerProperty, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AcsRouterUpdatedWorkerProperty, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.CommunicationCloudEnvironmentModel, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.CommunicationCloudEnvironmentModel, + Access.public +); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/ContainerRegistry.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerRegistry/ContainerRegistry.tsp similarity index 93% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/ContainerRegistry.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerRegistry/ContainerRegistry.tsp index 3fb624ae24fa..726089a7278c 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/ContainerRegistry.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerRegistry/ContainerRegistry.tsp @@ -26,7 +26,7 @@ alias ContainerRegistryBaseEventData = { id?: string; /** The time at which the event occurred. */ - timestamp?: utcDateTime; + timestamp: utcDateTime; /** The action that encompasses the provided event. */ action?: string; @@ -40,19 +40,19 @@ model ContainerRegistryEventData { ...ContainerRegistryBaseEventData; /** The target of the event. */ - target?: ContainerRegistryEventTarget; + target: ContainerRegistryEventTarget; /** The request that generated the event. */ - request?: ContainerRegistryEventRequest; + request: ContainerRegistryEventRequest; /** The agent that initiated the event. For most situations, this could be from the authorization context of the request. */ - actor?: ContainerRegistryEventActor; + actor: ContainerRegistryEventActor; /** The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. */ - source?: ContainerRegistryEventSource; + source: ContainerRegistryEventSource; /** The connected registry information if the event is generated by a connected registry. */ - connectedRegistry?: ContainerRegistryEventConnectedRegistry; + connectedRegistry: ContainerRegistryEventConnectedRegistry; } /** The content of the event request message. */ @@ -60,10 +60,10 @@ model ContainerRegistryArtifactEventData { ...ContainerRegistryBaseEventData; /** The target of the event. */ - target?: ContainerRegistryArtifactEventTarget; + target: ContainerRegistryArtifactEventTarget; /** The connected registry information if the event is generated by a connected registry. */ - connectedRegistry?: ContainerRegistryEventConnectedRegistry; + connectedRegistry: ContainerRegistryEventConnectedRegistry; } /** The target of the event. */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerRegistry/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerRegistry/client.tsp new file mode 100644 index 000000000000..a91ee6c7a4b0 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerRegistry/client.tsp @@ -0,0 +1,77 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryImagePushedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryImagePushedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryImageDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryImageDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryChartPushedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryChartPushedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryChartDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryChartDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryArtifactEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryArtifactEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventTarget, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventTarget, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryArtifactEventTarget, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryArtifactEventTarget, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventRequest, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventRequest, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventActor, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventActor, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventSource, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventSource, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventConnectedRegistry, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventConnectedRegistry, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/ContainerService.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerService/ContainerService.tsp similarity index 100% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/ContainerService.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerService/ContainerService.tsp diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerService/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerService/client.tsp new file mode 100644 index 000000000000..99b6ac242fee --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerService/client.tsp @@ -0,0 +1,53 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceNewKubernetesVersionAvailableEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceNewKubernetesVersionAvailableEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceClusterSupportEndedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceClusterSupportEndedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceClusterSupportEndingEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceClusterSupportEndingEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingStartedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingStartedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingSucceededEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingSucceededEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingFailedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingFailedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceClusterSupportEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceClusterSupportEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingEventData, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/DataBox.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.DataBox/DataBox.tsp similarity index 94% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/DataBox.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.DataBox/DataBox.tsp index d771641987e8..05d7129a7c9c 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/DataBox.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.DataBox/DataBox.tsp @@ -20,10 +20,10 @@ namespace Microsoft.EventGrid.SystemEvents { serialNumber?: string; /** Name of the current Stage */ - stageName?: DataBoxStageName; + stageName: DataBoxStageName; /** The time at which the stage happened. */ - stageTime?: utcDateTime; + stageTime: utcDateTime; }; /** Schema of DataBox Stage Name enumeration. */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.DataBox/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.DataBox/client.tsp new file mode 100644 index 000000000000..e3f3d6fc0f79 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.DataBox/client.tsp @@ -0,0 +1,25 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.DataBoxCopyStartedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.DataBoxCopyStartedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.DataBoxCopyCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.DataBoxCopyCompletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.DataBoxOrderCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.DataBoxOrderCompletedEventData, + Access.public +); +//Enums +@@usage(Microsoft.EventGrid.SystemEvents.DataBoxStageName, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.DataBoxStageName, Access.public); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/IotHub.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Devices/IotHub.tsp similarity index 94% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/IotHub.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Devices/IotHub.tsp index f642c5be9748..30ad8bc8461b 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/IotHub.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Devices/IotHub.tsp @@ -11,7 +11,7 @@ model DeviceLifeCycleEventProperties { hubName?: string; /** Information about the device twin, which is the cloud representation of application device metadata. */ - twin?: DeviceTwinInfo; + twin: DeviceTwinInfo; } /** Metadata information for the properties JSON document. */ @@ -23,7 +23,7 @@ model DeviceTwinMetadata { /** A portion of the properties that can be written only by the application back-end, and read by the device. */ model DeviceTwinProperties { /** Metadata information for the properties JSON document. */ - metadata?: DeviceTwinMetadata; + metadata: DeviceTwinMetadata; /** Version of device twin properties. */ version?: float32; @@ -53,7 +53,7 @@ model DeviceTwinInfo { //TODO: something here needs to change /** Properties JSON element. */ - properties?: DeviceTwinInfoProperties; + properties: DeviceTwinInfoProperties; /** Whether the device twin is enabled or disabled. */ status?: string; @@ -67,7 +67,7 @@ model DeviceTwinInfo { //TODO: also here /** The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate. */ - x509Thumbprint?: DeviceTwinInfoX509Thumbprint; + x509Thumbprint: DeviceTwinInfoX509Thumbprint; } /** Schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected). */ @@ -82,20 +82,20 @@ model DeviceConnectionStateEventProperties { hubName?: string; /** Information about the device connection state event. */ - deviceConnectionStateEventInfo?: DeviceConnectionStateEventInfo; + deviceConnectionStateEventInfo: DeviceConnectionStateEventInfo; } /** Schema of the Data property of an EventGridEvent for a device telemetry event (DeviceTelemetry). */ model DeviceTelemetryEventProperties { /** The content of the message from the device. */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "The type of body is object" - body?: Record; + body: Record; /** Application properties are user-defined strings that can be added to the message. These fields are optional. */ - properties?: Record; + properties: Record; /** System properties help identify contents and source of the messages. */ - systemProperties?: Record; + systemProperties: Record; } /** Information about the device connection state event. */ @@ -138,8 +138,8 @@ model DeviceTwinInfoX509Thumbprint { /** Properties JSON element. */ model DeviceTwinInfoProperties { /** A portion of the properties that can be written only by the application back-end, and read by the device. */ - desired?: DeviceTwinProperties; + desired: DeviceTwinProperties; /** A portion of the properties that can be written only by the device, and read by the application back-end. */ - reported?: DeviceTwinProperties; + reported: DeviceTwinProperties; } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Devices/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Devices/client.tsp new file mode 100644 index 000000000000..85c11a51a1e5 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Devices/client.tsp @@ -0,0 +1,77 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.DeviceLifeCycleEventProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.DeviceLifeCycleEventProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.DeviceTwinMetadata, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.DeviceTwinMetadata, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.DeviceTwinProperties, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.DeviceTwinProperties, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.DeviceTwinInfo, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.DeviceTwinInfo, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.DeviceConnectionStateEventProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.DeviceConnectionStateEventProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.DeviceTelemetryEventProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.DeviceTelemetryEventProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.DeviceConnectionStateEventInfo, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.DeviceConnectionStateEventInfo, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.IotHubDeviceCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.IotHubDeviceCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.IotHubDeviceDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.IotHubDeviceDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.IotHubDeviceConnectedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.IotHubDeviceConnectedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.IotHubDeviceDisconnectedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.IotHubDeviceDisconnectedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.IotHubDeviceTelemetryEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.IotHubDeviceTelemetryEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.DeviceTwinInfoX509Thumbprint, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.DeviceTwinInfoX509Thumbprint, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.DeviceTwinInfoProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.DeviceTwinInfoProperties, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/EventGrid.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventGrid/EventGrid.tsp similarity index 90% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/EventGrid.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventGrid/EventGrid.tsp index 01ef7c0d7359..f3c1877aa959 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/EventGrid.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventGrid/EventGrid.tsp @@ -50,18 +50,16 @@ union EventGridMQTTClientDisconnectionReason { string, } -/** Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SystemEvents.SubscriptionValidationEvent event. */ +/** Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent event. */ model SubscriptionValidationEventData { /** The validation code sent by Azure Event Grid to validate an event subscription. * To complete the validation handshake, the subscriber must either respond with this validation code as part of the validation response, * or perform a GET request on the validationUrl (available starting version 2018-05-01-preview). */ - @visibility("read") validationCode?: string; /** The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview). * To complete the validation handshake, the subscriber must either respond with the validationCode as part of the validation response, * or perform a GET request on the validationUrl (available starting version 2018-05-01-preview). */ - @visibility("read") validationUrl?: string; } @@ -78,35 +76,34 @@ model SubscriptionValidationResponse { /** Schema of the Data property of an EventGridEvent for a -Microsoft.EventGrid.SystemEvents.SubscriptionDeletedEvent event. +Microsoft.EventGrid.SubscriptionDeletedEvent event. */ model SubscriptionDeletedEventData { /** The Azure resource ID of the deleted event subscription. */ - @visibility("read") eventSubscriptionId?: string; } -/** Event data for Microsoft.EventGrid.SystemEvents.MQTTClientCreatedOrUpdated event. */ +/** Event data for Microsoft.EventGrid.MQTTClientCreatedOrUpdated event. */ #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Following Swagger Inheritance" #suppress "@azure-tools/typespec-azure-core/casing-style" "MQTT is an acronym and should be all caps" model EventGridMQTTClientCreatedOrUpdatedEventData extends EventGridMQTTClientEventData { /** Configured state of the client. The value could be Enabled or Disabled */ - state?: EventGridMQTTClientState; + state: EventGridMQTTClientState; /** Time the client resource is created based on the provider's UTC time. */ // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. - createdOn?: utcDateTime; + createdOn: utcDateTime; /** Time the client resource is last updated based on the provider's UTC time. If the client resource was never updated, this value is identical to the value of the 'createdOn' property. */ - updatedOn?: utcDateTime; + updatedOn: utcDateTime; /** The key-value attributes that are assigned to the client resource. */ - attributes?: Record; + attributes: Record; } /** Schema of the Data property of an EventGridEvent for MQTT Client state changes. */ @@ -126,13 +123,13 @@ long, and supports UTF-8 characters. namespaceName?: string; } -/** Event data for Microsoft.EventGrid.SystemEvents.MQTTClientDeleted event. */ +/** Event data for Microsoft.EventGrid.MQTTClientDeleted event. */ #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Following Swagger Inheritance" #suppress "@azure-tools/typespec-azure-core/casing-style" "MQTT is an acronym and should be all caps" model EventGridMQTTClientDeletedEventData extends EventGridMQTTClientEventData {} -/** Event data for Microsoft.EventGrid.SystemEvents.MQTTClientSessionConnected event. */ +/** Event data for Microsoft.EventGrid.MQTTClientSessionConnected event. */ #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Following Swagger Inheritance" #suppress "@azure-tools/typespec-azure-core/casing-style" "MQTT is an acronym and should be all caps" model EventGridMQTTClientSessionConnectedEventData @@ -151,7 +148,7 @@ than the previous event. sequenceNumber?: int64; } -/** Event data for Microsoft.EventGrid.SystemEvents.MQTTClientSessionDisconnected event. */ +/** Event data for Microsoft.EventGrid.MQTTClientSessionDisconnected event. */ #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Following Swagger Inheritance" #suppress "@azure-tools/typespec-azure-core/casing-style" "MQTT is an acronym and should be all caps" model EventGridMQTTClientSessionDisconnectedEventData @@ -173,5 +170,5 @@ than the previous event. Reason for the disconnection of the MQTT client's session. The value could be one of the values in the disconnection reasons table. */ - disconnectionReason?: EventGridMQTTClientDisconnectionReason; + disconnectionReason: EventGridMQTTClientDisconnectionReason; } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventGrid/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventGrid/client.tsp new file mode 100644 index 000000000000..3590dd1e174b --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventGrid/client.tsp @@ -0,0 +1,65 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.SubscriptionValidationEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.SubscriptionValidationEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.SubscriptionValidationResponse, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.SubscriptionValidationResponse, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.SubscriptionDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.SubscriptionDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientCreatedOrUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientCreatedOrUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientSessionConnectedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientSessionConnectedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientSessionDisconnectedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientSessionDisconnectedEventData, + Access.public +); +//Enums +@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientState, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientState, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientDisconnectionReason, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientDisconnectionReason, + Access.public +); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/EventHub.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventHub/EventHub.tsp similarity index 92% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/EventHub.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventHub/EventHub.tsp index 8023d448c157..1f903d9d64ad 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/EventHub.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventHub/EventHub.tsp @@ -25,8 +25,8 @@ model EventHubCaptureFileCreatedEventData { lastSequenceNumber?: int32; /** The first time from the queue. */ - firstEnqueueTime?: utcDateTime; + firstEnqueueTime: utcDateTime; /** The last time from the queue. */ - lastEnqueueTime?: utcDateTime; + lastEnqueueTime: utcDateTime; } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventHub/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventHub/client.tsp new file mode 100644 index 000000000000..29d4e5afec6a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventHub/client.tsp @@ -0,0 +1,11 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.EventHubCaptureFileCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.EventHubCaptureFileCreatedEventData, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/HealthcareApis.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.HealthcareApis/HealthcareApis.tsp similarity index 99% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/HealthcareApis.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.HealthcareApis/HealthcareApis.tsp index 9343b4fefb2f..9256d60c1ed6 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/HealthcareApis.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.HealthcareApis/HealthcareApis.tsp @@ -4,7 +4,7 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceCreated event. */ model HealthcareFhirResourceCreatedEventData { /** Type of HL7 FHIR resource. */ - resourceType?: HealthcareFhirResourceType; + resourceType: HealthcareFhirResourceType; /** Domain name of FHIR account for this resource. */ resourceFhirAccount?: string; @@ -19,7 +19,7 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceUpdated event. */ model HealthcareFhirResourceUpdatedEventData { /** Type of HL7 FHIR resource. */ - resourceType?: HealthcareFhirResourceType; + resourceType: HealthcareFhirResourceType; /** Domain name of FHIR account for this resource. */ resourceFhirAccount?: string; @@ -34,7 +34,7 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceDeleted event. */ model HealthcareFhirResourceDeletedEventData { /** Type of HL7 FHIR resource. */ - resourceType?: HealthcareFhirResourceType; + resourceType: HealthcareFhirResourceType; /** Domain name of FHIR account for this resource. */ resourceFhirAccount?: string; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.HealthcareApis/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.HealthcareApis/client.tsp new file mode 100644 index 000000000000..8fbe10a3c572 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.HealthcareApis/client.tsp @@ -0,0 +1,53 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceType, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceType, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.HealthcareDicomImageCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.HealthcareDicomImageCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.HealthcareDicomImageDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.HealthcareDicomImageDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.HealthcareDicomImageUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.HealthcareDicomImageUpdatedEventData, + Access.public +); +//Enums +@@usage(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceType, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceType, + Access.public +); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/KeyVault.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.KeyVault/KeyVault.tsp similarity index 98% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/KeyVault.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.KeyVault/KeyVault.tsp index 785bcb739917..a8016e926ba0 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/KeyVault.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.KeyVault/KeyVault.tsp @@ -46,7 +46,7 @@ namespace Microsoft.EventGrid.SystemEvents { } /** Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.VaultAccessPolicyChanged event. */ - model KeyVaultVaultAccessPolicyChangedEventData { + model KeyVaultAccessPolicyChangedEventData { ...KeyVaultCertificateBase; } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.KeyVault/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.KeyVault/client.tsp new file mode 100644 index 000000000000..a717154cd0e3 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.KeyVault/client.tsp @@ -0,0 +1,65 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultCertificateNewVersionCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.KeyVaultCertificateNewVersionCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultCertificateNearExpiryEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.KeyVaultCertificateNearExpiryEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultCertificateExpiredEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.KeyVaultCertificateExpiredEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultKeyNewVersionCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.KeyVaultKeyNewVersionCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultKeyNearExpiryEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.KeyVaultKeyNearExpiryEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultKeyExpiredEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.KeyVaultKeyExpiredEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultSecretNewVersionCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.KeyVaultSecretNewVersionCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultSecretNearExpiryEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.KeyVaultSecretNearExpiryEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultSecretExpiredEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.KeyVaultSecretExpiredEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultAccessPolicyChangedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.KeyVaultAccessPolicyChangedEventData, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/MachineLearningServices.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.MachineLearningServices/MachineLearningServices.tsp similarity index 92% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/MachineLearningServices.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.MachineLearningServices/MachineLearningServices.tsp index 5527e7d244de..7287fceca6e6 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/MachineLearningServices.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.MachineLearningServices/MachineLearningServices.tsp @@ -11,11 +11,11 @@ model MachineLearningServicesModelRegisteredEventData { /** The tags of the model that was registered. */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Model tags is type object" - modelTags?: Record; + modelTags: Record; /** The properties of the model that was registered. */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Model tags is type object" - modelProperties?: Record; + modelProperties: Record; } /** Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelDeployed event. */ @@ -31,11 +31,11 @@ model MachineLearningServicesModelDeployedEventData { /** The tags of the deployed service. */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Service tags is type any" - serviceTags?: Record; + serviceTags: Record; /** The properties of the deployed service. */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Service properties is type any" - serviceProperties?: Record; + serviceProperties: Record; } /** Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunCompleted event. */ @@ -54,11 +54,11 @@ model MachineLearningServicesRunCompletedEventData { /** The tags of the completed Run. */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Run tags is type any" - runTags?: Record; + runTags: Record; /** The properties of the completed Run. */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Run properties is type any" - runProperties?: Record; + runProperties: Record; } /** Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.DatasetDriftDetected event. */ @@ -82,10 +82,10 @@ model MachineLearningServicesDatasetDriftDetectedEventData { driftCoefficient?: float64; /** The start time of the target dataset time series that resulted in drift detection. */ - startTime?: utcDateTime; + startTime: utcDateTime; /** The end time of the target dataset time series that resulted in drift detection. */ - endTime?: utcDateTime; + endTime: utcDateTime; } /** Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunStatusChanged event. */ @@ -104,11 +104,11 @@ model MachineLearningServicesRunStatusChangedEventData { /** The tags of the Machine Learning Run. */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Run tags is type object" - runTags?: Record; + runTags: Record; /** The properties of the Machine Learning Run. */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Run properties is type object" - runProperties?: Record; + runProperties: Record; /** The status of the Machine Learning Run. */ runStatus?: string; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.MachineLearningServices/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.MachineLearningServices/client.tsp new file mode 100644 index 000000000000..9fa2d973b84a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.MachineLearningServices/client.tsp @@ -0,0 +1,35 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.MachineLearningServicesModelRegisteredEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MachineLearningServicesModelRegisteredEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MachineLearningServicesModelDeployedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MachineLearningServicesModelDeployedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MachineLearningServicesRunCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MachineLearningServicesRunCompletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MachineLearningServicesDatasetDriftDetectedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MachineLearningServicesDatasetDriftDetectedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MachineLearningServicesRunStatusChangedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MachineLearningServicesRunStatusChangedEventData, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Maps.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Maps/Maps.tsp similarity index 98% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Maps.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Maps/Maps.tsp index 5d0ff3d6b22f..9f8cbf7e7494 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Maps.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Maps/Maps.tsp @@ -19,7 +19,7 @@ model MapsGeofenceEventProperties { expiredGeofenceGeometryId?: string[]; /** Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence. */ - geometries?: MapsGeofenceGeometry[]; + geometries: MapsGeofenceGeometry[]; /** Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request. */ invalidPeriodGeofenceGeometryId?: string[]; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Maps/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Maps/client.tsp new file mode 100644 index 000000000000..b3953a6f2b83 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Maps/client.tsp @@ -0,0 +1,31 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.MapsGeofenceEnteredEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MapsGeofenceEnteredEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MapsGeofenceExitedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MapsGeofenceExitedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MapsGeofenceResultEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MapsGeofenceResultEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MapsGeofenceEventProperties, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MapsGeofenceEventProperties, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MapsGeofenceGeometry, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.MapsGeofenceGeometry, Access.public); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/MediaServices.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/MediaServices.tsp similarity index 88% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/MediaServices.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/MediaServices.tsp index cc7faf2af749..83ab45e40a9f 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/MediaServices.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/MediaServices.tsp @@ -101,59 +101,51 @@ namespace Microsoft.EventGrid.SystemEvents { */ model MediaJobStateChangeEventData { /** The previous state of the Job. */ - @visibility("read") - previousState?: MediaJobState; + previousState: MediaJobState; /** The new state of the Job. */ - @visibility("read") - state?: MediaJobState; + state: MediaJobState; /** Gets the Job correlation data. */ - correlationData?: Record; + correlationData: Record; } /** Details of JobOutput errors. */ model MediaJobError { /** Error code describing the error. */ - @visibility("read") - code?: MediaJobErrorCode; + code: MediaJobErrorCode; /** A human-readable language-dependent representation of the error. */ - @visibility("read") message?: string; /** Helps with categorization of errors. */ - @visibility("read") - category?: MediaJobErrorCategory; + category: MediaJobErrorCategory; /** Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. */ - @visibility("read") - retry?: MediaJobRetry; + retry: MediaJobRetry; /** An array of details about specific errors that led to this reported error. */ - @visibility("read") - details?: MediaJobErrorDetail[]; + details: MediaJobErrorDetail[]; } /** Details of JobOutput errors. */ model MediaJobErrorDetail { /** Code describing the error detail. */ - @visibility("read") code?: string; /** A human-readable representation of the error. */ - @visibility("read") message?: string; } /** The event data for a Job output. */ - @discriminator("@odataType") + @discriminator("@odata.type") model MediaJobOutput { /** The discriminator for derived types. */ - `@odataType`: string; + #suppress "@azure-tools/typespec-azure-core/casing-style" "Maintain compatibility with existing models." + `@odata.type`: string; /** Gets the Job output error. */ - error?: MediaJobError; + error: MediaJobError; /** Gets the Job output label. */ label?: string; @@ -171,7 +163,8 @@ namespace Microsoft.EventGrid.SystemEvents { assetName?: string; /** The discriminator for derived types. */ - `@odataType`: "#Microsoft.Media.JobOutputAsset"; + #suppress "@azure-tools/typespec-azure-core/casing-style" "Maintain compatibility with existing models." + `@odata.type`: "#Microsoft.Media.JobOutputAsset"; } /** @@ -186,7 +179,7 @@ namespace Microsoft.EventGrid.SystemEvents { progress?: int64; /** Gets the Job correlation data. */ - jobCorrelationData?: Record; + jobCorrelationData: Record; } /** @@ -195,14 +188,13 @@ namespace Microsoft.EventGrid.SystemEvents { */ model MediaJobOutputStateChangeEventData { /** The previous state of the Job. */ - @visibility("read") - previousState?: MediaJobState; + previousState: MediaJobState; /** Gets the output. */ - output?: MediaJobOutput; + output: MediaJobOutput; /** Gets the Job correlation data. */ - jobCorrelationData?: Record; + jobCorrelationData: Record; } /** @@ -233,7 +225,7 @@ Microsoft.Media.JobFinished event. #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." model MediaJobFinishedEventData extends MediaJobStateChangeEventData { /** Gets the Job outputs. */ - outputs?: MediaJobOutput[]; + outputs: MediaJobOutput[]; } /** @@ -243,7 +235,7 @@ Microsoft.Media.JobCanceled event. #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." model MediaJobCanceledEventData extends MediaJobStateChangeEventData { /** Gets the Job outputs. */ - outputs?: MediaJobOutput[]; + outputs: MediaJobOutput[]; } /** @@ -253,7 +245,7 @@ for a Microsoft.Media.JobErrored event. #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." model MediaJobErroredEventData extends MediaJobStateChangeEventData { /** Gets the Job outputs. */ - outputs?: MediaJobOutput[]; + outputs: MediaJobOutput[]; } /** @@ -328,104 +320,81 @@ EventGridEvent for a Microsoft.Media.JobOutputScheduled event. /** Encoder connect event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingStreamReceived event. */ model MediaLiveEventIncomingStreamReceivedEventData { /** Gets the ingest URL provided by the live event. */ - @visibility("read") ingestUrl?: string; /** Gets the type of the track (Audio / Video). */ - @visibility("read") trackType?: string; /** Gets the track name. */ - @visibility("read") trackName?: string; /** Gets the bitrate of the track. */ - @visibility("read") bitrate?: int64; /** Gets the remote IP. */ - @visibility("read") encoderIp?: string; /** Gets the remote port. */ - @visibility("read") encoderPort?: string; /** Gets the first timestamp of the data chunk received. */ - @visibility("read") timestamp?: string; /** Gets the duration of the first data chunk. */ - @visibility("read") duration?: string; /** Gets the timescale in which timestamp is represented. */ - @visibility("read") timescale?: string; } /** Incoming streams out of sync event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingStreamsOutOfSync event. */ model MediaLiveEventIncomingStreamsOutOfSyncEventData { /** Gets the minimum last timestamp received. */ - @visibility("read") minLastTimestamp?: string; /** Gets the type of stream with minimum last timestamp. */ - @visibility("read") typeOfStreamWithMinLastTimestamp?: string; /** Gets the maximum timestamp among all the tracks (audio or video). */ - @visibility("read") maxLastTimestamp?: string; /** Gets the type of stream with maximum last timestamp. */ - @visibility("read") typeOfStreamWithMaxLastTimestamp?: string; /** Gets the timescale in which \"MinLastTimestamp\" is represented. */ - @visibility("read") timescaleOfMinLastTimestamp?: string; /** Gets the timescale in which \"MaxLastTimestamp\" is represented. */ - @visibility("read") timescaleOfMaxLastTimestamp?: string; } /** Incoming video stream out of sync event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingVideoStreamsOutOfSync event. */ model MediaLiveEventIncomingVideoStreamsOutOfSyncEventData { /** Gets the first timestamp received for one of the quality levels. */ - @visibility("read") firstTimestamp?: string; /** Gets the duration of the data chunk with first timestamp. */ - @visibility("read") firstDuration?: string; /** Gets the timestamp received for some other quality levels. */ - @visibility("read") secondTimestamp?: string; /** Gets the duration of the data chunk with second timestamp. */ - @visibility("read") secondDuration?: string; /** Gets the timescale in which both the timestamps and durations are represented. */ - @visibility("read") timescale?: string; } /** Ingest fragment dropped event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingDataChunkDropped event. */ model MediaLiveEventIncomingDataChunkDroppedEventData { /** Gets the timestamp of the data chunk dropped. */ - @visibility("read") timestamp?: string; /** Gets the type of the track (Audio / Video). */ - @visibility("read") trackType?: string; /** Gets the bitrate of the track. */ - @visibility("read") bitrate?: int64; /** Gets the timescale of the Timestamp. */ @@ -433,138 +402,107 @@ EventGridEvent for a Microsoft.Media.JobOutputScheduled event. timescale?: string; /** Gets the result code for fragment drop operation. */ - @visibility("read") resultCode?: string; /** Gets the name of the track for which fragment is dropped. */ - @visibility("read") trackName?: string; } /** Ingest heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIngestHeartbeat event. */ model MediaLiveEventIngestHeartbeatEventData { /** Gets the type of the track (Audio / Video). */ - @visibility("read") trackType?: string; /** Gets the track name. */ - @visibility("read") trackName?: string; /** Gets the Live Transcription language. */ - @visibility("read") transcriptionLanguage?: string; /** Gets the Live Transcription state. */ - @visibility("read") transcriptionState?: string; /** Gets the bitrate of the track. */ - @visibility("read") bitrate?: int64; /** Gets the incoming bitrate. */ - @visibility("read") incomingBitrate?: int64; /** Gets the track ingest drift value. */ - @visibility("read") ingestDriftValue?: string; /** Gets the arrival UTC time of the last fragment. */ - @visibility("read") lastFragmentArrivalTime?: string; /** Gets the last timestamp. */ - @visibility("read") lastTimestamp?: string; /** Gets the timescale of the last timestamp. */ - @visibility("read") timescale?: string; /** Gets the fragment Overlap count. */ - @visibility("read") overlapCount?: int64; /** Gets the fragment Discontinuity count. */ - @visibility("read") discontinuityCount?: int64; /** Gets Non increasing count. */ - @visibility("read") nonincreasingCount?: int64; /** Gets a value indicating whether unexpected bitrate is present or not. */ - @visibility("read") unexpectedBitrate?: boolean; /** Gets the state of the live event. */ - @visibility("read") state?: string; /** Gets a value indicating whether preview is healthy or not. */ - @visibility("read") healthy?: boolean; } /** Ingest track discontinuity detected event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventTrackDiscontinuityDetected event. */ model MediaLiveEventTrackDiscontinuityDetectedEventData { /** Gets the type of the track (Audio / Video). */ - @visibility("read") trackType?: string; /** Gets the track name. */ - @visibility("read") trackName?: string; /** Gets the bitrate. */ - @visibility("read") bitrate?: int64; /** Gets the timestamp of the previous fragment. */ - @visibility("read") previousTimestamp?: string; /** Gets the timestamp of the current fragment. */ - @visibility("read") newTimestamp?: string; /** Gets the timescale in which both timestamps and discontinuity gap are represented. */ - @visibility("read") timescale?: string; /** Gets the discontinuity gap between PreviousTimestamp and NewTimestamp. */ - @visibility("read") discontinuityGap?: string; } /** Channel Archive heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventChannelArchiveHeartbeat event. */ model MediaLiveEventChannelArchiveHeartbeatEventData { /** Gets the channel latency in ms. */ - @visibility("read") channelLatencyMs: string; /** Gets the latency result code. */ - @visibility("read") latencyResultCode: string; } alias MediaLiveEventConnectionBaseData = { /** Gets the ingest URL provided by the live event. */ - @visibility("read") ingestUrl?: string; /** Gets the stream Id. */ - @visibility("read") streamId?: string; /** Gets the remote IP. */ - @visibility("read") encoderIp?: string; /** Gets the remote port. */ - @visibility("read") encoderPort?: string; }; } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/client.tsp new file mode 100644 index 000000000000..59fd9895e031 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/client.tsp @@ -0,0 +1,171 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobStateChangeEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobStateChangeEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobError, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobError, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobErrorDetail, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobErrorDetail, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutput, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutput, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputAsset, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputAsset, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputProgressEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputProgressEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputStateChangeEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputStateChangeEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobScheduledEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobScheduledEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobProcessingEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobProcessingEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobCancelingEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobCancelingEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobFinishedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobFinishedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobCanceledEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobCanceledEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobErroredEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobErroredEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputCanceledEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputCanceledEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputCancelingEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputCancelingEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputErroredEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputErroredEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputFinishedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputFinishedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputProcessingEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputProcessingEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputScheduledEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputScheduledEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventEncoderConnectedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventEncoderConnectedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventConnectionRejectedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventConnectionRejectedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventEncoderDisconnectedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventEncoderDisconnectedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingStreamReceivedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingStreamReceivedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingStreamsOutOfSyncEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingStreamsOutOfSyncEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingVideoStreamsOutOfSyncEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingVideoStreamsOutOfSyncEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingDataChunkDroppedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingDataChunkDroppedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventIngestHeartbeatEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventIngestHeartbeatEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventTrackDiscontinuityDetectedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventTrackDiscontinuityDetectedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventChannelArchiveHeartbeatEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventChannelArchiveHeartbeatEventData, + Access.public +); +//Enums +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobState, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobState, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobErrorCode, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobErrorCode, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobErrorCategory, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobErrorCategory, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.MediaJobRetry, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.MediaJobRetry, Access.public); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/PolicyInsights.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.PolicyInsights/PolicyInsights.tsp similarity index 98% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/PolicyInsights.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.PolicyInsights/PolicyInsights.tsp index 0422c875de2f..4f1aeb38de12 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/PolicyInsights.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.PolicyInsights/PolicyInsights.tsp @@ -17,7 +17,7 @@ namespace Microsoft.EventGrid.SystemEvents { alias PolicyInsightsBaseEventData = { /** The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ. */ - timestamp?: utcDateTime; + timestamp: utcDateTime; /** The resource ID of the policy assignment. */ policyAssignmentId?: string; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.PolicyInsights/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.PolicyInsights/client.tsp new file mode 100644 index 000000000000..a4f1b2130a50 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.PolicyInsights/client.tsp @@ -0,0 +1,23 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.PolicyInsightsPolicyStateCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.PolicyInsightsPolicyStateCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.PolicyInsightsPolicyStateChangedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.PolicyInsightsPolicyStateChangedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.PolicyInsightsPolicyStateDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.PolicyInsightsPolicyStateDeletedEventData, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/ResourceNotifications.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ResourceNotifications/ResourceNotifications.tsp similarity index 91% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/ResourceNotifications.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ResourceNotifications/ResourceNotifications.tsp index 5ce0ff6e35a4..d43977b7fa8c 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/ResourceNotifications.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ResourceNotifications/ResourceNotifications.tsp @@ -16,10 +16,10 @@ model ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData /** Describes the schema of the common properties across all ARN system topic events */ model ResourceNotificationsResourceUpdatedEventData { /** resourceInfo details for update event */ - resourceInfo?: ResourceNotificationsResourceUpdatedDetails; + resourceInfo: ResourceNotificationsResourceUpdatedDetails; /** details about operational info */ - operationalInfo?: ResourceNotificationsOperationalDetails; + operationalInfo: ResourceNotificationsOperationalDetails; /** api version of the resource properties bag */ apiVersion?: string; @@ -43,18 +43,18 @@ model ResourceNotificationsResourceUpdatedDetails { location?: string; /** the tags on the resource for which the event is being emitted */ - tags?: Record; + tags: Record; /** properties in the payload of the resource for which the event is being emitted */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "The type of properties is object with additionalProperties object" - properties?: Record; + properties: Record; } /** details of operational info */ model ResourceNotificationsOperationalDetails { /** Date and Time when resource was updated */ // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. - resourceEventTime?: utcDateTime; + resourceEventTime: utcDateTime; } /** @@ -89,10 +89,10 @@ delete events */ model ResourceNotificationsResourceDeletedEventData { /** resourceInfo details for delete event */ - resourceInfo?: ResourceNotificationsResourceDeletedDetails; + resourceInfo: ResourceNotificationsResourceDeletedDetails; /** details about operational info */ - operationalInfo?: ResourceNotificationsOperationalDetails; + operationalInfo: ResourceNotificationsOperationalDetails; } /** diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ResourceNotifications/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ResourceNotifications/client.tsp new file mode 100644 index 000000000000..8783a167984a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ResourceNotifications/client.tsp @@ -0,0 +1,59 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceUpdatedDetails, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceUpdatedDetails, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsOperationalDetails, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsOperationalDetails, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsHealthResourcesAnnotatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsHealthResourcesAnnotatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceManagementCreatedOrUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceManagementCreatedOrUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceManagementDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceManagementDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceDeletedDetails, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceDeletedDetails, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Resources.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Resources/Resources.tsp similarity index 87% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Resources.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Resources/Resources.tsp index 489bbfb670d9..988522ec27d9 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Resources.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Resources/Resources.tsp @@ -1,47 +1,47 @@ /** Describes the schema of the Azure resource events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteSuccess event. This is raised when a resource create or update operation succeeds. */ - model ResourceWriteSuccessData { + model ResourceWriteSuccessEventData { ...ResourceBaseEventData; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteFailure event. This is raised when a resource create or update operation fails. */ - model ResourceWriteFailureData { + model ResourceWriteFailureEventData { ...ResourceBaseEventData; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteCancel event. This is raised when a resource create or update operation is canceled. */ - model ResourceWriteCancelData { + model ResourceWriteCancelEventData { ...ResourceBaseEventData; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds. */ - model ResourceDeleteSuccessData { + model ResourceDeleteSuccessEventData { ...ResourceBaseEventData; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails. */ - model ResourceDeleteFailureData { + model ResourceDeleteFailureEventData { ...ResourceBaseEventData; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled. */ - model ResourceDeleteCancelData { + model ResourceDeleteCancelEventData { ...ResourceBaseEventData; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds. */ - model ResourceActionSuccessData { + model ResourceActionSuccessEventData { ...ResourceBaseEventData; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails. */ - model ResourceActionFailureData { + model ResourceActionFailureEventData { ...ResourceBaseEventData; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled. */ - model ResourceActionCancelData { + model ResourceActionCancelEventData { ...ResourceBaseEventData; } @@ -69,7 +69,7 @@ namespace Microsoft.EventGrid.SystemEvents { action?: string; /** The evidence for the authorization. */ - evidence?: Record; + evidence: Record; } alias ResourceBaseEventData = { @@ -95,15 +95,15 @@ namespace Microsoft.EventGrid.SystemEvents { status?: string; /** The requested authorization for the operation. */ - authorization?: ResourceAuthorization; + authorization: ResourceAuthorization; /** The properties of the claims. */ - claims?: Record; + claims: Record; /** An operation ID used for troubleshooting. */ correlationId?: string; /** The details of the operation. */ - httpRequest?: ResourceHttpRequest; + httpRequest: ResourceHttpRequest; }; } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Resources/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Resources/client.tsp new file mode 100644 index 000000000000..c9c2bb163517 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Resources/client.tsp @@ -0,0 +1,63 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.ResourceWriteSuccessEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceWriteSuccessEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceWriteFailureEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceWriteFailureEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceWriteCancelEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceWriteCancelEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceDeleteSuccessEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceDeleteSuccessEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceDeleteFailureEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceDeleteFailureEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceDeleteCancelEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceDeleteCancelEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceActionSuccessEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceActionSuccessEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceActionFailureEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceActionFailureEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceActionCancelEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ResourceActionCancelEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceHttpRequest, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.ResourceHttpRequest, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.ResourceAuthorization, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.ResourceAuthorization, Access.public); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/ServiceBus.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ServiceBus/ServiceBus.tsp similarity index 100% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/ServiceBus.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ServiceBus/ServiceBus.tsp diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ServiceBus/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ServiceBus/client.tsp new file mode 100644 index 000000000000..cf03f77c19ec --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ServiceBus/client.tsp @@ -0,0 +1,29 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.ServiceBusActiveMessagesAvailableWithNoListenersEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ServiceBusActiveMessagesAvailableWithNoListenersEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ServiceBusDeadletterMessagesAvailableWithNoListenersEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ServiceBusDeadletterMessagesAvailableWithNoListenersEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/SignalRService.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.SignalRService/SignalRService.tsp similarity index 97% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/SignalRService.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.SignalRService/SignalRService.tsp index ac2f698c5f70..7eec1b99c30e 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/SignalRService.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.SignalRService/SignalRService.tsp @@ -18,7 +18,7 @@ namespace Microsoft.EventGrid.SystemEvents { alias SignalRServiceBaseEventdata = { /** The time at which the event occurred. */ - timestamp?: utcDateTime; + timestamp: utcDateTime; /** The hub of connected client connection. */ hubName?: string; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.SignalRService/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.SignalRService/client.tsp new file mode 100644 index 000000000000..790c2e7a6cde --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.SignalRService/client.tsp @@ -0,0 +1,17 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.SignalRServiceClientConnectionConnectedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.SignalRServiceClientConnectionConnectedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.SignalRServiceClientConnectionDisconnectedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.SignalRServiceClientConnectionDisconnectedEventData, + Access.public +); +//Enums diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Storage.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Storage/Storage.tsp similarity index 95% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Storage.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Storage/Storage.tsp index 2d8e72c4db76..88f423a12136 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Storage.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Storage/Storage.tsp @@ -159,13 +159,13 @@ namespace Microsoft.EventGrid.SystemEvents { scheduleTime?: string; /** Execution statistics of a specific policy action in a Blob Management cycle. */ - deleteSummary?: StorageLifecyclePolicyActionSummaryDetail; + deleteSummary: StorageLifecyclePolicyActionSummaryDetail; /** Execution statistics of a specific policy action in a Blob Management cycle. */ - tierToCoolSummary?: StorageLifecyclePolicyActionSummaryDetail; + tierToCoolSummary: StorageLifecyclePolicyActionSummaryDetail; /** Execution statistics of a specific policy action in a Blob Management cycle. */ - tierToArchiveSummary?: StorageLifecyclePolicyActionSummaryDetail; + tierToArchiveSummary: StorageLifecyclePolicyActionSummaryDetail; } /** Execution statistics of a specific policy action in a Blob Management cycle. */ @@ -241,7 +241,7 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobInventoryPolicyCompleted event. */ model StorageBlobInventoryPolicyCompletedEventData { /** The time at which inventory policy was scheduled. */ - scheduleDateTime?: utcDateTime; + scheduleDateTime: utcDateTime; /** The account name for which inventory policy is registered. */ accountName?: string; @@ -265,10 +265,10 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskCompleted event. */ model StorageTaskCompletedEventData { /** The status for a storage task. */ - status?: StorageTaskCompletedStatus; + status: StorageTaskCompletedStatus; /** The time at which a storage task was completed. */ - completedDateTime?: utcDateTime; + completedDateTime: utcDateTime; /** The execution id for a storage task. */ taskExecutionId?: string; @@ -277,13 +277,13 @@ namespace Microsoft.EventGrid.SystemEvents { taskName?: string; /** The summary report blob url for a storage task */ - summaryReportBlobUrl?: url; + summaryReportBlobUrl: url; } /** Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskQueued event. */ model StorageTaskQueuedEventData { /** The time at which a storage task was queued. */ - queuedDateTime?: utcDateTime; + queuedDateTime: utcDateTime; /** The execution id for a storage task. */ taskExecutionId?: string; @@ -293,7 +293,7 @@ namespace Microsoft.EventGrid.SystemEvents { model StorageTaskAssignmentQueuedEventData { /** The time at which a storage task was queued. */ // @encode("ISO8601") - queuedDateTime?: utcDateTime; + queuedDateTime: utcDateTime; /** The execution id for a storage task. */ taskExecutionId?: string; @@ -302,11 +302,11 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentCompleted event. */ model StorageTaskAssignmentCompletedEventData { /** The status for a storage task. */ - status?: StorageTaskAssignmentCompletedStatus; + status: StorageTaskAssignmentCompletedStatus; /** The time at which a storage task was completed. */ // @encode("ISO8601") - completedDateTime?: utcDateTime; + completedDateTime: utcDateTime; /** The execution id for a storage task. */ taskExecutionId?: string; @@ -315,7 +315,7 @@ namespace Microsoft.EventGrid.SystemEvents { taskName?: string; /** The summary report blob url for a storage task */ - summaryReportBlobUrl?: url; + summaryReportBlobUrl: url; } /** The status for a storage task. */ @@ -346,6 +346,6 @@ namespace Microsoft.EventGrid.SystemEvents { /** For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers. */ #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Type is Object in swagger" - storageDiagnostics?: Record; + storageDiagnostics: Record; }; } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Storage/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Storage/client.tsp new file mode 100644 index 000000000000..d3f6d0014828 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Storage/client.tsp @@ -0,0 +1,107 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.StorageBlobCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageBlobCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageBlobDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageBlobDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageDirectoryCreatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageDirectoryCreatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageDirectoryDeletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageDirectoryDeletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageBlobRenamedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageBlobRenamedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageDirectoryRenamedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageDirectoryRenamedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageLifecyclePolicyCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageLifecyclePolicyCompletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageLifecyclePolicyActionSummaryDetail, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageLifecyclePolicyActionSummaryDetail, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageBlobTierChangedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageBlobTierChangedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageAsyncOperationInitiatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageAsyncOperationInitiatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageBlobInventoryPolicyCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageBlobInventoryPolicyCompletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageTaskCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageTaskCompletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageTaskQueuedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageTaskQueuedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentQueuedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentQueuedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentCompletedEventData, + Access.public +); +//Enums +@@usage(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentCompletedStatus, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentCompletedStatus, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.StorageTaskCompletedStatus, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.StorageTaskCompletedStatus, + Access.public +); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Web.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Web/Web.tsp similarity index 96% rename from specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Web.tsp rename to specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Web/Web.tsp index 367113ce36dc..762cc4d65ce0 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Web.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Web/Web.tsp @@ -4,7 +4,7 @@ namespace Microsoft.EventGrid.SystemEvents { /** Detail of action on the app. */ model AppEventTypeDetail { /** Type of action of the operation. */ - action?: AppAction; + action: AppAction; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppUpdated event. */ @@ -70,10 +70,10 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppServicePlanUpdated event. */ model WebAppServicePlanUpdatedEventData { /** Detail of action on the app service plan. */ - appServicePlanEventTypeDetail?: AppServicePlanEventTypeDetail; + appServicePlanEventTypeDetail: AppServicePlanEventTypeDetail; /** sku of app service plan. */ - sku?: WebAppServicePlanUpdatedEventDataSku; + sku: WebAppServicePlanUpdatedEventDataSku; /** name of the app service plan that had this event. */ name?: string; @@ -142,13 +142,13 @@ namespace Microsoft.EventGrid.SystemEvents { /** Detail of action on the app service plan. */ model AppServicePlanEventTypeDetail { /** Kind of environment where app service plan is. */ - stampKind?: StampKind; + stampKind: StampKind; /** Type of action on the app service plan. */ - action?: AppServicePlanAction; + action: AppServicePlanAction; /** Asynchronous operation status of the operation on the app service plan. */ - status?: AsyncStatus; + status: AsyncStatus; } /** Asynchronous operation status of the operation on the app service plan. */ @@ -167,7 +167,7 @@ namespace Microsoft.EventGrid.SystemEvents { alias WebAppBaseEventData = { /** Detail of action on the app. */ - appEventTypeDetail?: AppEventTypeDetail; + appEventTypeDetail: AppEventTypeDetail; /** name of the web site that had this event. */ name?: string; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Web/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Web/client.tsp new file mode 100644 index 000000000000..c034a51b8e40 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Web/client.tsp @@ -0,0 +1,103 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +//Models +@@usage(Microsoft.EventGrid.SystemEvents.AppEventTypeDetail, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AppEventTypeDetail, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.WebAppUpdatedEventData, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.WebAppUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebBackupOperationStartedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebBackupOperationStartedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebBackupOperationCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebBackupOperationCompletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebBackupOperationFailedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebBackupOperationFailedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebRestoreOperationStartedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebRestoreOperationStartedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebRestoreOperationCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebRestoreOperationCompletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebRestoreOperationFailedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebRestoreOperationFailedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebSlotSwapStartedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebSlotSwapStartedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebSlotSwapCompletedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebSlotSwapCompletedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebSlotSwapFailedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebSlotSwapFailedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebSlotSwapWithPreviewStartedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebSlotSwapWithPreviewStartedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebSlotSwapWithPreviewCancelledEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebSlotSwapWithPreviewCancelledEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebAppServicePlanUpdatedEventData, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebAppServicePlanUpdatedEventData, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.AppServicePlanEventTypeDetail, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.AppServicePlanEventTypeDetail, + Access.public +); +@@usage(Microsoft.EventGrid.SystemEvents.WebAppServicePlanUpdatedEventDataSku, + Usage.output +); +@@access(Microsoft.EventGrid.SystemEvents.WebAppServicePlanUpdatedEventDataSku, + Access.public +); +//Enums +@@usage(Microsoft.EventGrid.SystemEvents.AppAction, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AppAction, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.StampKind, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.StampKind, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.AppServicePlanAction, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AppServicePlanAction, Access.public); +@@usage(Microsoft.EventGrid.SystemEvents.AsyncStatus, Usage.output); +@@access(Microsoft.EventGrid.SystemEvents.AsyncStatus, Access.public); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/client.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/client.tsp index 9efe25648d95..3a7b3f639825 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/client.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/client.tsp @@ -1,1695 +1,26 @@ -import "@azure-tools/typespec-client-generator-core"; -import "@typespec/versioning"; - import "./main.tsp"; -using Azure.ClientGenerator.Core; - -// Models -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementUserCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementUserCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementUserUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementUserUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementUserDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementUserDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementSubscriptionCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementSubscriptionCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementSubscriptionUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementSubscriptionUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementSubscriptionDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementSubscriptionDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementProductCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementProductCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementProductUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementProductUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementProductDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementProductDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementApiCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementApiCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementApiUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementApiUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementApiDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementApiDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementApiReleaseCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementApiReleaseCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementApiReleaseUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementApiReleaseUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementApiReleaseDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementApiReleaseDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayHostnameConfigurationCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayHostnameConfigurationCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayHostnameConfigurationUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayHostnameConfigurationUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayHostnameConfigurationDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayHostnameConfigurationDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCertificateAuthorityCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCertificateAuthorityCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCertificateAuthorityUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCertificateAuthorityUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCertificateAuthorityDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayCertificateAuthorityDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayApiAddedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayApiAddedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayApiRemovedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ApiManagementGatewayApiRemovedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AppConfigurationKeyValueModifiedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AppConfigurationKeyValueModifiedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AppConfigurationKeyValueDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AppConfigurationKeyValueDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AppConfigurationSnapshotEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AppConfigurationSnapshotEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AppConfigurationSnapshotCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AppConfigurationSnapshotCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AppConfigurationSnapshotModifiedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AppConfigurationSnapshotModifiedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudUpdatingEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudUpdatingEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudFailedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudFailedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsClusterCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsClusterCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsClusterDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsClusterDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsClusterUpdatingEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsClusterUpdatingEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsClusterUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsClusterUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsClusterFailedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsClusterFailedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionFinishedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionFinishedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionCancelledEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionCancelledEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionFailedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionFailedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsPrivateCloudEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AvsClusterEventData, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AvsClusterEventData, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AvsScriptExecutionEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsIncomingCallEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsIncomingCallEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsUserDisconnectedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsUserDisconnectedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageReceivedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageReceivedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageReceivedInThreadEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageReceivedInThreadEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageEditedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageEditedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageEditedInThreadEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageEditedInThreadEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageDeletedInThreadEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageDeletedInThreadEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadCreatedWithUserEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadCreatedWithUserEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadWithUserDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadWithUserDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadPropertiesUpdatedPerUserEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadPropertiesUpdatedPerUserEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadPropertiesUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadPropertiesUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatParticipantAddedToThreadWithUserEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatParticipantAddedToThreadWithUserEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatParticipantRemovedFromThreadWithUserEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatParticipantRemovedFromThreadWithUserEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatParticipantAddedToThreadEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatParticipantAddedToThreadEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatParticipantRemovedFromThreadEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatParticipantRemovedFromThreadEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsSmsDeliveryReportReceivedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsSmsDeliveryReportReceivedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsSmsReceivedEventData, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AcsSmsReceivedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRecordingFileStatusUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRecordingFileStatusUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportReceivedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportReceivedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsEmailEngagementTrackingReportReceivedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsEmailEngagementTrackingReportReceivedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobCancelledEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobCancelledEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobClassificationFailedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobClassificationFailedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobClassifiedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobClassifiedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobClosedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobClosedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobExceptionTriggeredEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobExceptionTriggeredEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobQueuedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobQueuedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobReceivedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobReceivedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobSchedulingFailedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobSchedulingFailedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobUnassignedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobUnassignedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobWaitingForActivationEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobWaitingForActivationEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobWorkerSelectorsExpiredEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobWorkerSelectorsExpiredEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerDeregisteredEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerDeregisteredEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferAcceptedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferAcceptedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferDeclinedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferDeclinedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferExpiredEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferExpiredEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferIssuedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferIssuedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferRevokedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerOfferRevokedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerRegisteredEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerRegisteredEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobEventData, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobEventData, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterEventData, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterEventData, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterChannelConfiguration, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterChannelConfiguration, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterQueueDetails, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterQueueDetails, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterCommunicationError, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterCommunicationError, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerSelector, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerSelector, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportStatusDetails, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportStatusDetails, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadEventBaseProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadEventBaseProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadEventInThreadBaseProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadEventInThreadBaseProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageEventBaseProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageEventBaseProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatMessageEventInThreadBaseProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatMessageEventInThreadBaseProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatEventInThreadBaseProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatEventInThreadBaseProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatEventBaseProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatEventBaseProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsChatThreadParticipantProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsChatThreadParticipantProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsSmsEventBaseProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsSmsEventBaseProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsSmsDeliveryAttemptProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsSmsDeliveryAttemptProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRecordingStorageInfoProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRecordingStorageInfoProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRecordingChunkInfoProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRecordingChunkInfoProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsIncomingCallCustomContext, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsIncomingCallCustomContext, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.CommunicationIdentifierModel, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.CommunicationIdentifierModel, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MicrosoftTeamsUserIdentifierModel, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MicrosoftTeamsUserIdentifierModel, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.PhoneNumberIdentifierModel, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.PhoneNumberIdentifierModel, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.CommunicationUserIdentifierModel, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.CommunicationUserIdentifierModel, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryImagePushedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryImagePushedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryImageDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryImageDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryChartPushedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryChartPushedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryChartDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryChartDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryArtifactEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryArtifactEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventTarget, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventTarget, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryArtifactEventTarget, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryArtifactEventTarget, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventRequest, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventRequest, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventActor, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventActor, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventSource, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventSource, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventConnectedRegistry, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerRegistryEventConnectedRegistry, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceNewKubernetesVersionAvailableEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceNewKubernetesVersionAvailableEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceClusterSupportEndedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceClusterSupportEndedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceClusterSupportEndingEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceClusterSupportEndingEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingStartedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingStartedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingSucceededEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingSucceededEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingFailedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingFailedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceClusterSupportEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceClusterSupportEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ContainerServiceNodePoolRollingEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.DataBoxCopyStartedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.DataBoxCopyStartedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.DataBoxCopyCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.DataBoxCopyCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.DataBoxOrderCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.DataBoxOrderCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.SubscriptionValidationEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.SubscriptionValidationEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.SubscriptionValidationResponse, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.SubscriptionValidationResponse, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.SubscriptionDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.SubscriptionDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientCreatedOrUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientCreatedOrUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientSessionConnectedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientSessionConnectedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientSessionDisconnectedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientSessionDisconnectedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.EventHubCaptureFileCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.EventHubCaptureFileCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceType, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceType, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.HealthcareDicomImageCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.HealthcareDicomImageCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.HealthcareDicomImageDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.HealthcareDicomImageDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.HealthcareDicomImageUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.HealthcareDicomImageUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.DeviceLifeCycleEventProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.DeviceLifeCycleEventProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.DeviceTwinMetadata, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.DeviceTwinMetadata, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.DeviceTwinProperties, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.DeviceTwinProperties, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.DeviceTwinInfo, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.DeviceTwinInfo, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.DeviceConnectionStateEventProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.DeviceConnectionStateEventProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.DeviceTelemetryEventProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.DeviceTelemetryEventProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.DeviceConnectionStateEventInfo, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.DeviceConnectionStateEventInfo, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.IotHubDeviceCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.IotHubDeviceCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.IotHubDeviceDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.IotHubDeviceDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.IotHubDeviceConnectedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.IotHubDeviceConnectedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.IotHubDeviceDisconnectedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.IotHubDeviceDisconnectedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.IotHubDeviceTelemetryEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.IotHubDeviceTelemetryEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.DeviceTwinInfoX509Thumbprint, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.DeviceTwinInfoX509Thumbprint, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.DeviceTwinInfoProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.DeviceTwinInfoProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultCertificateNewVersionCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.KeyVaultCertificateNewVersionCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultCertificateNearExpiryEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.KeyVaultCertificateNearExpiryEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultCertificateExpiredEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.KeyVaultCertificateExpiredEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultKeyNewVersionCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.KeyVaultKeyNewVersionCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultKeyNearExpiryEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.KeyVaultKeyNearExpiryEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultKeyExpiredEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.KeyVaultKeyExpiredEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultSecretNewVersionCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.KeyVaultSecretNewVersionCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultSecretNearExpiryEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.KeyVaultSecretNearExpiryEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultSecretExpiredEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.KeyVaultSecretExpiredEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.KeyVaultVaultAccessPolicyChangedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.KeyVaultVaultAccessPolicyChangedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MachineLearningServicesModelRegisteredEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MachineLearningServicesModelRegisteredEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MachineLearningServicesModelDeployedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MachineLearningServicesModelDeployedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MachineLearningServicesRunCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MachineLearningServicesRunCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MachineLearningServicesDatasetDriftDetectedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MachineLearningServicesDatasetDriftDetectedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MachineLearningServicesRunStatusChangedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MachineLearningServicesRunStatusChangedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MapsGeofenceEnteredEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MapsGeofenceEnteredEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MapsGeofenceExitedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MapsGeofenceExitedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MapsGeofenceResultEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MapsGeofenceResultEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MapsGeofenceEventProperties, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MapsGeofenceEventProperties, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MapsGeofenceGeometry, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.MapsGeofenceGeometry, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobStateChangeEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobStateChangeEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobError, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobError, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobErrorDetail, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobErrorDetail, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutput, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutput, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputAsset, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputAsset, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputProgressEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputProgressEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputStateChangeEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputStateChangeEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobScheduledEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobScheduledEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobProcessingEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobProcessingEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobCancelingEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobCancelingEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobFinishedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobFinishedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobCanceledEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobCanceledEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobErroredEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobErroredEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputCanceledEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputCanceledEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputCancelingEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputCancelingEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputErroredEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputErroredEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputFinishedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputFinishedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputProcessingEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputProcessingEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobOutputScheduledEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobOutputScheduledEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventEncoderConnectedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventEncoderConnectedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventConnectionRejectedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventConnectionRejectedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventEncoderDisconnectedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventEncoderDisconnectedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingStreamReceivedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingStreamReceivedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingStreamsOutOfSyncEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingStreamsOutOfSyncEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingVideoStreamsOutOfSyncEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingVideoStreamsOutOfSyncEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingDataChunkDroppedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventIncomingDataChunkDroppedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventIngestHeartbeatEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventIngestHeartbeatEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventTrackDiscontinuityDetectedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventTrackDiscontinuityDetectedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaLiveEventChannelArchiveHeartbeatEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.MediaLiveEventChannelArchiveHeartbeatEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.PolicyInsightsPolicyStateCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.PolicyInsightsPolicyStateCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.PolicyInsightsPolicyStateChangedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.PolicyInsightsPolicyStateChangedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.PolicyInsightsPolicyStateDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.PolicyInsightsPolicyStateDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.RedisPatchingCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.RedisPatchingCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.RedisScalingCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.RedisScalingCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.RedisExportRDBCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.RedisExportRDBCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.RedisImportRDBCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.RedisImportRDBCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceWriteSuccessData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceWriteSuccessData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceWriteFailureData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceWriteFailureData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceWriteCancelData, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.ResourceWriteCancelData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceDeleteSuccessData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceDeleteSuccessData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceDeleteFailureData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceDeleteFailureData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceDeleteCancelData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceDeleteCancelData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceActionSuccessData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceActionSuccessData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceActionFailureData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceActionFailureData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceActionCancelData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceActionCancelData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceHttpRequest, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.ResourceHttpRequest, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceAuthorization, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.ResourceAuthorization, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.ServiceBusActiveMessagesAvailableWithNoListenersEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ServiceBusActiveMessagesAvailableWithNoListenersEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ServiceBusDeadletterMessagesAvailableWithNoListenersEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ServiceBusDeadletterMessagesAvailableWithNoListenersEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.SignalRServiceClientConnectionConnectedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.SignalRServiceClientConnectionConnectedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.SignalRServiceClientConnectionDisconnectedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.SignalRServiceClientConnectionDisconnectedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageBlobCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageBlobCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageBlobDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageBlobDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageDirectoryCreatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageDirectoryCreatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageDirectoryDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageDirectoryDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageBlobRenamedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageBlobRenamedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageDirectoryRenamedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageDirectoryRenamedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageLifecyclePolicyCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageLifecyclePolicyCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageLifecyclePolicyActionSummaryDetail, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageLifecyclePolicyActionSummaryDetail, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageBlobTierChangedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageBlobTierChangedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageAsyncOperationInitiatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageAsyncOperationInitiatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageBlobInventoryPolicyCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageBlobInventoryPolicyCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageTaskCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageTaskCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageTaskQueuedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageTaskQueuedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentQueuedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentQueuedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AppEventTypeDetail, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AppEventTypeDetail, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.WebAppUpdatedEventData, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.WebAppUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebBackupOperationStartedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebBackupOperationStartedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebBackupOperationCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebBackupOperationCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebBackupOperationFailedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebBackupOperationFailedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebRestoreOperationStartedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebRestoreOperationStartedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebRestoreOperationCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebRestoreOperationCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebRestoreOperationFailedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebRestoreOperationFailedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebSlotSwapStartedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebSlotSwapStartedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebSlotSwapCompletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebSlotSwapCompletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebSlotSwapFailedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebSlotSwapFailedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebSlotSwapWithPreviewStartedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebSlotSwapWithPreviewStartedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebSlotSwapWithPreviewCancelledEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebSlotSwapWithPreviewCancelledEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebAppServicePlanUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebAppServicePlanUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AppServicePlanEventTypeDetail, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AppServicePlanEventTypeDetail, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.WebAppServicePlanUpdatedEventDataSku, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.WebAppServicePlanUpdatedEventDataSku, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceUpdatedDetails, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceUpdatedDetails, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsOperationalDetails, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsOperationalDetails, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsHealthResourcesAnnotatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsHealthResourcesAnnotatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceManagementCreatedOrUpdatedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceManagementCreatedOrUpdatedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceManagementDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceManagementDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceDeletedEventData, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceDeletedEventData, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceDeletedDetails, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceDeletedDetails, - Access.public -); -// Enums -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterJobStatus, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterJobStatus, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.recordingContentType, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.recordingContentType, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.recordingChannelType, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.recordingChannelType, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.recordingFormatType, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.recordingFormatType, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterLabelOperator, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterLabelOperator, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerSelectorState, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsRouterWorkerSelectorState, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportStatus, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportStatus, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AcsUserEngagement, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AcsUserEngagement, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.CommunicationCloudEnvironmentModel, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.CommunicationCloudEnvironmentModel, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.DataBoxStageName, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.DataBoxStageName, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientState, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientState, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientDisconnectionReason, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.EventGridMQTTClientDisconnectionReason, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceType, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceType, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobState, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobState, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobErrorCode, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobErrorCode, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobErrorCategory, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobErrorCategory, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.MediaJobRetry, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.MediaJobRetry, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentCompletedStatus, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentCompletedStatus, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.StorageTaskCompletedStatus, - Usage.output -); -@@access(Microsoft.EventGrid.SystemEvents.StorageTaskCompletedStatus, - Access.public -); -@@usage(Microsoft.EventGrid.SystemEvents.AppAction, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AppAction, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.StampKind, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.StampKind, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.AppServicePlanAction, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AppServicePlanAction, Access.public); -@@usage(Microsoft.EventGrid.SystemEvents.AsyncStatus, Usage.output); -@@access(Microsoft.EventGrid.SystemEvents.AsyncStatus, Access.public); +import "./Microsoft.ApiCenter/client.tsp"; +import "./Microsoft.ApiManagement/client.tsp"; +import "./Microsoft.AppConfiguration/client.tsp"; +import "./Microsoft.AVS/client.tsp"; +import "./Microsoft.Cache/client.tsp"; +import "./Microsoft.Communication/client.tsp"; +import "./Microsoft.ContainerRegistry/client.tsp"; +import "./Microsoft.ContainerService/client.tsp"; +import "./Microsoft.DataBox/client.tsp"; +import "./Microsoft.Devices/client.tsp"; +import "./Microsoft.EventGrid/client.tsp"; +import "./Microsoft.EventHub/client.tsp"; +import "./Microsoft.HealthcareApis/client.tsp"; +import "./Microsoft.KeyVault/client.tsp"; +import "./Microsoft.MachineLearningServices/client.tsp"; +import "./Microsoft.Maps/client.tsp"; +import "./Microsoft.Media/client.tsp"; +import "./Microsoft.PolicyInsights/client.tsp"; +import "./Microsoft.ResourceNotifications/client.tsp"; +import "./Microsoft.Resources/client.tsp"; +import "./Microsoft.ServiceBus/client.tsp"; +import "./Microsoft.SignalRService/client.tsp"; +import "./Microsoft.Storage/client.tsp"; +import "./Microsoft.Web/client.tsp"; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/main.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/main.tsp index 5a7752667ea0..89ed7f761fd4 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/main.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/main.tsp @@ -1,28 +1,29 @@ import "@typespec/versioning"; -import "./ApiManagement.tsp"; -import "./AppConfiguration.tsp"; -import "./AVS.tsp"; -import "./AzureCommunicationServices.tsp"; -import "./ContainerRegistry.tsp"; -import "./ContainerService.tsp"; -import "./DataBox.tsp"; -import "./EventHub.tsp"; -import "./Maps.tsp"; -import "./IotHub.tsp"; -import "./HealthcareApis.tsp"; -import "./KeyVault.tsp"; -import "./MachineLearningServices.tsp"; -import "./MediaServices.tsp"; -import "./PolicyInsights.tsp"; -import "./RedisCache.tsp"; -import "./Resources.tsp"; -import "./ServiceBus.tsp"; -import "./SignalRService.tsp"; -import "./Storage.tsp"; -import "./Web.tsp"; -import "./EventGrid.tsp"; -import "./ResourceNotifications.tsp"; +import "./Microsoft.ApiCenter/ApiCenter.tsp"; +import "./Microsoft.ApiManagement/ApiManagement.tsp"; +import "./Microsoft.AppConfiguration/AppConfiguration.tsp"; +import "./Microsoft.AVS/AVS.tsp"; +import "./Microsoft.Communication/AzureCommunicationServices.tsp"; +import "./Microsoft.ContainerRegistry/ContainerRegistry.tsp"; +import "./Microsoft.ContainerService/ContainerService.tsp"; +import "./Microsoft.DataBox/DataBox.tsp"; +import "./Microsoft.EventHub/EventHub.tsp"; +import "./Microsoft.Maps/Maps.tsp"; +import "./Microsoft.Devices/IotHub.tsp"; +import "./Microsoft.HealthcareApis/HealthcareApis.tsp"; +import "./Microsoft.KeyVault/KeyVault.tsp"; +import "./Microsoft.MachineLearningServices/MachineLearningServices.tsp"; +import "./Microsoft.Media/MediaServices.tsp"; +import "./Microsoft.PolicyInsights/PolicyInsights.tsp"; +import "./Microsoft.Cache/RedisCache.tsp"; +import "./Microsoft.Resources/Resources.tsp"; +import "./Microsoft.ServiceBus/ServiceBus.tsp"; +import "./Microsoft.SignalRService/SignalRService.tsp"; +import "./Microsoft.Storage/Storage.tsp"; +import "./Microsoft.Web/Web.tsp"; +import "./Microsoft.EventGrid/EventGrid.tsp"; +import "./Microsoft.ResourceNotifications/ResourceNotifications.tsp"; import "./propertyNameOverride.tsp"; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp index 1752c17d9cb0..1b2b2247d318 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp @@ -1,131 +1,160 @@ -import "./AzureCommunicationServices.tsp"; -import "./EventHub.tsp"; -import "./HealthcareApis.tsp"; -import "./IotHub.tsp"; -import "./ResourceNotifications.tsp"; -import "./Storage.tsp"; -import "./DataBox.tsp"; -import "./EventGrid.tsp"; +import "./Microsoft.Communication/AzureCommunicationServices.tsp"; +import "./Microsoft.EventHub/EventHub.tsp"; +import "./Microsoft.HealthcareApis/HealthcareApis.tsp"; +import "./Microsoft.Devices/IotHub.tsp"; +import "./Microsoft.ResourceNotifications/ResourceNotifications.tsp"; +import "./Microsoft.Storage/Storage.tsp"; +import "./Microsoft.DataBox/DataBox.tsp"; +import "./Microsoft.EventGrid/EventGrid.tsp"; +import "./propertyNameOverrideGo.tsp"; +import "./propertyNameOverrideCsharp.tsp"; +import "./propertyNameOverrideJs.tsp"; import "@azure-tools/typespec-client-generator-core"; +using Microsoft.EventGrid.SystemEvents; using Azure.ClientGenerator.Core; -@@clientName(Microsoft.EventGrid.SystemEvents.AcsIncomingCallEventData.to, +@@clientName(AcsIncomingCallEventData.to, "toCommunicationIdentifier", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.AcsIncomingCallEventData.from, +@@clientName(AcsIncomingCallEventData.from, "fromCommunicationIdentifier", "autorest" ); +@@clientName(AcsRouterWorkerSelector.value, "labelValue", "autorest"); -@@clientName(Microsoft.EventGrid.SystemEvents.AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, +@@clientName(AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, "deliveryAttemptTimestamp", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, +@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, "userActionTimestamp", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.AcsEmailEngagementTrackingReportReceivedEventData.engagementType, +@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.engagementType, "engagement", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.EventHubCaptureFileCreatedEventData.fileUrl, +@@clientName(EventHubCaptureFileCreatedEventData.fileUrl, "fileurl", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceCreatedEventData.resourceFhirAccount, +@@clientName(HealthcareFhirResourceCreatedEventData.resourceFhirAccount, "FhirServiceHostName", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceCreatedEventData.resourceFhirId, +@@clientName(HealthcareFhirResourceCreatedEventData.resourceFhirId, "FhirResourceId", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceCreatedEventData.resourceVersionId, +@@clientName(HealthcareFhirResourceCreatedEventData.resourceVersionId, "FhirResourceVersionId", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceCreatedEventData.resourceType, +@@clientName(HealthcareFhirResourceCreatedEventData.resourceType, "FhirResourceType", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceUpdatedEventData.resourceFhirAccount, +@@clientName(HealthcareFhirResourceUpdatedEventData.resourceFhirAccount, "FhirServiceHostName", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceUpdatedEventData.resourceFhirId, +@@clientName(HealthcareFhirResourceUpdatedEventData.resourceFhirId, "FhirResourceId", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceUpdatedEventData.resourceVersionId, +@@clientName(HealthcareFhirResourceUpdatedEventData.resourceVersionId, "FhirResourceVersionId", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceUpdatedEventData.resourceType, +@@clientName(HealthcareFhirResourceUpdatedEventData.resourceType, "FhirResourceType", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceDeletedEventData.resourceFhirAccount, +@@clientName(HealthcareFhirResourceDeletedEventData.resourceFhirAccount, "FhirServiceHostName", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceDeletedEventData.resourceFhirId, +@@clientName(HealthcareFhirResourceDeletedEventData.resourceFhirId, "FhirResourceId", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceDeletedEventData.resourceVersionId, +@@clientName(HealthcareFhirResourceDeletedEventData.resourceVersionId, "FhirResourceVersionId", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.HealthcareFhirResourceDeletedEventData.resourceType, +@@clientName(HealthcareFhirResourceDeletedEventData.resourceType, "FhirResourceType", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.DeviceTwinMetadata.lastUpdated, - "$lastUpdated", - "autorest" -); -@@clientName(Microsoft.EventGrid.SystemEvents.DeviceTwinProperties.metadata, - "$metadata", - "autorest" -); -@@clientName(Microsoft.EventGrid.SystemEvents.DeviceTwinProperties.version, - "$version", - "autorest" -); +@@clientName(DeviceTwinMetadata.lastUpdated, "$lastUpdated", "autorest"); +@@clientName(DeviceTwinProperties.metadata, "$metadata", "autorest"); +@@clientName(DeviceTwinProperties.version, "$version", "autorest"); -@@clientName(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceUpdatedEventData.resourceInfo, +@@clientName(ResourceNotificationsResourceUpdatedEventData.resourceInfo, "resourceDetails", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceUpdatedEventData.operationalInfo, +@@clientName(ResourceNotificationsResourceUpdatedEventData.operationalInfo, "operationalDetails", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceDeletedEventData.resourceInfo, +@@clientName(ResourceNotificationsResourceDeletedEventData.resourceInfo, "resourceDetails", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.ResourceNotificationsResourceDeletedEventData.operationalInfo, +@@clientName(ResourceNotificationsResourceDeletedEventData.operationalInfo, "operationalDetails", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentQueuedEventData.queuedDateTime, +@@clientName(StorageTaskAssignmentQueuedEventData.queuedDateTime, "queuedOn", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentCompletedEventData.completedDateTime, +@@clientName(StorageTaskAssignmentCompletedEventData.completedDateTime, "completedOn", "autorest" ); -@@clientName(Microsoft.EventGrid.SystemEvents.StorageTaskAssignmentCompletedEventData.summaryReportBlobUrl, +@@clientName(StorageTaskAssignmentCompletedEventData.summaryReportBlobUrl, "summaryReportBlobUri", "autorest" ); + +@@clientName(AcsMessageDeliveryStatusUpdatedEventData.channelType, + "channelKind", + "autorest" +); + +@@clientName(AcsMessageReceivedEventData.channelType, + "channelKind", + "autorest" +); + +@@clientName(AcsMessageReceivedEventData.media, "mediaContent", "autorest"); + +@@clientName(AcsMessageReceivedEventData.interactive, + "interactiveContent", + "autorest" +); + +@@clientName(AcsMessageMediaContent.id, "mediaId", "autorest"); + +@@clientName(AcsMessageContext.id, "messageId", "autorest"); + +@@clientName(AcsMessageInteractiveContent.type, "replyKind", "autorest"); + +@@clientName(AcsMessageInteractiveButtonReplyContent.id, + "buttonId", + "autorest" +); + +@@clientName(AcsMessageInteractiveListReplyContent.id, + "listItemId", + "autorest" +); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp new file mode 100644 index 000000000000..60933e665420 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp @@ -0,0 +1,206 @@ +import "./Microsoft.Communication/AzureCommunicationServices.tsp"; +import "./Microsoft.EventHub/EventHub.tsp"; +import "./Microsoft.HealthcareApis/HealthcareApis.tsp"; +import "./Microsoft.Devices/IotHub.tsp"; +import "./Microsoft.ResourceNotifications/ResourceNotifications.tsp"; +import "./Microsoft.Storage/Storage.tsp"; +import "./Microsoft.DataBox/DataBox.tsp"; +import "./Microsoft.EventGrid/EventGrid.tsp"; +import "./Microsoft.Media/MediaServices.tsp"; +import "./Microsoft.AVS/AVS.tsp"; + +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using Microsoft.EventGrid.SystemEvents; + +@@clientName(AcsIncomingCallEventData.to, + "toCommunicationIdentifier", + "csharp" +); +@@clientName(AcsIncomingCallEventData.from, + "fromCommunicationIdentifier", + "csharp" +); + +@@clientName(AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, + "deliveryAttemptTimestamp", + "csharp" +); +@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, + "userActionTimestamp", + "csharp" +); +@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.engagementType, + "engagement", + "csharp" +); + +@@clientName(EventHubCaptureFileCreatedEventData.fileUrl, "fileurl", "csharp"); + +@@clientName(HealthcareFhirResourceCreatedEventData.resourceFhirAccount, + "FhirServiceHostName", + "csharp" +); +@@clientName(HealthcareFhirResourceCreatedEventData.resourceFhirId, + "FhirResourceId", + "csharp" +); +@@clientName(HealthcareFhirResourceCreatedEventData.resourceVersionId, + "FhirResourceVersionId", + "csharp" +); +@@clientName(HealthcareFhirResourceCreatedEventData.resourceType, + "FhirResourceType", + "csharp" +); +@@clientName(HealthcareFhirResourceUpdatedEventData.resourceFhirAccount, + "FhirServiceHostName", + "csharp" +); +@@clientName(HealthcareFhirResourceUpdatedEventData.resourceFhirId, + "FhirResourceId", + "csharp" +); +@@clientName(HealthcareFhirResourceUpdatedEventData.resourceVersionId, + "FhirResourceVersionId", + "csharp" +); +@@clientName(HealthcareFhirResourceUpdatedEventData.resourceType, + "FhirResourceType", + "csharp" +); +@@clientName(HealthcareFhirResourceDeletedEventData.resourceFhirAccount, + "FhirServiceHostName", + "csharp" +); +@@clientName(HealthcareFhirResourceDeletedEventData.resourceFhirId, + "FhirResourceId", + "csharp" +); +@@clientName(HealthcareFhirResourceDeletedEventData.resourceVersionId, + "FhirResourceVersionId", + "csharp" +); +@@clientName(HealthcareFhirResourceDeletedEventData.resourceType, + "FhirResourceType", + "csharp" +); + +@@clientName(DeviceTwinMetadata.lastUpdated, "$lastUpdated", "csharp"); +@@clientName(DeviceTwinProperties.metadata, "$metadata", "csharp"); +@@clientName(DeviceTwinProperties.version, "$version", "csharp"); + +@@clientName(ResourceNotificationsResourceUpdatedEventData.resourceInfo, + "resourceDetails", + "csharp" +); +@@clientName(ResourceNotificationsResourceUpdatedEventData.operationalInfo, + "operationalDetails", + "csharp" +); +@@clientName(ResourceNotificationsResourceDeletedEventData.resourceInfo, + "resourceDetails", + "csharp" +); +@@clientName(ResourceNotificationsResourceDeletedEventData.operationalInfo, + "operationalDetails", + "csharp" +); + +@@clientName(StorageTaskAssignmentQueuedEventData.queuedDateTime, + "queuedOn", + "csharp" +); +@@clientName(StorageTaskAssignmentCompletedEventData.completedDateTime, + "completedOn", + "csharp" +); +@@clientName(StorageTaskAssignmentCompletedEventData.summaryReportBlobUrl, + "summaryReportBlobUri", + "csharp" +); + +@@clientName(AcsMessageDeliveryStatusUpdatedEventData.channelType, + "channelKind", + "csharp" +); + +@@clientName(AcsMessageReceivedEventData.channelType, "channelKind", "csharp"); + +@@clientName(AcsMessageReceivedEventData.media, "mediaContent", "csharp"); + +@@clientName(AcsMessageReceivedEventData.interactive, + "interactiveContent", + "csharp" +); + +@@clientName(AcsMessageMediaContent.id, "mediaId", "csharp"); + +@@clientName(AcsMessageContext.id, "messageId", "csharp"); + +@@clientName(AcsMessageInteractiveContent.type, "replyKind", "csharp"); + +@@clientName(AcsMessageInteractiveButtonReplyContent.id, "buttonId", "csharp"); + +@@clientName(AcsMessageInteractiveListReplyContent.id, "listItemId", "csharp"); + +@@clientName(ResourceNotificationsHealthResourcesAnnotatedEventData.resourceInfo, + "ResourceDetails", + "csharp" +); +@@clientName(ResourceNotificationsHealthResourcesAnnotatedEventData.operationalInfo, + "OperationalDetails", + "csharp" +); + +@@clientName(ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData.resourceInfo, + "ResourceDetails", + "csharp" +); +@@clientName(ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData.operationalInfo, + "OperationalDetails", + "csharp" +); + +@@clientName(ResourceNotificationsResourceManagementCreatedOrUpdatedEventData.resourceInfo, + "ResourceDetails", + "csharp" +); +@@clientName(ResourceNotificationsResourceManagementCreatedOrUpdatedEventData.operationalInfo, + "OperationalDetails", + "csharp" +); +@@clientName(ResourceNotificationsResourceManagementDeletedEventData.resourceInfo, + "ResourceDetails", + "csharp" +); + +@@clientName(ResourceNotificationsResourceManagementDeletedEventData.operationalInfo, + "OperationalDetails", + "csharp" +); + +@@clientName(AcsMessageDeliveryStatusUpdatedEventData.receivedTimeStamp, + "receivedTimestamp", + "csharp" +); + +@@clientName(AcsMessageEventData.receivedTimeStamp, + "receivedTimestamp", + "csharp" +); + +@@clientName(AcsMessageReceivedEventData.receivedTimeStamp, + "receivedTimestamp", + "csharp" +); + +@@clientName(AcsRecordingFileStatusUpdatedEventData.recordingChannelType, + "recordingChannelKind", + "csharp" +); + +@@clientName(AcsRouterWorkerSelector.state, "SelectorState", "csharp"); +@@clientName(AcsRouterWorkerSelector.ttlSeconds, "TimeToLive", "csharp"); +@@clientName(AcsRouterWorkerSelector.value, "labelValue", "csharp"); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideGo.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideGo.tsp new file mode 100644 index 000000000000..3f1332b43f72 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideGo.tsp @@ -0,0 +1,592 @@ +import "./Microsoft.Communication/AzureCommunicationServices.tsp"; +import "./Microsoft.EventHub/EventHub.tsp"; +import "./Microsoft.HealthcareApis/HealthcareApis.tsp"; +import "./Microsoft.Devices/IotHub.tsp"; +import "./Microsoft.ResourceNotifications/ResourceNotifications.tsp"; +import "./Microsoft.Storage/Storage.tsp"; +import "./Microsoft.DataBox/DataBox.tsp"; +import "./Microsoft.EventGrid/EventGrid.tsp"; +import "./Microsoft.Media/MediaServices.tsp"; +import "./Microsoft.AVS/AVS.tsp"; + +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using Microsoft.EventGrid.SystemEvents; + +// [BEGIN] misc renames + +@@clientName(MediaLiveEventChannelArchiveHeartbeatEventData.channelLatencyMs, + "ChannelLatencyMS", + "go" +); + +@@clientName(AcsRecordingFileStatusUpdatedEventData.recordingDurationMs, + "RecordingDurationMS", + "go" +); + +@@clientName(EventHubCaptureFileCreatedEventData.fileUrl, "FileURL", "go"); + +@@clientName(StorageTaskAssignmentCompletedEventData.completedDateTime, + "CompletedOn", + "go" +); +@@clientName(StorageTaskAssignmentCompletedEventData.summaryReportBlobUrl, + "SummaryReportBlobURI", + "go" +); + +@@clientName(StorageTaskAssignmentQueuedEventData.queuedDateTime, + "QueuedOn", + "go" +); + +// [END] misc renames + +// [BEGIN] ResourceNotifications Info -> Details renames + +@@clientName(ResourceNotificationsHealthResourcesAnnotatedEventData.resourceInfo, + "ResourceDetails", + "go" +); +@@clientName(ResourceNotificationsHealthResourcesAnnotatedEventData.operationalInfo, + "OperationalDetails", + "go" +); + +@@clientName(ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData.resourceInfo, + "ResourceDetails", + "go" +); +@@clientName(ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData.operationalInfo, + "OperationalDetails", + "go" +); + +@@clientName(ResourceNotificationsResourceDeletedEventData.resourceInfo, + "ResourceDetails", + "go" +); +@@clientName(ResourceNotificationsResourceDeletedEventData.operationalInfo, + "OperationalDetails", + "go" +); + +@@clientName(ResourceNotificationsResourceManagementCreatedOrUpdatedEventData.resourceInfo, + "ResourceDetails", + "go" +); +@@clientName(ResourceNotificationsResourceManagementCreatedOrUpdatedEventData.operationalInfo, + "OperationalDetails", + "go" +); +@@clientName(ResourceNotificationsResourceManagementDeletedEventData.resourceInfo, + "ResourceDetails", + "go" +); + +@@clientName(ResourceNotificationsResourceManagementDeletedEventData.operationalInfo, + "OperationalDetails", + "go" +); + +@@clientName(ResourceNotificationsResourceUpdatedEventData.resourceInfo, + "ResourceDetails", + "go" +); +@@clientName(ResourceNotificationsResourceUpdatedEventData.operationalInfo, + "OperationalDetails", + "go" +); + +// [END] ResourceNotifications Info -> Details renames + +// [BEGIN] AVS fixes. + +@@clientName(AvsClusterCreatedEventData, "AVSClusterCreatedEventData", "go"); +@@clientName(AvsClusterDeletedEventData, "AVSClusterDeletedEventData", "go"); +@@clientName(AvsClusterEventData, "AVSClusterEventData", "go"); +@@clientName(AvsClusterFailedEventData, "AVSClusterFailedEventData", "go"); +@@clientName(AvsClusterUpdatedEventData, "AVSClusterUpdatedEventData", "go"); +@@clientName(AvsClusterUpdatingEventData, "AVSClusterUpdatingEventData", "go"); +@@clientName(AvsPrivateCloudEventData, "AVSPrivateCloudEventData", "go"); +@@clientName(AvsPrivateCloudFailedEventData, + "AVSPrivateCloudFailedEventData", + "go" +); +@@clientName(AvsPrivateCloudUpdatedEventData, + "AVSPrivateCloudUpdatedEventData", + "go" +); +@@clientName(AvsPrivateCloudUpdatingEventData, + "AVSPrivateCloudUpdatingEventData", + "go" +); +@@clientName(AvsScriptExecutionCancelledEventData, + "AVSScriptExecutionCancelledEventData", + "go" +); +@@clientName(AvsScriptExecutionEventData, "AVSScriptExecutionEventData", "go"); +@@clientName(AvsScriptExecutionFailedEventData, + "AVSScriptExecutionFailedEventData", + "go" +); +@@clientName(AvsScriptExecutionFinishedEventData, + "AVSScriptExecutionFinishedEventData", + "go" +); +@@clientName(AvsScriptExecutionStartedEventData, + "AVSScriptExecutionStartedEventData", + "go" +); + +// [END] AVS fixes. + +// [BEGIN] IOT renames + +@@clientName(IotHubDeviceConnectedEventData, + "IOTHubDeviceConnectedEventData", + "go" +); +@@clientName(IotHubDeviceCreatedEventData, + "IOTHubDeviceCreatedEventData", + "go" +); +@@clientName(IotHubDeviceDeletedEventData, + "IOTHubDeviceDeletedEventData", + "go" +); +@@clientName(IotHubDeviceDisconnectedEventData, + "IOTHubDeviceDisconnectedEventData", + "go" +); +@@clientName(IotHubDeviceTelemetryEventData, + "IOTHubDeviceTelemetryEventData", + "go" +); + +// [END] IOT renames + +// [BEGIN] Healthcare renames + +@@clientName(HealthcareFhirResourceCreatedEventData, + "HealthcareFHIRResourceCreatedEventData", + "go" +); +@@clientName(HealthcareFhirResourceDeletedEventData, + "HealthcareFHIRResourceDeletedEventData", + "go" +); +@@clientName(HealthcareFhirResourceUpdatedEventData, + "HealthcareFHIRResourceUpdatedEventData", + "go" +); + +@@clientName(HealthcareFhirResourceCreatedEventData.resourceFhirAccount, + "FHIRServiceHostName", + "go" +); +@@clientName(HealthcareFhirResourceCreatedEventData.resourceFhirId, + "FHIRResourceID", + "go" +); +@@clientName(HealthcareFhirResourceCreatedEventData.resourceVersionId, + "FHIRResourceVersionID", + "go" +); +@@clientName(HealthcareFhirResourceCreatedEventData.resourceType, + "FHIRResourceType", + "go" +); +@@clientName(HealthcareFhirResourceUpdatedEventData.resourceFhirAccount, + "FHIRServiceHostName", + "go" +); +@@clientName(HealthcareFhirResourceUpdatedEventData.resourceFhirId, + "FHIRResourceId", + "go" +); +@@clientName(HealthcareFhirResourceUpdatedEventData.resourceVersionId, + "FHIRResourceVersionID", + "go" +); +@@clientName(HealthcareFhirResourceUpdatedEventData.resourceType, + "FHIRResourceType", + "go" +); +@@clientName(HealthcareFhirResourceDeletedEventData.resourceFhirAccount, + "FHIRServiceHostName", + "go" +); +@@clientName(HealthcareFhirResourceDeletedEventData.resourceFhirId, + "FHIRResourceID", + "go" +); +@@clientName(HealthcareFhirResourceDeletedEventData.resourceVersionId, + "FHIRResourceVersionID", + "go" +); +@@clientName(HealthcareFhirResourceDeletedEventData.resourceType, + "FHIRResourceType", + "go" +); + +// [END] Healthcare renames + +// [BEGIN] ACS renames (and acronym casing) + +@@clientName(AcsChatEventBaseProperties, "ACSChatEventBaseProperties", "go"); +@@clientName(AcsChatEventInThreadBaseProperties, + "ACSChatEventInThreadBaseProperties", + "go" +); +@@clientName(AcsChatMessageDeletedEventData, + "ACSChatMessageDeletedEventData", + "go" +); +@@clientName(AcsChatMessageDeletedInThreadEventData, + "ACSChatMessageDeletedInThreadEventData", + "go" +); +@@clientName(AcsChatMessageEditedEventData, + "ACSChatMessageEditedEventData", + "go" +); +@@clientName(AcsChatMessageEditedInThreadEventData, + "ACSChatMessageEditedInThreadEventData", + "go" +); +@@clientName(AcsChatMessageEventBaseProperties, + "ACSChatMessageEventBaseProperties", + "go" +); +@@clientName(AcsChatMessageEventInThreadBaseProperties, + "ACSChatMessageEventInThreadBaseProperties", + "go" +); +@@clientName(AcsChatMessageReceivedEventData, + "ACSChatMessageReceivedEventData", + "go" +); +@@clientName(AcsChatMessageReceivedEventData, + "ACSChatMessageReceivedEventData", + "go" +); +@@clientName(AcsChatMessageReceivedInThreadEventData, + "ACSChatMessageReceivedInThreadEventData", + "go" +); +@@clientName(AcsChatParticipantAddedToThreadEventData, + "ACSChatParticipantAddedToThreadEventData", + "go" +); +@@clientName(AcsChatParticipantAddedToThreadWithUserEventData, + "ACSChatParticipantAddedToThreadWithUserEventData", + "go" +); +@@clientName(AcsChatParticipantRemovedFromThreadEventData, + "ACSChatParticipantRemovedFromThreadEventData", + "go" +); +@@clientName(AcsChatParticipantRemovedFromThreadWithUserEventData, + "ACSChatParticipantRemovedFromThreadWithUserEventData", + "go" +); +@@clientName(AcsChatThreadCreatedEventData, + "ACSChatThreadCreatedEventData", + "go" +); +@@clientName(AcsChatThreadCreatedWithUserEventData, + "ACSChatThreadCreatedWithUserEventData", + "go" +); +@@clientName(AcsChatThreadDeletedEventData, + "ACSChatThreadDeletedEventData", + "go" +); +@@clientName(AcsChatThreadEventBaseProperties, + "ACSChatThreadEventBaseProperties", + "go" +); +@@clientName(AcsChatThreadEventInThreadBaseProperties, + "ACSChatThreadEventInThreadBaseProperties", + "go" +); +@@clientName(AcsChatThreadParticipantProperties, + "ACSChatThreadParticipantProperties", + "go" +); +@@clientName(AcsChatThreadPropertiesUpdatedEventData, + "ACSChatThreadPropertiesUpdatedEventData", + "go" +); +@@clientName(AcsChatThreadPropertiesUpdatedPerUserEventData, + "ACSChatThreadPropertiesUpdatedPerUserEventData", + "go" +); +@@clientName(AcsChatThreadWithUserDeletedEventData, + "ACSChatThreadWithUserDeletedEventData", + "go" +); +@@clientName(AcsEmailDeliveryReportReceivedEventData, + "ACSEmailDeliveryReportReceivedEventData", + "go" +); +@@clientName(AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, + "DeliveryAttemptTimestamp", + "go" +); + +@@clientName(AcsEmailDeliveryReportStatus, + "ACSEmailDeliveryReportStatus", + "go" +); +@@clientName(AcsEmailDeliveryReportStatusDetails, + "ACSEmailDeliveryReportStatusDetails", + "go" +); + +@@clientName(AcsEmailEngagementTrackingReportReceivedEventData, + "ACSEmailEngagementTrackingReportReceivedEventData", + "go" +); +@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.engagementType, + "Engagement", + "go" +); +@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, + "UserActionTimestamp", + "go" +); + +@@clientName(AcsIncomingCallCustomContext, + "ACSIncomingCallCustomContext", + "go" +); + +@@clientName(AcsIncomingCallEventData, "ACSIncomingCallEventData", "go"); +@@clientName(AcsIncomingCallEventData.from, + "FromCommunicationIdentifier", + "go" +); +@@clientName(AcsIncomingCallEventData.to, "ToCommunicationIdentifier", "go"); + +@@clientName(AcsInteractiveReplyKind, "ACSInteractiveReplyKind", "go"); +@@clientName(AcsMessageButtonContent, "ACSMessageButtonContent", "go"); + +// we expose a custom error type and use this internally. +@@clientName(AcsMessageChannelEventError, + "internalACSMessageChannelEventError", + "go" +); +@@access(AcsMessageChannelEventError, Access.internal, "go"); + +@@clientName(AcsMessageChannelKind, "ACSMessageChannelKind", "go"); + +@@clientName(AcsMessageContext, "ACSMessageContext", "go"); +@@clientName(AcsMessageContext.id, "MessageID", "go"); + +@@clientName(AcsMessageDeliveryStatus, "ACSMessageDeliveryStatus", "go"); + +@@clientName(AcsMessageDeliveryStatusUpdatedEventData, + "ACSMessageDeliveryStatusUpdatedEventData", + "go" +); +@@clientName(AcsMessageDeliveryStatusUpdatedEventData.channelType, + "ChannelKind", + "go" +); +@@clientName(AcsMessageDeliveryStatusUpdatedEventData.receivedTimeStamp, + "ReceivedTimestamp", + "go" +); + +@@clientName(AcsMessageEventData, "ACSMessageEventData", "go"); +@@clientName(AcsMessageEventData.receivedTimeStamp, "ReceivedTimestamp", "go"); + +@@clientName(AcsMessageInteractiveButtonReplyContent, + "ACSMessageInteractiveButtonReplyContent", + "go" +); +@@clientName(AcsMessageInteractiveButtonReplyContent.id, "ButtonID", "go"); + +@@clientName(AcsMessageInteractiveContent, + "ACSMessageInteractiveContent", + "go" +); +@@clientName(AcsMessageInteractiveContent.type, "ReplyKind", "go"); + +@@clientName(AcsMessageInteractiveListReplyContent.id, "ListItemID", "go"); +@@clientName(AcsMessageInteractiveListReplyContent, + "ACSMessageInteractiveListReplyContent", + "go" +); + +@@clientName(AcsMessageMediaContent, "ACSMessageMediaContent", "go"); +@@clientName(AcsMessageMediaContent.id, "MediaID", "go"); + +@@clientName(AcsMessageReceivedEventData, "ACSMessageReceivedEventData", "go"); +@@clientName(AcsMessageReceivedEventData.channelType, "ChannelKind", "go"); +@@clientName(AcsMessageReceivedEventData.interactive, + "InteractiveContent", + "go" +); +@@clientName(AcsMessageReceivedEventData.media, "MediaContent", "go"); +@@clientName(AcsMessageReceivedEventData.receivedTimeStamp, + "ReceivedTimestamp", + "go" +); + +@@clientName(AcsRecordingChunkInfoProperties, + "ACSRecordingChunkInfoProperties", + "go" +); + +@@clientName(AcsRecordingFileStatusUpdatedEventData, + "ACSRecordingFileStatusUpdatedEventData", + "go" +); + +@@clientName(recordingChannelType, "recordingChannelKind", "go"); + +@@clientName(AcsRecordingFileStatusUpdatedEventData.recordingChannelType, + "recordingChannelKind", + "go" +); + +@@clientName(AcsRecordingStorageInfoProperties, + "ACSRecordingStorageInfoProperties", + "go" +); +@@clientName(AcsRouterChannelConfiguration, + "ACSRouterChannelConfiguration", + "go" +); + +// we expose a custom error type and use this internally. +@@clientName(AcsRouterCommunicationError, + "internalACSRouterCommunicationError", + "go" +); +@@access(AcsRouterCommunicationError, Access.internal, "go"); + +@@clientName(AcsRouterEventData, "ACSRouterEventData", "go"); +@@clientName(AcsRouterJobCancelledEventData, + "ACSRouterJobCancelledEventData", + "go" +); +@@clientName(AcsRouterJobClassificationFailedEventData, + "ACSRouterJobClassificationFailedEventData", + "go" +); +@@clientName(AcsRouterJobClassifiedEventData, + "ACSRouterJobClassifiedEventData", + "go" +); +@@clientName(AcsRouterJobClosedEventData, "ACSRouterJobClosedEventData", "go"); +@@clientName(AcsRouterJobCompletedEventData, + "ACSRouterJobCompletedEventData", + "go" +); +@@clientName(AcsRouterJobDeletedEventData, + "ACSRouterJobDeletedEventData", + "go" +); +@@clientName(AcsRouterJobEventData, "ACSRouterJobEventData", "go"); +@@clientName(AcsRouterJobExceptionTriggeredEventData, + "ACSRouterJobExceptionTriggeredEventData", + "go" +); +@@clientName(AcsRouterJobQueuedEventData, "ACSRouterJobQueuedEventData", "go"); +@@clientName(AcsRouterJobReceivedEventData, + "ACSRouterJobReceivedEventData", + "go" +); +@@clientName(AcsRouterJobSchedulingFailedEventData, + "ACSRouterJobSchedulingFailedEventData", + "go" +); +@@clientName(AcsRouterJobStatus, "ACSRouterJobStatus", "go"); +@@clientName(AcsRouterJobUnassignedEventData, + "ACSRouterJobUnassignedEventData", + "go" +); +@@clientName(AcsRouterJobWaitingForActivationEventData, + "ACSRouterJobWaitingForActivationEventData", + "go" +); +@@clientName(AcsRouterJobWorkerSelectorsExpiredEventData, + "ACSRouterJobWorkerSelectorsExpiredEventData", + "go" +); +@@clientName(AcsRouterLabelOperator, "ACSRouterLabelOperator", "go"); +@@clientName(AcsRouterQueueDetails, "ACSRouterQueueDetails", "go"); +@@clientName(AcsRouterUpdatedWorkerProperty, + "ACSRouterUpdatedWorkerProperty", + "go" +); +@@clientName(AcsRouterWorkerDeletedEventData, + "ACSRouterWorkerDeletedEventData", + "go" +); +@@clientName(AcsRouterWorkerDeregisteredEventData, + "ACSRouterWorkerDeregisteredEventData", + "go" +); +@@clientName(AcsRouterWorkerEventData, "ACSRouterWorkerEventData", "go"); +@@clientName(AcsRouterWorkerOfferAcceptedEventData, + "ACSRouterWorkerOfferAcceptedEventData", + "go" +); +@@clientName(AcsRouterWorkerOfferDeclinedEventData, + "ACSRouterWorkerOfferDeclinedEventData", + "go" +); +@@clientName(AcsRouterWorkerOfferExpiredEventData, + "ACSRouterWorkerOfferExpiredEventData", + "go" +); +@@clientName(AcsRouterWorkerOfferIssuedEventData, + "ACSRouterWorkerOfferIssuedEventData", + "go" +); +@@clientName(AcsRouterWorkerOfferRevokedEventData, + "ACSRouterWorkerOfferRevokedEventData", + "go" +); +@@clientName(AcsRouterWorkerRegisteredEventData, + "ACSRouterWorkerRegisteredEventData", + "go" +); +@@clientName(AcsRouterWorkerSelector, "ACSRouterWorkerSelector", "go"); +@@clientName(AcsRouterWorkerSelector.labelOperator, "Operator", "go"); +@@clientName(AcsRouterWorkerSelector.state, "SelectorState", "go"); +@@clientName(AcsRouterWorkerSelector.ttlSeconds, "TimeToLive", "go"); +@@clientName(AcsRouterWorkerSelector.value, "labelValue", "go"); + +@@clientName(AcsRouterWorkerSelectorState, + "ACSRouterWorkerSelectorState", + "go" +); +@@clientName(AcsRouterWorkerUpdatedEventData, + "ACSRouterWorkerUpdatedEventData", + "go" +); +@@clientName(AcsSmsDeliveryAttemptProperties, + "ACSSmsDeliveryAttemptProperties", + "go" +); +@@clientName(AcsSmsDeliveryReportReceivedEventData, + "ACSSmsDeliveryReportReceivedEventData", + "go" +); +@@clientName(AcsSmsEventBaseProperties, "ACSSmsEventBaseProperties", "go"); +@@clientName(AcsSmsReceivedEventData, "ACSSmsReceivedEventData", "go"); +@@clientName(AcsUserDisconnectedEventData, + "ACSUserDisconnectedEventData", + "go" +); +@@clientName(AcsUserEngagement, "ACSUserEngagement", "go"); + +// [END] ACS renames (and acronym casing) diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJs.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJs.tsp new file mode 100644 index 000000000000..aae89181bef8 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJs.tsp @@ -0,0 +1,167 @@ +import "./Microsoft.Communication/AzureCommunicationServices.tsp"; +import "./Microsoft.EventHub/EventHub.tsp"; +import "./Microsoft.HealthcareApis/HealthcareApis.tsp"; +import "./Microsoft.Devices/IotHub.tsp"; +import "./Microsoft.ResourceNotifications/ResourceNotifications.tsp"; +import "./Microsoft.Storage/Storage.tsp"; +import "./Microsoft.DataBox/DataBox.tsp"; +import "./Microsoft.EventGrid/EventGrid.tsp"; + +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using Microsoft.EventGrid.SystemEvents; + +@@clientName(AcsRouterWorkerSelector.value, "labelValue", "javascript"); +@@clientName(AcsMessageMediaContent.id, "mediaId", "javascript"); +@@clientName(AcsMessageContext.id, "messageId", "javascript"); +@@clientName(AcsMessageInteractiveContent.type, "replyKind", "javascript"); +@@clientName(AcsMessageInteractiveButtonReplyContent.id, + "buttonId", + "javascript" +); +@@clientName(AcsMessageInteractiveListReplyContent.id, + "listItemId", + "javascript" +); +@@clientName(AcsMessageDeliveryStatusUpdatedEventData.channelType, + "channelKind", + "javascript" +); +@@clientName(AcsMessageReceivedEventData.channelType, + "channelKind", + "javascript" +); +@@clientName(AcsMessageReceivedEventData.media, "mediaContent", "javascript"); +@@clientName(AcsMessageReceivedEventData.interactive, + "interactiveContent", + "javascript" +); +@@clientName(AcsIncomingCallEventData.from, + "fromCommunicationIdentifier", + "javascript" +); +@@clientName(AcsIncomingCallEventData.to, + "toCommunicationIdentifier", + "javascript" +); +@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, + "userActionTimestamp", + "javascript" +); +@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.engagementType, + "engagement", + "javascript" +); +@@clientName(StorageTaskAssignmentQueuedEventData.queuedDateTime, + "queuedOn", + "javascript" +); +@@clientName(StorageTaskAssignmentCompletedEventData.completedDateTime, + "completedOn", + "javascript" +); +@@clientName(StorageTaskAssignmentCompletedEventData.summaryReportBlobUrl, + "summaryReportBlobUri", + "javascript" +); +@@clientName(AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, + "deliveryAttemptTimestamp", + "javascript" +); +@@clientName(ResourceNotificationsResourceUpdatedEventData.resourceInfo, + "resourceDetails", + "javascript" +); +@@clientName(ResourceNotificationsResourceUpdatedEventData.operationalInfo, + "operationalDetails", + "javascript" +); +@@clientName(ResourceNotificationsResourceDeletedEventData.resourceInfo, + "resourceDetails", + "javascript" +); +@@clientName(ResourceNotificationsResourceDeletedEventData.operationalInfo, + "operationalDetails", + "javascript" +); +@@clientName(AcsChatEventBaseProperties, "AcsChatEventBase", "javascript"); +@@clientName(AcsChatMessageEventBaseProperties, + "AcsChatMessageEventBase", + "javascript" +); +@@clientName(AcsChatThreadEventBaseProperties, + "AcsChatThreadEventBase", + "javascript" +); +@@clientName(AcsChatEventInThreadBaseProperties, + "AcsChatEventInThreadBase", + "javascript" +); +@@clientName(AcsRecordingStorageInfoProperties, + "AcsRecordingStorageInfo", + "javascript" +); +@@clientName(AcsRecordingChunkInfoProperties, + "AcsRecordingChunkInfo", + "javascript" +); +@@clientName(AcsChatThreadParticipantProperties, + "AcsChatThreadParticipant", + "javascript" +); +@@clientName(AcsSmsDeliveryAttemptProperties, + "AcsSmsDeliveryAttempt", + "javascript" +); +@@clientName(AcsSmsEventBaseProperties, "AcsSmsEventBase", "javascript"); +@@clientName(MapsGeofenceEventProperties, "MapsGeofenceEvent", "javascript"); +@@clientName(DeviceConnectionStateEventProperties, + "DeviceConnectionStateEvent", + "javascript" +); +@@clientName(DeviceLifeCycleEventProperties, + "DeviceLifeCycleEvent", + "javascript" +); +@@clientName(DeviceTelemetryEventProperties, + "DeviceTelemetryEvent", + "javascript" +); +@@clientName(DeviceTwinProperties, "DeviceTwin", "javascript"); +@@clientName(AcsChatThreadEventInThreadBaseProperties, + "AcsChatThreadEventInThreadBase", + "javascript" +); +@@clientName(AcsChatMessageEventInThreadBaseProperties, + "AcsChatMessageEventInThreadBase", + "javascript" +); +@@clientName(EventGridMQTTClientCreatedOrUpdatedEventData, + "EventGridMqttClientCreatedOrUpdatedEventData", + "javascript" +); +@@clientName(EventGridMQTTClientDeletedEventData, + "EventGridMqttClientDeletedEventData", + "javascript" +); +@@clientName(EventGridMQTTClientSessionConnectedEventData, + "EventGridMqttClientSessionConnectedEventData", + "javascript" +); +@@clientName(EventGridMQTTClientSessionDisconnectedEventData, + "EventGridMqttClientSessionDisconnectedEventData", + "javascript" +); +@@clientName(EventGridMQTTClientEventData, + "EventGridMqttClientEventData", + "javascript" +); +@@clientName(EventGridMQTTClientState, + "EventGridMqttClientState", + "javascript" +); +@@clientName(EventGridMQTTClientDisconnectionReason, + "EventGridMqttClientDisconnectionReason", + "javascript" +); diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json index 98ffc0458d1e..292cc198dde2 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json @@ -38,7 +38,10 @@ "type": "string", "description": "The chat thread id" } - } + }, + "required": [ + "recipientCommunicationIdentifier" + ] }, "AcsChatEventInThreadBaseProperties": { "type": "object", @@ -64,6 +67,9 @@ "description": "The time at which the message was deleted" } }, + "required": [ + "deleteTime" + ], "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventBaseProperties" @@ -80,6 +86,9 @@ "description": "The time at which the message was deleted" } }, + "required": [ + "deleteTime" + ], "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" @@ -107,6 +116,10 @@ "description": "The time at which the message was edited" } }, + "required": [ + "metadata", + "editTime" + ], "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventBaseProperties" @@ -134,6 +147,10 @@ "description": "The time at which the message was edited" } }, + "required": [ + "metadata", + "editTime" + ], "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" @@ -171,6 +188,10 @@ "description": "The version of the message" } }, + "required": [ + "senderCommunicationIdentifier", + "composeTime" + ], "allOf": [ { "$ref": "#/definitions/AcsChatEventBaseProperties" @@ -208,6 +229,10 @@ "description": "The version of the message" } }, + "required": [ + "senderCommunicationIdentifier", + "composeTime" + ], "allOf": [ { "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" @@ -230,6 +255,9 @@ } } }, + "required": [ + "metadata" + ], "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventBaseProperties" @@ -252,6 +280,9 @@ } } }, + "required": [ + "metadata" + ], "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" @@ -281,6 +312,11 @@ "description": "The version of the thread" } }, + "required": [ + "time", + "addedByCommunicationIdentifier", + "participantAdded" + ], "allOf": [ { "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" @@ -305,6 +341,11 @@ "description": "The details of the user who was added" } }, + "required": [ + "time", + "addedByCommunicationIdentifier", + "participantAdded" + ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventBaseProperties" @@ -334,6 +375,11 @@ "description": "The version of the thread" } }, + "required": [ + "time", + "removedByCommunicationIdentifier", + "participantRemoved" + ], "allOf": [ { "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" @@ -358,6 +404,11 @@ "description": "The details of the user who was removed" } }, + "required": [ + "time", + "removedByCommunicationIdentifier", + "participantRemoved" + ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventBaseProperties" @@ -393,6 +444,12 @@ "x-ms-identifiers": [] } }, + "required": [ + "createdByCommunicationIdentifier", + "properties", + "metadata", + "participants" + ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" @@ -428,6 +485,12 @@ "x-ms-identifiers": [] } }, + "required": [ + "createdByCommunicationIdentifier", + "properties", + "metadata", + "participants" + ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventBaseProperties" @@ -448,6 +511,10 @@ "description": "The deletion time of the thread" } }, + "required": [ + "deletedByCommunicationIdentifier", + "deleteTime" + ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" @@ -469,6 +536,9 @@ "description": "The version of the thread" } }, + "required": [ + "createTime" + ], "allOf": [ { "$ref": "#/definitions/AcsChatEventBaseProperties" @@ -490,6 +560,9 @@ "description": "The version of the thread" } }, + "required": [ + "createTime" + ], "allOf": [ { "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" @@ -515,7 +588,11 @@ "type": "string" } } - } + }, + "required": [ + "participantCommunicationIdentifier", + "metadata" + ] }, "AcsChatThreadPropertiesUpdatedEventData": { "type": "object", @@ -543,6 +620,12 @@ } } }, + "required": [ + "editedByCommunicationIdentifier", + "editTime", + "properties", + "metadata" + ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" @@ -575,6 +658,12 @@ "additionalProperties": {} } }, + "required": [ + "editedByCommunicationIdentifier", + "editTime", + "metadata", + "properties" + ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventBaseProperties" @@ -595,6 +684,10 @@ "description": "The deletion time of the thread" } }, + "required": [ + "deletedByCommunicationIdentifier", + "deleteTime" + ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventBaseProperties" @@ -631,7 +724,12 @@ "description": "The time at which the email delivery report received timestamp", "x-ms-client-name": "deliveryAttemptTimestamp" } - } + }, + "required": [ + "status", + "deliveryStatusDetails", + "deliveryAttemptTimeStamp" + ] }, "AcsEmailDeliveryReportStatus": { "type": "string", @@ -726,7 +824,11 @@ "description": "The type of engagement user have with email", "x-ms-client-name": "engagement" } - } + }, + "required": [ + "userActionTimeStamp", + "engagementType" + ] }, "AcsIncomingCallCustomContext": { "type": "object", @@ -746,7 +848,11 @@ "type": "string" } } - } + }, + "required": [ + "sipHeaders", + "voipHeaders" + ] }, "AcsIncomingCallEventData": { "type": "object", @@ -782,8 +888,333 @@ "type": "string", "description": "CorrelationId (CallId)." } + }, + "required": [ + "to", + "from", + "customContext" + ] + }, + "AcsInteractiveReplyKind": { + "type": "string", + "description": "Interactive reply kind", + "enum": [ + "buttonReply", + "listReply", + "unknown" + ], + "x-ms-enum": { + "name": "AcsInteractiveReplyKind", + "modelAsString": true, + "values": [ + { + "name": "buttonReply", + "value": "buttonReply", + "description": "Messaged interactive reply type is ButtonReply" + }, + { + "name": "listReply", + "value": "listReply", + "description": "Messaged interactive reply type is ListReply" + }, + { + "name": "unknown", + "value": "unknown", + "description": "Messaged interactive reply type is Unknown" + } + ] + } + }, + "AcsMessageButtonContent": { + "type": "object", + "description": "Message Button Content", + "properties": { + "text": { + "type": "string", + "description": "The Text of the button" + }, + "payload": { + "type": "string", + "description": "The Payload of the button which was clicked by the user, setup by the business" + } + } + }, + "AcsMessageChannelEventError": { + "type": "object", + "description": "Message Channel Event Error", + "properties": { + "channelCode": { + "type": "string", + "description": "The channel error code" + }, + "channelMessage": { + "type": "string", + "description": "The channel error message" + } } }, + "AcsMessageChannelKind": { + "type": "string", + "description": "Message channel kind", + "enum": [ + "whatsapp" + ], + "x-ms-enum": { + "name": "AcsMessageChannelKind", + "modelAsString": true, + "values": [ + { + "name": "whatsapp", + "value": "whatsapp", + "description": "Updated message channel type is WhatsApp" + } + ] + } + }, + "AcsMessageContext": { + "type": "object", + "description": "Message Context", + "properties": { + "from": { + "type": "string", + "description": "The WhatsApp ID for the customer who replied to an inbound message." + }, + "id": { + "type": "string", + "description": "The message ID for the sent message for an inbound reply", + "x-ms-client-name": "messageId" + } + } + }, + "AcsMessageDeliveryStatus": { + "type": "string", + "description": "Message delivery status", + "enum": [ + "read", + "delivered", + "failed", + "sent", + "warning", + "unknown" + ], + "x-ms-enum": { + "name": "AcsMessageDeliveryStatus", + "modelAsString": true, + "values": [ + { + "name": "read", + "value": "read", + "description": "Read" + }, + { + "name": "delivered", + "value": "delivered", + "description": "Delivered" + }, + { + "name": "failed", + "value": "failed", + "description": "Failed" + }, + { + "name": "sent", + "value": "sent", + "description": "Sent" + }, + { + "name": "warning", + "value": "warning", + "description": "Warning" + }, + { + "name": "unknown", + "value": "unknown", + "description": "Unknown" + } + ] + } + }, + "AcsMessageDeliveryStatusUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated event.", + "properties": { + "messageId": { + "type": "string", + "description": "The message id" + }, + "status": { + "$ref": "#/definitions/AcsMessageDeliveryStatus", + "description": "The updated message status" + }, + "channelType": { + "$ref": "#/definitions/AcsMessageChannelKind", + "description": "The updated message channel type", + "x-ms-client-name": "channelKind" + } + }, + "required": [ + "status", + "channelType" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsMessageEventData" + } + ] + }, + "AcsMessageEventData": { + "type": "object", + "description": "Schema of common properties of all chat thread events", + "properties": { + "from": { + "type": "string", + "description": "The message sender" + }, + "to": { + "type": "string", + "description": "The message recipient" + }, + "receivedTimeStamp": { + "type": "string", + "format": "date-time", + "description": "The time message was received" + }, + "error": { + "$ref": "#/definitions/AcsMessageChannelEventError", + "description": "The channel event error" + } + }, + "required": [ + "receivedTimeStamp", + "error" + ] + }, + "AcsMessageInteractiveButtonReplyContent": { + "type": "object", + "description": "Message Interactive button reply content for a user to business message", + "properties": { + "id": { + "type": "string", + "description": "The ID of the button", + "x-ms-client-name": "buttonId" + }, + "title": { + "type": "string", + "description": "The title of the button" + } + } + }, + "AcsMessageInteractiveContent": { + "type": "object", + "description": "Message Interactive Content", + "properties": { + "type": { + "$ref": "#/definitions/AcsInteractiveReplyKind", + "description": "The Message interactive reply type", + "x-ms-client-name": "replyKind" + }, + "buttonReply": { + "$ref": "#/definitions/AcsMessageInteractiveButtonReplyContent", + "description": "The Message Sent when a customer clicks a button" + }, + "listReply": { + "$ref": "#/definitions/AcsMessageInteractiveListReplyContent", + "description": "The Message Sent when a customer selects an item from a list" + } + }, + "required": [ + "type", + "buttonReply", + "listReply" + ] + }, + "AcsMessageInteractiveListReplyContent": { + "type": "object", + "description": "Message Interactive list reply content for a user to business message", + "properties": { + "id": { + "type": "string", + "description": "The ID of the selected list item", + "x-ms-client-name": "listItemId" + }, + "title": { + "type": "string", + "description": "The title of the selected list item" + }, + "description": { + "type": "string", + "description": "The description of the selected row" + } + } + }, + "AcsMessageMediaContent": { + "type": "object", + "description": "Message Media Content", + "properties": { + "mimeType": { + "type": "string", + "description": "The MIME type of the file this media represents" + }, + "id": { + "type": "string", + "description": "The media identifier", + "x-ms-client-name": "mediaId" + }, + "fileName": { + "type": "string", + "description": "The filename of the underlying media file as specified when uploaded" + }, + "caption": { + "type": "string", + "description": "The caption for the media object, if supported and provided" + } + } + }, + "AcsMessageReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageReceived event.", + "properties": { + "content": { + "type": "string", + "description": "The message content" + }, + "channelType": { + "$ref": "#/definitions/AcsMessageChannelKind", + "description": "The message channel type", + "x-ms-client-name": "channelKind" + }, + "media": { + "$ref": "#/definitions/AcsMessageMediaContent", + "description": "The received message media content", + "x-ms-client-name": "mediaContent" + }, + "context": { + "$ref": "#/definitions/AcsMessageContext", + "description": "The received message context" + }, + "button": { + "$ref": "#/definitions/AcsMessageButtonContent", + "description": "The received message button content" + }, + "interactive": { + "$ref": "#/definitions/AcsMessageInteractiveContent", + "description": "The received message interactive content", + "x-ms-client-name": "interactiveContent" + } + }, + "required": [ + "channelType", + "media", + "context", + "button", + "interactive" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsMessageEventData" + } + ] + }, "AcsRecordingChunkInfoProperties": { "type": "object", "description": "Schema for all properties of Recording Chunk Information.", @@ -849,7 +1280,14 @@ "type": "string", "description": "The reason for ending recording session" } - } + }, + "required": [ + "recordingStorageInfo", + "recordingStartTime", + "recordingContentType", + "recordingChannelType", + "recordingFormatType" + ] }, "AcsRecordingStorageInfoProperties": { "type": "object", @@ -863,7 +1301,10 @@ }, "x-ms-identifiers": [] } - } + }, + "required": [ + "recordingChunks" + ] }, "AcsRouterChannelConfiguration": { "type": "object", @@ -913,7 +1354,11 @@ }, "x-ms-identifiers": [] } - } + }, + "required": [ + "innererror", + "details" + ] }, "AcsRouterEventData": { "type": "object", @@ -969,6 +1414,9 @@ "x-ms-identifiers": [] } }, + "required": [ + "errors" + ], "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" @@ -1001,6 +1449,10 @@ "x-ms-identifiers": [] } }, + "required": [ + "queueDetails", + "attachedWorkerSelectors" + ], "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" @@ -1081,6 +1533,10 @@ } } }, + "required": [ + "labels", + "tags" + ], "allOf": [ { "$ref": "#/definitions/AcsRouterEventData" @@ -1132,6 +1588,10 @@ "x-ms-identifiers": [] } }, + "required": [ + "attachedWorkerSelectors", + "requestedWorkerSelectors" + ], "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" @@ -1174,6 +1634,9 @@ } }, "required": [ + "jobStatus", + "requestedWorkerSelectors", + "scheduledOn", "unavailableForMatching" ], "allOf": [ @@ -1217,6 +1680,11 @@ "description": "Router Job Scheduling Failed Reason" } }, + "required": [ + "expiredAttachedWorkerSelectors", + "expiredRequestedWorkerSelectors", + "scheduledOn" + ], "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" @@ -1362,6 +1830,9 @@ } }, "required": [ + "expiredAttachedWorkerSelectors", + "expiredRequestedWorkerSelectors", + "scheduledOn", "unavailableForMatching" ], "allOf": [ @@ -1391,6 +1862,10 @@ "x-ms-identifiers": [] } }, + "required": [ + "expiredRequestedWorkerSelectors", + "expiredAttachedWorkerSelectors" + ], "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" @@ -1463,7 +1938,58 @@ "additionalProperties": { "type": "string" } - } + } + }, + "required": [ + "labels" + ] + }, + "AcsRouterUpdatedWorkerProperty": { + "type": "string", + "description": "Worker properties that can be updated", + "enum": [ + "AvailableForOffers", + "TotalCapacity", + "QueueAssignments", + "Labels", + "Tags", + "ChannelConfigurations" + ], + "x-ms-enum": { + "name": "AcsRouterUpdatedWorkerProperty", + "modelAsString": true, + "values": [ + { + "name": "AvailableForOffers", + "value": "AvailableForOffers", + "description": "AvailableForOffers" + }, + { + "name": "TotalCapacity", + "value": "TotalCapacity", + "description": "TotalCapacity" + }, + { + "name": "QueueAssignments", + "value": "QueueAssignments", + "description": "QueueAssignments" + }, + { + "name": "Labels", + "value": "Labels", + "description": "Labels" + }, + { + "name": "Tags", + "value": "Tags", + "description": "Tags" + }, + { + "name": "ChannelConfigurations", + "value": "ChannelConfigurations", + "description": "ChannelConfigurations" + } + ] } }, "AcsRouterWorkerDeletedEventData": { @@ -1550,6 +2076,12 @@ } } }, + "required": [ + "workerLabels", + "workerTags", + "jobLabels", + "jobTags" + ], "allOf": [ { "$ref": "#/definitions/AcsRouterWorkerEventData" @@ -1650,6 +2182,14 @@ } } }, + "required": [ + "workerLabels", + "offeredOn", + "expiresOn", + "workerTags", + "jobLabels", + "jobTags" + ], "allOf": [ { "$ref": "#/definitions/AcsRouterWorkerEventData" @@ -1717,7 +2257,13 @@ "type": "string" } } - } + }, + "required": [ + "queueAssignments", + "channelConfigurations", + "labels", + "tags" + ] }, "AcsRouterWorkerSelector": { "type": "object", @@ -1727,19 +2273,20 @@ "type": "string", "description": "Router Job Worker Selector Key" }, - "operator": { + "labelOperator": { "$ref": "#/definitions/AcsRouterLabelOperator", "description": "Router Job Worker Selector Label Operator" }, - "labelValue": { - "description": "Router Job Worker Selector Value" + "value": { + "description": "Router Job Worker Selector Value", + "x-ms-client-name": "labelValue" }, "ttlSeconds": { - "type": "string", - "format": "duration", + "type": "number", + "format": "double", "description": "Router Job Worker Selector Time to Live in Seconds" }, - "selectorState": { + "state": { "$ref": "#/definitions/AcsRouterWorkerSelectorState", "description": "Router Job Worker Selector State" }, @@ -1748,7 +2295,14 @@ "format": "date-time", "description": "Router Job Worker Selector Expiration Time" } - } + }, + "required": [ + "labelOperator", + "value", + "ttlSeconds", + "state", + "expirationTime" + ] }, "AcsRouterWorkerSelectorState": { "type": "string", @@ -1774,6 +2328,64 @@ ] } }, + "AcsRouterWorkerUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerUpdated event.", + "properties": { + "workerId": { + "type": "string", + "description": "Router Worker Updated Worker Id" + }, + "queueAssignments": { + "type": "array", + "description": "Router Worker Updated Queue Info", + "items": { + "$ref": "#/definitions/AcsRouterQueueDetails" + } + }, + "channelConfigurations": { + "type": "array", + "description": "Router Worker Updated Channel Configuration", + "items": { + "$ref": "#/definitions/AcsRouterChannelConfiguration" + }, + "x-ms-identifiers": [] + }, + "totalCapacity": { + "type": "integer", + "format": "int32", + "description": "Router Worker Updated Total Capacity" + }, + "labels": { + "type": "object", + "description": "Router Worker Updated Labels", + "additionalProperties": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Router Worker Updated Tags", + "additionalProperties": { + "type": "string" + } + }, + "updatedWorkerProperties": { + "type": "array", + "description": "Router Worker Properties Updated", + "items": { + "$ref": "#/definitions/AcsRouterUpdatedWorkerProperty" + } + } + }, + "required": [ + "queueAssignments", + "channelConfigurations", + "labels", + "tags", + "updatedWorkerProperties" + ] + }, "AcsSmsDeliveryAttemptProperties": { "type": "object", "description": "Schema for details of a delivery attempt", @@ -1793,7 +2405,10 @@ "format": "int32", "description": "Number of segments whose delivery failed" } - } + }, + "required": [ + "timestamp" + ] }, "AcsSmsDeliveryReportReceivedEventData": { "type": "object", @@ -1825,6 +2440,10 @@ "description": "Customer Content" } }, + "required": [ + "deliveryAttempts", + "receivedTimestamp" + ], "allOf": [ { "$ref": "#/definitions/AcsSmsEventBaseProperties" @@ -1863,6 +2482,9 @@ "description": "The time at which the SMS was received" } }, + "required": [ + "receivedTimestamp" + ], "allOf": [ { "$ref": "#/definitions/AcsSmsEventBaseProperties" @@ -1877,7 +2499,10 @@ "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who was disconnected" } - } + }, + "required": [ + "userCommunicationIdentifier" + ] }, "AcsUserEngagement": { "type": "string", @@ -1903,6 +2528,62 @@ ] } }, + "ApiCenterApiDefinitionAddedEventData": { + "type": "object", + "description": "Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionAdded event.", + "properties": { + "title": { + "type": "string", + "description": "API definition title." + }, + "description": { + "type": "string", + "description": "API definition description." + }, + "specification": { + "$ref": "#/definitions/ApiCenterApiSpecification", + "description": "API definition specification." + } + }, + "required": [ + "specification" + ] + }, + "ApiCenterApiDefinitionUpdatedEventData": { + "type": "object", + "description": "Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionUpdated event.", + "properties": { + "title": { + "type": "string", + "description": "API definition title." + }, + "description": { + "type": "string", + "description": "API definition description." + }, + "specification": { + "$ref": "#/definitions/ApiCenterApiSpecification", + "description": "API definition specification." + } + }, + "required": [ + "specification" + ] + }, + "ApiCenterApiSpecification": { + "type": "object", + "description": "API specification details.", + "properties": { + "name": { + "type": "string", + "description": "Specification name." + }, + "version": { + "type": "string", + "description": "Specification version." + } + } + }, "ApiManagementApiCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APICreated event.", @@ -2299,7 +2980,10 @@ "$ref": "#/definitions/AppAction", "description": "Type of action of the operation." } - } + }, + "required": [ + "action" + ] }, "AppServicePlanAction": { "type": "string", @@ -2335,7 +3019,12 @@ "$ref": "#/definitions/AsyncStatus", "description": "Asynchronous operation status of the operation on the app service plan." } - } + }, + "required": [ + "stampKind", + "action", + "status" + ] }, "AsyncStatus": { "type": "string", @@ -2549,6 +3238,18 @@ } } }, + "required": [ + "namedOutputs" + ], + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ] + }, + "AvsScriptExecutionStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionStarted event.", "allOf": [ { "$ref": "#/definitions/AvsScriptExecutionEventData" @@ -2589,6 +3290,10 @@ "type": "object", "description": "Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model must be interpreted as a union: Apart from rawId, at most one further property may be set.", "properties": { + "kind": { + "$ref": "#/definitions/CommunicationIdentifierModelKind", + "description": "The identifier kind. Only required in responses." + }, "rawId": { "type": "string", "description": "Raw Id of the identifier. Optional in requests, required in responses." @@ -2604,7 +3309,54 @@ "microsoftTeamsUser": { "$ref": "#/definitions/MicrosoftTeamsUserIdentifierModel", "description": "The Microsoft Teams user." + }, + "microsoftTeamsApp": { + "$ref": "#/definitions/MicrosoftTeamsAppIdentifierModel", + "description": "The Microsoft Teams application." } + }, + "required": [ + "kind", + "communicationUser", + "phoneNumber", + "microsoftTeamsUser", + "microsoftTeamsApp" + ] + }, + "CommunicationIdentifierModelKind": { + "type": "string", + "description": "Communication model identifier kind", + "enum": [ + "unknown", + "communicationUser", + "phoneNumber", + "microsoftTeamsUser" + ], + "x-ms-enum": { + "name": "CommunicationIdentifierModelKind", + "modelAsString": true, + "values": [ + { + "name": "unknown", + "value": "unknown", + "description": "Unknown" + }, + { + "name": "communicationUser", + "value": "communicationUser", + "description": "Communication User" + }, + { + "name": "phoneNumber", + "value": "phoneNumber", + "description": "Phone Number" + }, + { + "name": "microsoftTeamsUser", + "value": "microsoftTeamsUser", + "description": "Microsoft Teams User" + } + ] } }, "CommunicationUserIdentifierModel": { @@ -2649,7 +3401,12 @@ "$ref": "#/definitions/ContainerRegistryEventConnectedRegistry", "description": "The connected registry information if the event is generated by a connected registry." } - } + }, + "required": [ + "timestamp", + "target", + "connectedRegistry" + ] }, "ContainerRegistryArtifactEventTarget": { "type": "object", @@ -2765,7 +3522,15 @@ "$ref": "#/definitions/ContainerRegistryEventConnectedRegistry", "description": "The connected registry information if the event is generated by a connected registry." } - } + }, + "required": [ + "timestamp", + "target", + "request", + "actor", + "source", + "connectedRegistry" + ] }, "ContainerRegistryEventRequest": { "type": "object", @@ -2965,7 +3730,11 @@ "format": "date-time", "description": "The time at which the stage happened." } - } + }, + "required": [ + "stageName", + "stageTime" + ] }, "DataBoxCopyStartedEventData": { "type": "object", @@ -2984,7 +3753,11 @@ "format": "date-time", "description": "The time at which the stage happened." } - } + }, + "required": [ + "stageName", + "stageTime" + ] }, "DataBoxOrderCompletedEventData": { "type": "object", @@ -3003,7 +3776,11 @@ "format": "date-time", "description": "The time at which the stage happened." } - } + }, + "required": [ + "stageName", + "stageTime" + ] }, "DataBoxStageName": { "type": "string", @@ -3065,7 +3842,10 @@ "$ref": "#/definitions/DeviceConnectionStateEventInfo", "description": "Information about the device connection state event." } - } + }, + "required": [ + "deviceConnectionStateEventInfo" + ] }, "DeviceLifeCycleEventProperties": { "type": "object", @@ -3083,7 +3863,10 @@ "$ref": "#/definitions/DeviceTwinInfo", "description": "Information about the device twin, which is the cloud representation of application device metadata." } - } + }, + "required": [ + "twin" + ] }, "DeviceTelemetryEventProperties": { "type": "object", @@ -3108,7 +3891,12 @@ "type": "string" } } - } + }, + "required": [ + "body", + "properties", + "systemProperties" + ] }, "DeviceTwinInfo": { "type": "object", @@ -3160,7 +3948,11 @@ "$ref": "#/definitions/DeviceTwinInfoX509Thumbprint", "description": "The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate." } - } + }, + "required": [ + "properties", + "x509Thumbprint" + ] }, "DeviceTwinInfoProperties": { "type": "object", @@ -3174,7 +3966,11 @@ "$ref": "#/definitions/DeviceTwinProperties", "description": "A portion of the properties that can be written only by the device, and read by the application back-end." } - } + }, + "required": [ + "desired", + "reported" + ] }, "DeviceTwinInfoX509Thumbprint": { "type": "object", @@ -3216,11 +4012,14 @@ "description": "Version of device twin properties.", "x-ms-client-name": "$version" } - } + }, + "required": [ + "metadata" + ] }, "EventGridMQTTClientCreatedOrUpdatedEventData": { "type": "object", - "description": "Event data for Microsoft.EventGrid.SystemEvents.MQTTClientCreatedOrUpdated event.", + "description": "Event data for Microsoft.EventGrid.MQTTClientCreatedOrUpdated event.", "properties": { "state": { "$ref": "#/definitions/EventGridMQTTClientState", @@ -3244,6 +4043,12 @@ } } }, + "required": [ + "state", + "createdOn", + "updatedOn", + "attributes" + ], "allOf": [ { "$ref": "#/definitions/EventGridMQTTClientEventData" @@ -3252,7 +4057,7 @@ }, "EventGridMQTTClientDeletedEventData": { "type": "object", - "description": "Event data for Microsoft.EventGrid.SystemEvents.MQTTClientDeleted event.", + "description": "Event data for Microsoft.EventGrid.MQTTClientDeleted event.", "allOf": [ { "$ref": "#/definitions/EventGridMQTTClientEventData" @@ -3357,7 +4162,7 @@ }, "EventGridMQTTClientSessionConnectedEventData": { "type": "object", - "description": "Event data for Microsoft.EventGrid.SystemEvents.MQTTClientSessionConnected event.", + "description": "Event data for Microsoft.EventGrid.MQTTClientSessionConnected event.", "properties": { "clientSessionName": { "type": "string", @@ -3377,7 +4182,7 @@ }, "EventGridMQTTClientSessionDisconnectedEventData": { "type": "object", - "description": "Event data for Microsoft.EventGrid.SystemEvents.MQTTClientSessionDisconnected event.", + "description": "Event data for Microsoft.EventGrid.MQTTClientSessionDisconnected event.", "properties": { "clientSessionName": { "type": "string", @@ -3393,6 +4198,9 @@ "description": "Reason for the disconnection of the MQTT client's session. The value could be\none of the values in the disconnection reasons table." } }, + "required": [ + "disconnectionReason" + ], "allOf": [ { "$ref": "#/definitions/EventGridMQTTClientEventData" @@ -3470,7 +4278,11 @@ "format": "date-time", "description": "The last time from the queue." } - } + }, + "required": [ + "firstEnqueueTime", + "lastEnqueueTime" + ] }, "HealthcareDicomImageCreatedEventData": { "type": "object", @@ -3590,7 +4402,10 @@ "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", "x-ms-client-name": "FhirResourceVersionId" } - } + }, + "required": [ + "resourceType" + ] }, "HealthcareFhirResourceDeletedEventData": { "type": "object", @@ -3617,7 +4432,10 @@ "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", "x-ms-client-name": "FhirResourceVersionId" } - } + }, + "required": [ + "resourceType" + ] }, "HealthcareFhirResourceType": { "type": "string", @@ -4622,7 +5440,10 @@ "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", "x-ms-client-name": "FhirResourceVersionId" } - } + }, + "required": [ + "resourceType" + ] }, "IotHubDeviceConnectedEventData": { "type": "object", @@ -4669,9 +5490,9 @@ } ] }, - "KeyVaultCertificateExpiredEventData": { + "KeyVaultAccessPolicyChangedEventData": { "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateExpired event.", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.VaultAccessPolicyChanged event.", "properties": { "Id": { "type": "string", @@ -4705,9 +5526,9 @@ } } }, - "KeyVaultCertificateNearExpiryEventData": { + "KeyVaultCertificateExpiredEventData": { "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNearExpiry event.", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateExpired event.", "properties": { "Id": { "type": "string", @@ -4741,9 +5562,9 @@ } } }, - "KeyVaultCertificateNewVersionCreatedEventData": { + "KeyVaultCertificateNearExpiryEventData": { "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNewVersionCreated event.", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNearExpiry event.", "properties": { "Id": { "type": "string", @@ -4777,9 +5598,9 @@ } } }, - "KeyVaultKeyExpiredEventData": { + "KeyVaultCertificateNewVersionCreatedEventData": { "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyExpired event.", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNewVersionCreated event.", "properties": { "Id": { "type": "string", @@ -4813,9 +5634,9 @@ } } }, - "KeyVaultKeyNearExpiryEventData": { + "KeyVaultKeyExpiredEventData": { "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNearExpiry event.", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyExpired event.", "properties": { "Id": { "type": "string", @@ -4849,9 +5670,9 @@ } } }, - "KeyVaultKeyNewVersionCreatedEventData": { + "KeyVaultKeyNearExpiryEventData": { "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNewVersionCreated event.", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNearExpiry event.", "properties": { "Id": { "type": "string", @@ -4885,9 +5706,9 @@ } } }, - "KeyVaultSecretExpiredEventData": { + "KeyVaultKeyNewVersionCreatedEventData": { "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretExpired event.", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNewVersionCreated event.", "properties": { "Id": { "type": "string", @@ -4921,9 +5742,9 @@ } } }, - "KeyVaultSecretNearExpiryEventData": { + "KeyVaultSecretExpiredEventData": { "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNearExpiry event.", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretExpired event.", "properties": { "Id": { "type": "string", @@ -4957,9 +5778,9 @@ } } }, - "KeyVaultSecretNewVersionCreatedEventData": { + "KeyVaultSecretNearExpiryEventData": { "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNewVersionCreated event.", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNearExpiry event.", "properties": { "Id": { "type": "string", @@ -4993,9 +5814,9 @@ } } }, - "KeyVaultVaultAccessPolicyChangedEventData": { + "KeyVaultSecretNewVersionCreatedEventData": { "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.VaultAccessPolicyChanged event.", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNewVersionCreated event.", "properties": { "Id": { "type": "string", @@ -5068,7 +5889,11 @@ "format": "date-time", "description": "The end time of the target dataset time series that resulted in drift detection." } - } + }, + "required": [ + "startTime", + "endTime" + ] }, "MachineLearningServicesModelDeployedEventData": { "type": "object", @@ -5096,7 +5921,11 @@ "description": "The properties of the deployed service.", "additionalProperties": {} } - } + }, + "required": [ + "serviceTags", + "serviceProperties" + ] }, "MachineLearningServicesModelRegisteredEventData": { "type": "object", @@ -5120,7 +5949,11 @@ "description": "The properties of the model that was registered.", "additionalProperties": {} } - } + }, + "required": [ + "modelTags", + "modelProperties" + ] }, "MachineLearningServicesRunCompletedEventData": { "type": "object", @@ -5152,7 +5985,11 @@ "description": "The properties of the completed Run.", "additionalProperties": {} } - } + }, + "required": [ + "runTags", + "runProperties" + ] }, "MachineLearningServicesRunStatusChangedEventData": { "type": "object", @@ -5188,7 +6025,11 @@ "type": "string", "description": "The status of the Machine Learning Run." } - } + }, + "required": [ + "runTags", + "runProperties" + ] }, "MapsGeofenceEnteredEventData": { "type": "object", @@ -5229,7 +6070,10 @@ "type": "boolean", "description": "True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber." } - } + }, + "required": [ + "geometries" + ] }, "MapsGeofenceExitedEventData": { "type": "object", @@ -5295,6 +6139,9 @@ "x-ms-identifiers": [] } }, + "required": [ + "outputs" + ], "allOf": [ { "$ref": "#/definitions/MediaJobStateChangeEventData" @@ -5316,23 +6163,19 @@ "properties": { "code": { "$ref": "#/definitions/MediaJobErrorCode", - "description": "Error code describing the error.", - "readOnly": true + "description": "Error code describing the error." }, "message": { "type": "string", - "description": "A human-readable language-dependent representation of the error.", - "readOnly": true + "description": "A human-readable language-dependent representation of the error." }, "category": { "$ref": "#/definitions/MediaJobErrorCategory", - "description": "Helps with categorization of errors.", - "readOnly": true + "description": "Helps with categorization of errors." }, "retry": { "$ref": "#/definitions/MediaJobRetry", - "description": "Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal.", - "readOnly": true + "description": "Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal." }, "details": { "type": "array", @@ -5340,10 +6183,15 @@ "items": { "$ref": "#/definitions/MediaJobErrorDetail" }, - "readOnly": true, "x-ms-identifiers": [] } - } + }, + "required": [ + "code", + "category", + "retry", + "details" + ] }, "MediaJobErrorCategory": { "type": "string", @@ -5471,13 +6319,11 @@ "properties": { "code": { "type": "string", - "description": "Code describing the error detail.", - "readOnly": true + "description": "Code describing the error detail." }, "message": { "type": "string", - "description": "A human-readable representation of the error.", - "readOnly": true + "description": "A human-readable representation of the error." } } }, @@ -5494,6 +6340,9 @@ "x-ms-identifiers": [] } }, + "required": [ + "outputs" + ], "allOf": [ { "$ref": "#/definitions/MediaJobStateChangeEventData" @@ -5513,6 +6362,9 @@ "x-ms-identifiers": [] } }, + "required": [ + "outputs" + ], "allOf": [ { "$ref": "#/definitions/MediaJobStateChangeEventData" @@ -5523,7 +6375,7 @@ "type": "object", "description": "The event data for a Job output.", "properties": { - "@odataType": { + "@odata.type": { "type": "string", "description": "The discriminator for derived types." }, @@ -5545,9 +6397,10 @@ "description": "Gets the Job output state." } }, - "discriminator": "@odataType", + "discriminator": "@odata.type", "required": [ - "@odataType", + "@odata.type", + "error", "progress", "state" ] @@ -5633,7 +6486,10 @@ "type": "string" } } - } + }, + "required": [ + "jobCorrelationData" + ] }, "MediaJobOutputScheduledEventData": { "type": "object", @@ -5650,8 +6506,7 @@ "properties": { "previousState": { "$ref": "#/definitions/MediaJobState", - "description": "The previous state of the Job.", - "readOnly": true + "description": "The previous state of the Job." }, "output": { "$ref": "#/definitions/MediaJobOutput", @@ -5664,7 +6519,12 @@ "type": "string" } } - } + }, + "required": [ + "previousState", + "output", + "jobCorrelationData" + ] }, "MediaJobProcessingEventData": { "type": "object", @@ -5768,13 +6628,11 @@ "properties": { "previousState": { "$ref": "#/definitions/MediaJobState", - "description": "The previous state of the Job.", - "readOnly": true + "description": "The previous state of the Job." }, "state": { "$ref": "#/definitions/MediaJobState", - "description": "The new state of the Job.", - "readOnly": true + "description": "The new state of the Job." }, "correlationData": { "type": "object", @@ -5783,7 +6641,12 @@ "type": "string" } } - } + }, + "required": [ + "previousState", + "state", + "correlationData" + ] }, "MediaLiveEventChannelArchiveHeartbeatEventData": { "type": "object", @@ -5791,13 +6654,11 @@ "properties": { "channelLatencyMs": { "type": "string", - "description": "Gets the channel latency in ms.", - "readOnly": true + "description": "Gets the channel latency in ms." }, "latencyResultCode": { "type": "string", - "description": "Gets the latency result code.", - "readOnly": true + "description": "Gets the latency result code." } }, "required": [ @@ -5811,23 +6672,19 @@ "properties": { "ingestUrl": { "type": "string", - "description": "Gets the ingest URL provided by the live event.", - "readOnly": true + "description": "Gets the ingest URL provided by the live event." }, "streamId": { "type": "string", - "description": "Gets the stream Id.", - "readOnly": true + "description": "Gets the stream Id." }, "encoderIp": { "type": "string", - "description": "Gets the remote IP.", - "readOnly": true + "description": "Gets the remote IP." }, "encoderPort": { "type": "string", - "description": "Gets the remote port.", - "readOnly": true + "description": "Gets the remote port." }, "resultCode": { "type": "string", @@ -5841,23 +6698,19 @@ "properties": { "ingestUrl": { "type": "string", - "description": "Gets the ingest URL provided by the live event.", - "readOnly": true + "description": "Gets the ingest URL provided by the live event." }, "streamId": { "type": "string", - "description": "Gets the stream Id.", - "readOnly": true + "description": "Gets the stream Id." }, "encoderIp": { "type": "string", - "description": "Gets the remote IP.", - "readOnly": true + "description": "Gets the remote IP." }, "encoderPort": { "type": "string", - "description": "Gets the remote port.", - "readOnly": true + "description": "Gets the remote port." } } }, @@ -5867,23 +6720,19 @@ "properties": { "ingestUrl": { "type": "string", - "description": "Gets the ingest URL provided by the live event.", - "readOnly": true + "description": "Gets the ingest URL provided by the live event." }, "streamId": { "type": "string", - "description": "Gets the stream Id.", - "readOnly": true + "description": "Gets the stream Id." }, "encoderIp": { "type": "string", - "description": "Gets the remote IP.", - "readOnly": true + "description": "Gets the remote IP." }, "encoderPort": { "type": "string", - "description": "Gets the remote port.", - "readOnly": true + "description": "Gets the remote port." }, "resultCode": { "type": "string", @@ -5897,19 +6746,16 @@ "properties": { "timestamp": { "type": "string", - "description": "Gets the timestamp of the data chunk dropped.", - "readOnly": true + "description": "Gets the timestamp of the data chunk dropped." }, "trackType": { "type": "string", - "description": "Gets the type of the track (Audio / Video).", - "readOnly": true + "description": "Gets the type of the track (Audio / Video)." }, "bitrate": { "type": "integer", "format": "int64", - "description": "Gets the bitrate of the track.", - "readOnly": true + "description": "Gets the bitrate of the track." }, "timescale": { "type": "string", @@ -5917,13 +6763,11 @@ }, "resultCode": { "type": "string", - "description": "Gets the result code for fragment drop operation.", - "readOnly": true + "description": "Gets the result code for fragment drop operation." }, "trackName": { "type": "string", - "description": "Gets the name of the track for which fragment is dropped.", - "readOnly": true + "description": "Gets the name of the track for which fragment is dropped." } } }, @@ -5933,49 +6777,40 @@ "properties": { "ingestUrl": { "type": "string", - "description": "Gets the ingest URL provided by the live event.", - "readOnly": true + "description": "Gets the ingest URL provided by the live event." }, "trackType": { "type": "string", - "description": "Gets the type of the track (Audio / Video).", - "readOnly": true + "description": "Gets the type of the track (Audio / Video)." }, "trackName": { "type": "string", - "description": "Gets the track name.", - "readOnly": true + "description": "Gets the track name." }, "bitrate": { "type": "integer", "format": "int64", - "description": "Gets the bitrate of the track.", - "readOnly": true + "description": "Gets the bitrate of the track." }, "encoderIp": { "type": "string", - "description": "Gets the remote IP.", - "readOnly": true + "description": "Gets the remote IP." }, "encoderPort": { "type": "string", - "description": "Gets the remote port.", - "readOnly": true + "description": "Gets the remote port." }, "timestamp": { "type": "string", - "description": "Gets the first timestamp of the data chunk received.", - "readOnly": true + "description": "Gets the first timestamp of the data chunk received." }, "duration": { "type": "string", - "description": "Gets the duration of the first data chunk.", - "readOnly": true + "description": "Gets the duration of the first data chunk." }, "timescale": { "type": "string", - "description": "Gets the timescale in which timestamp is represented.", - "readOnly": true + "description": "Gets the timescale in which timestamp is represented." } } }, @@ -5985,33 +6820,27 @@ "properties": { "minLastTimestamp": { "type": "string", - "description": "Gets the minimum last timestamp received.", - "readOnly": true + "description": "Gets the minimum last timestamp received." }, "typeOfStreamWithMinLastTimestamp": { "type": "string", - "description": "Gets the type of stream with minimum last timestamp.", - "readOnly": true + "description": "Gets the type of stream with minimum last timestamp." }, "maxLastTimestamp": { "type": "string", - "description": "Gets the maximum timestamp among all the tracks (audio or video).", - "readOnly": true + "description": "Gets the maximum timestamp among all the tracks (audio or video)." }, "typeOfStreamWithMaxLastTimestamp": { "type": "string", - "description": "Gets the type of stream with maximum last timestamp.", - "readOnly": true + "description": "Gets the type of stream with maximum last timestamp." }, "timescaleOfMinLastTimestamp": { "type": "string", - "description": "Gets the timescale in which \\\"MinLastTimestamp\\\" is represented.", - "readOnly": true + "description": "Gets the timescale in which \\\"MinLastTimestamp\\\" is represented." }, "timescaleOfMaxLastTimestamp": { "type": "string", - "description": "Gets the timescale in which \\\"MaxLastTimestamp\\\" is represented.", - "readOnly": true + "description": "Gets the timescale in which \\\"MaxLastTimestamp\\\" is represented." } } }, @@ -6021,28 +6850,23 @@ "properties": { "firstTimestamp": { "type": "string", - "description": "Gets the first timestamp received for one of the quality levels.", - "readOnly": true + "description": "Gets the first timestamp received for one of the quality levels." }, "firstDuration": { "type": "string", - "description": "Gets the duration of the data chunk with first timestamp.", - "readOnly": true + "description": "Gets the duration of the data chunk with first timestamp." }, "secondTimestamp": { "type": "string", - "description": "Gets the timestamp received for some other quality levels.", - "readOnly": true + "description": "Gets the timestamp received for some other quality levels." }, "secondDuration": { "type": "string", - "description": "Gets the duration of the data chunk with second timestamp.", - "readOnly": true + "description": "Gets the duration of the data chunk with second timestamp." }, "timescale": { "type": "string", - "description": "Gets the timescale in which both the timestamps and durations are represented.", - "readOnly": true + "description": "Gets the timescale in which both the timestamps and durations are represented." } } }, @@ -6052,88 +6876,72 @@ "properties": { "trackType": { "type": "string", - "description": "Gets the type of the track (Audio / Video).", - "readOnly": true + "description": "Gets the type of the track (Audio / Video)." }, "trackName": { "type": "string", - "description": "Gets the track name.", - "readOnly": true + "description": "Gets the track name." }, "transcriptionLanguage": { "type": "string", - "description": "Gets the Live Transcription language.", - "readOnly": true + "description": "Gets the Live Transcription language." }, "transcriptionState": { "type": "string", - "description": "Gets the Live Transcription state.", - "readOnly": true + "description": "Gets the Live Transcription state." }, "bitrate": { "type": "integer", "format": "int64", - "description": "Gets the bitrate of the track.", - "readOnly": true + "description": "Gets the bitrate of the track." }, "incomingBitrate": { "type": "integer", "format": "int64", - "description": "Gets the incoming bitrate.", - "readOnly": true + "description": "Gets the incoming bitrate." }, "ingestDriftValue": { "type": "string", - "description": "Gets the track ingest drift value.", - "readOnly": true + "description": "Gets the track ingest drift value." }, "lastFragmentArrivalTime": { "type": "string", - "description": "Gets the arrival UTC time of the last fragment.", - "readOnly": true + "description": "Gets the arrival UTC time of the last fragment." }, "lastTimestamp": { "type": "string", - "description": "Gets the last timestamp.", - "readOnly": true + "description": "Gets the last timestamp." }, "timescale": { "type": "string", - "description": "Gets the timescale of the last timestamp.", - "readOnly": true + "description": "Gets the timescale of the last timestamp." }, "overlapCount": { "type": "integer", "format": "int64", - "description": "Gets the fragment Overlap count.", - "readOnly": true + "description": "Gets the fragment Overlap count." }, "discontinuityCount": { "type": "integer", "format": "int64", - "description": "Gets the fragment Discontinuity count.", - "readOnly": true + "description": "Gets the fragment Discontinuity count." }, "nonincreasingCount": { "type": "integer", "format": "int64", - "description": "Gets Non increasing count.", - "readOnly": true + "description": "Gets Non increasing count." }, "unexpectedBitrate": { "type": "boolean", - "description": "Gets a value indicating whether unexpected bitrate is present or not.", - "readOnly": true + "description": "Gets a value indicating whether unexpected bitrate is present or not." }, "state": { "type": "string", - "description": "Gets the state of the live event.", - "readOnly": true + "description": "Gets the state of the live event." }, "healthy": { "type": "boolean", - "description": "Gets a value indicating whether preview is healthy or not.", - "readOnly": true + "description": "Gets a value indicating whether preview is healthy or not." } } }, @@ -6143,42 +6951,53 @@ "properties": { "trackType": { "type": "string", - "description": "Gets the type of the track (Audio / Video).", - "readOnly": true + "description": "Gets the type of the track (Audio / Video)." }, "trackName": { "type": "string", - "description": "Gets the track name.", - "readOnly": true + "description": "Gets the track name." }, "bitrate": { "type": "integer", "format": "int64", - "description": "Gets the bitrate.", - "readOnly": true + "description": "Gets the bitrate." }, "previousTimestamp": { "type": "string", - "description": "Gets the timestamp of the previous fragment.", - "readOnly": true + "description": "Gets the timestamp of the previous fragment." }, "newTimestamp": { "type": "string", - "description": "Gets the timestamp of the current fragment.", - "readOnly": true + "description": "Gets the timestamp of the current fragment." }, "timescale": { "type": "string", - "description": "Gets the timescale in which both timestamps and discontinuity gap are represented.", - "readOnly": true + "description": "Gets the timescale in which both timestamps and discontinuity gap are represented." }, "discontinuityGap": { "type": "string", - "description": "Gets the discontinuity gap between PreviousTimestamp and NewTimestamp.", - "readOnly": true + "description": "Gets the discontinuity gap between PreviousTimestamp and NewTimestamp." } } }, + "MicrosoftTeamsAppIdentifierModel": { + "type": "object", + "description": "A Microsoft Teams application.", + "properties": { + "appId": { + "type": "string", + "description": "The Id of the Microsoft Teams application" + }, + "cloud": { + "$ref": "#/definitions/CommunicationCloudEnvironmentModel", + "description": "The cloud that the Microsoft Teams application belongs to. By default 'public' if missing." + } + }, + "required": [ + "appId", + "cloud" + ] + }, "MicrosoftTeamsUserIdentifierModel": { "type": "object", "description": "A Microsoft Teams user.", @@ -6197,7 +7016,8 @@ } }, "required": [ - "userId" + "userId", + "cloud" ] }, "PhoneNumberIdentifierModel": { @@ -6246,7 +7066,10 @@ "type": "string", "description": "The compliance reason code. May be empty." } - } + }, + "required": [ + "timestamp" + ] }, "PolicyInsightsPolicyStateCreatedEventData": { "type": "object", @@ -6281,7 +7104,10 @@ "type": "string", "description": "The compliance reason code. May be empty." } - } + }, + "required": [ + "timestamp" + ] }, "PolicyInsightsPolicyStateDeletedEventData": { "type": "object", @@ -6316,7 +7142,10 @@ "type": "string", "description": "The compliance reason code. May be empty." } - } + }, + "required": [ + "timestamp" + ] }, "RedisExportRDBCompletedEventData": { "type": "object", @@ -6335,7 +7164,10 @@ "type": "string", "description": "The status of this event. Failed or succeeded" } - } + }, + "required": [ + "timestamp" + ] }, "RedisImportRDBCompletedEventData": { "type": "object", @@ -6354,7 +7186,10 @@ "type": "string", "description": "The status of this event. Failed or succeeded" } - } + }, + "required": [ + "timestamp" + ] }, "RedisPatchingCompletedEventData": { "type": "object", @@ -6373,7 +7208,10 @@ "type": "string", "description": "The status of this event. Failed or succeeded" } - } + }, + "required": [ + "timestamp" + ] }, "RedisScalingCompletedEventData": { "type": "object", @@ -6392,9 +7230,12 @@ "type": "string", "description": "The status of this event. Failed or succeeded" } - } + }, + "required": [ + "timestamp" + ] }, - "ResourceActionCancelData": { + "ResourceActionCancelEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled.", "properties": { @@ -6445,9 +7286,14 @@ "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } - } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] }, - "ResourceActionFailureData": { + "ResourceActionFailureEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails.", "properties": { @@ -6498,9 +7344,14 @@ "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } - } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] }, - "ResourceActionSuccessData": { + "ResourceActionSuccessEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds.", "properties": { @@ -6551,7 +7402,12 @@ "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } - } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] }, "ResourceAuthorization": { "type": "object", @@ -6572,9 +7428,12 @@ "type": "string" } } - } + }, + "required": [ + "evidence" + ] }, - "ResourceDeleteCancelData": { + "ResourceDeleteCancelEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled.", "properties": { @@ -6625,9 +7484,14 @@ "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } - } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] }, - "ResourceDeleteFailureData": { + "ResourceDeleteFailureEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails.", "properties": { @@ -6678,9 +7542,14 @@ "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } - } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] }, - "ResourceDeleteSuccessData": { + "ResourceDeleteSuccessEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds.", "properties": { @@ -6731,7 +7600,12 @@ "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } - } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] }, "ResourceHttpRequest": { "type": "object", @@ -6782,7 +7656,10 @@ "format": "date-time", "description": "Date and Time when resource was updated" } - } + }, + "required": [ + "resourceEventTime" + ] }, "ResourceNotificationsResourceDeletedDetails": { "type": "object", @@ -6816,7 +7693,11 @@ "description": "details about operational info", "x-ms-client-name": "operationalDetails" } - } + }, + "required": [ + "resourceInfo", + "operationalInfo" + ] }, "ResourceNotificationsResourceManagementCreatedOrUpdatedEventData": { "type": "object", @@ -6868,7 +7749,11 @@ "description": "properties in the payload of the resource for which the event is being emitted", "additionalProperties": {} } - } + }, + "required": [ + "tags", + "properties" + ] }, "ResourceNotificationsResourceUpdatedEventData": { "type": "object", @@ -6888,9 +7773,13 @@ "type": "string", "description": "api version of the resource properties bag" } - } + }, + "required": [ + "resourceInfo", + "operationalInfo" + ] }, - "ResourceWriteCancelData": { + "ResourceWriteCancelEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteCancel event. This is raised when a resource create or update operation is canceled.", "properties": { @@ -6941,9 +7830,14 @@ "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } - } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] }, - "ResourceWriteFailureData": { + "ResourceWriteFailureEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteFailure event. This is raised when a resource create or update operation fails.", "properties": { @@ -6994,9 +7888,14 @@ "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } - } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] }, - "ResourceWriteSuccessData": { + "ResourceWriteSuccessEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteSuccess event. This is raised when a resource create or update operation succeeds.", "properties": { @@ -7047,7 +7946,12 @@ "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } - } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] }, "ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData": { "type": "object", @@ -7190,7 +8094,10 @@ "type": "string", "description": "The user Id of connected client connection." } - } + }, + "required": [ + "timestamp" + ] }, "SignalRServiceClientConnectionDisconnectedEventData": { "type": "object", @@ -7217,7 +8124,10 @@ "type": "string", "description": "The message of error that cause the client connection disconnected." } - } + }, + "required": [ + "timestamp" + ] }, "StampKind": { "type": "string", @@ -7295,7 +8205,10 @@ "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } - } + }, + "required": [ + "storageDiagnostics" + ] }, "StorageBlobCreatedEventData": { "type": "object", @@ -7352,7 +8265,10 @@ "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } - } + }, + "required": [ + "storageDiagnostics" + ] }, "StorageBlobDeletedEventData": { "type": "object", @@ -7395,7 +8311,10 @@ "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } - } + }, + "required": [ + "storageDiagnostics" + ] }, "StorageBlobInventoryPolicyCompletedEventData": { "type": "object", @@ -7430,7 +8349,10 @@ "type": "string", "description": "The blob URL for manifest file for inventory run." } - } + }, + "required": [ + "scheduleDateTime" + ] }, "StorageBlobRenamedEventData": { "type": "object", @@ -7469,7 +8391,10 @@ "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } - } + }, + "required": [ + "storageDiagnostics" + ] }, "StorageBlobTierChangedEventData": { "type": "object", @@ -7517,7 +8442,10 @@ "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } - } + }, + "required": [ + "storageDiagnostics" + ] }, "StorageDirectoryCreatedEventData": { "type": "object", @@ -7556,7 +8484,10 @@ "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } - } + }, + "required": [ + "storageDiagnostics" + ] }, "StorageDirectoryDeletedEventData": { "type": "object", @@ -7595,7 +8526,10 @@ "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } - } + }, + "required": [ + "storageDiagnostics" + ] }, "StorageDirectoryRenamedEventData": { "type": "object", @@ -7634,7 +8568,10 @@ "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } - } + }, + "required": [ + "storageDiagnostics" + ] }, "StorageLifecyclePolicyActionSummaryDetail": { "type": "object", @@ -7676,7 +8613,12 @@ "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", "description": "Execution statistics of a specific policy action in a Blob Management cycle." } - } + }, + "required": [ + "deleteSummary", + "tierToCoolSummary", + "tierToArchiveSummary" + ] }, "StorageTaskAssignmentCompletedEventData": { "type": "object", @@ -7706,7 +8648,12 @@ "description": "The summary report blob url for a storage task", "x-ms-client-name": "summaryReportBlobUri" } - } + }, + "required": [ + "status", + "completedDateTime", + "summaryReportBlobUrl" + ] }, "StorageTaskAssignmentCompletedStatus": { "type": "string", @@ -7746,7 +8693,10 @@ "type": "string", "description": "The execution id for a storage task." } - } + }, + "required": [ + "queuedDateTime" + ] }, "StorageTaskCompletedEventData": { "type": "object", @@ -7774,7 +8724,12 @@ "format": "uri", "description": "The summary report blob url for a storage task" } - } + }, + "required": [ + "status", + "completedDateTime", + "summaryReportBlobUrl" + ] }, "StorageTaskCompletedStatus": { "type": "string", @@ -7813,32 +8768,32 @@ "type": "string", "description": "The execution id for a storage task." } - } + }, + "required": [ + "queuedDateTime" + ] }, "SubscriptionDeletedEventData": { "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.EventGrid.SystemEvents.SubscriptionDeletedEvent event.", + "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.EventGrid.SubscriptionDeletedEvent event.", "properties": { "eventSubscriptionId": { "type": "string", - "description": "The Azure resource ID of the deleted event subscription.", - "readOnly": true + "description": "The Azure resource ID of the deleted event subscription." } } }, "SubscriptionValidationEventData": { "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SystemEvents.SubscriptionValidationEvent event.", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent event.", "properties": { "validationCode": { "type": "string", - "description": "The validation code sent by Azure Event Grid to validate an event subscription.\nTo complete the validation handshake, the subscriber must either respond with this validation code as part of the validation response,\nor perform a GET request on the validationUrl (available starting version 2018-05-01-preview).", - "readOnly": true + "description": "The validation code sent by Azure Event Grid to validate an event subscription.\nTo complete the validation handshake, the subscriber must either respond with this validation code as part of the validation response,\nor perform a GET request on the validationUrl (available starting version 2018-05-01-preview)." }, "validationUrl": { "type": "string", - "description": "The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview).\nTo complete the validation handshake, the subscriber must either respond with the validationCode as part of the validation response,\nor perform a GET request on the validationUrl (available starting version 2018-05-01-preview).", - "readOnly": true + "description": "The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview).\nTo complete the validation handshake, the subscriber must either respond with the validationCode as part of the validation response,\nor perform a GET request on the validationUrl (available starting version 2018-05-01-preview)." } } }, @@ -7888,7 +8843,11 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appServicePlanEventTypeDetail", + "sku" + ] }, "WebAppServicePlanUpdatedEventDataSku": { "type": "object", @@ -7948,7 +8907,10 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appEventTypeDetail" + ] }, "WebBackupOperationCompletedEventData": { "type": "object", @@ -7982,7 +8944,10 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appEventTypeDetail" + ] }, "WebBackupOperationFailedEventData": { "type": "object", @@ -8016,7 +8981,10 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appEventTypeDetail" + ] }, "WebBackupOperationStartedEventData": { "type": "object", @@ -8050,7 +9018,10 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appEventTypeDetail" + ] }, "WebRestoreOperationCompletedEventData": { "type": "object", @@ -8084,7 +9055,10 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appEventTypeDetail" + ] }, "WebRestoreOperationFailedEventData": { "type": "object", @@ -8118,7 +9092,10 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appEventTypeDetail" + ] }, "WebRestoreOperationStartedEventData": { "type": "object", @@ -8152,7 +9129,10 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appEventTypeDetail" + ] }, "WebSlotSwapCompletedEventData": { "type": "object", @@ -8186,7 +9166,10 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appEventTypeDetail" + ] }, "WebSlotSwapFailedEventData": { "type": "object", @@ -8220,7 +9203,10 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appEventTypeDetail" + ] }, "WebSlotSwapStartedEventData": { "type": "object", @@ -8254,7 +9240,10 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appEventTypeDetail" + ] }, "WebSlotSwapWithPreviewCancelledEventData": { "type": "object", @@ -8288,7 +9277,10 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appEventTypeDetail" + ] }, "WebSlotSwapWithPreviewStartedEventData": { "type": "object", @@ -8322,7 +9314,10 @@ "type": "string", "description": "HTTP verb of this operation." } - } + }, + "required": [ + "appEventTypeDetail" + ] }, "recordingChannelType": { "type": "string", From ad9955f6175988f8c2082da671b3d6bca5fb5520 Mon Sep 17 00:00:00 2001 From: Joanna-Yang-Art <137839107+Joanna-Yang-Art@users.noreply.github.com> Date: Mon, 3 Jun 2024 15:57:55 -0700 Subject: [PATCH 22/49] Add new networking code owner (#29281) --- CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index 2353e3adc3cb..07cfc34e7c0c 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -159,7 +159,7 @@ /specification/monitor/ @gucalder # PRLabel: %Network -/specification/network/ @Joanna-Yang-Art +/specification/network/ @GuptaVertika # PRLabel: %Notification Hub /specification/notificationhubs/ @amolr @smithab From 12ff37009808948b5c7ed4a0d384181471f3219f Mon Sep 17 00:00:00 2001 From: Sherylueen Date: Tue, 4 Jun 2024 07:25:20 +0800 Subject: [PATCH 23/49] Sherylueen appcomplianceautomation microsoft.app compliance automation 2024 06 27 (#28981) * Adds base for updating Microsoft.AppComplianceAutomation from version preview/2022-11-16-preview to version 2024-06-27 * Updates readme * Updates API version in new specs and examples * add new stable version for Microsoft.AppComplianceAutomation * remove the useless example file * fix spell check * remove query in get evidence api * remove the singleton annotation * fix compile error * fix compile error of v56 * fix compile error * fix all compile error and make the swagger align with before * tsp prettier * change scoping name * upgrade the commontypes from v3 to v5 * change commonTypes version to v3 * add service-dir * format tspconfig.yaml * modify tspconfig.yaml * remove custom operations * modify re pattern of snapshot name * make the resource x-ms-client-name properties * format typespec * remove suffix of snapshot * use requestBody replace parameters * Revert "use requestBody replace parameters" This reverts commit e4dd975ea2b956032e71424b71cc486b7fc15fde. * tsp format * remove dotnet from tspconfig.yaml and add azure-sdk-for-net-track2 in readme * add sdk-suppressions.yaml * Update tspconfig.yaml * Update tspconfig.yaml * rename operationid * rename getScopingQuestions and move model reportBaseProperties to alias --------- Co-authored-by: Yanwen Liu Co-authored-by: Mark Cowlishaw Co-authored-by: Yuchao Yan Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: Weidong Xu --- .../2024-06-27/Evidence_CreateOrUpdate.json | 65 + .../examples/2024-06-27/Evidence_Delete.json | 13 + .../2024-06-27/Evidence_Download.json | 22 + .../examples/2024-06-27/Evidence_Get.json | 34 + .../2024-06-27/Evidence_ListByReport.json | 37 + ...InUseStorageAccountsWithSubscriptions.json | 33 + ...seStorageAccountsWithoutSubscriptions.json | 28 + .../examples/2024-06-27/Onboard.json | 29 + .../examples/2024-06-27/Operations_List.json | 25 + .../Report_CheckNameAvailability.json | 20 + .../2024-06-27/Report_CreateOrUpdate.json | 149 + .../examples/2024-06-27/Report_Delete.json | 17 + .../examples/2024-06-27/Report_Fix.json | 22 + .../examples/2024-06-27/Report_Get.json | 80 + .../2024-06-27/Report_GetCollectionCount.json | 18 + .../2024-06-27/Report_GetOverviewStatus.json | 30 + .../Report_GetScopingQuestions.json | 100 + .../examples/2024-06-27/Report_List.json | 88 + ...port_Evidence_Check_Name_Availability.json | 21 + ...port_Snapshot_Check_Name_Availability.json | 21 + ...eport_Webhook_Check_Name_Availability.json | 21 + .../2024-06-27/Report_SyncCertRecord.json | 39 + .../examples/2024-06-27/Report_Update.json | 109 + .../examples/2024-06-27/Report_Verify.json | 22 + .../ScopingConfiguration_CreateOrUpdate.json | 97 + .../ScopingConfiguration_Delete.json | 13 + .../2024-06-27/ScopingConfiguration_Get.json | 44 + .../2024-06-27/ScopingConfiguration_List.json | 47 + ...wnload_Compliance_Detailed_Pdf_Report.json | 29 + ...apshot_Download_Compliance_Pdf_Report.json | 29 + ...d_Snapshot_Download_Compliance_Report.json | 42 + ...nload_Snapshot_Download_Resource_List.json | 34 + .../examples/2024-06-27/Snapshot_Get.json | 184 + .../examples/2024-06-27/Snapshot_List.json | 194 + .../2024-06-27/TriggerEvaluation.json | 51 + .../2024-06-27/Webhook_CreateOrUpdate.json | 85 + .../examples/2024-06-27/Webhook_Delete.json | 13 + .../examples/2024-06-27/Webhook_Get.json | 41 + .../examples/2024-06-27/Webhook_List.json | 47 + .../examples/2024-06-27/Webhook_Update.json | 55 + .../main.tsp | 39 + .../models/models.tsp | 1876 +++++++ .../resources/EvidenceResource.tsp | 122 + .../resources/ReportResource.tsp | 191 + .../ScopingConfigurationResource.tsp | 96 + .../resources/SnapshotResource.tsp | 77 + .../resources/WebhookResource.tsp | 120 + .../routes.tsp | 91 + .../tspconfig.yaml | 34 + .../2024-06-27/appcomplianceautomation.json | 4552 +++++++++++++++++ .../examples/Evidence_CreateOrUpdate.json | 65 + .../2024-06-27/examples/Evidence_Delete.json | 13 + .../examples/Evidence_Download.json | 22 + .../2024-06-27/examples/Evidence_Get.json | 34 + .../examples/Evidence_ListByReport.json | 37 + ...InUseStorageAccountsWithSubscriptions.json | 33 + ...seStorageAccountsWithoutSubscriptions.json | 28 + .../stable/2024-06-27/examples/Onboard.json | 29 + .../2024-06-27/examples/Operations_List.json | 25 + .../Report_CheckNameAvailability.json | 20 + .../examples/Report_CreateOrUpdate.json | 149 + .../2024-06-27/examples/Report_Delete.json | 17 + .../2024-06-27/examples/Report_Fix.json | 22 + .../2024-06-27/examples/Report_Get.json | 80 + .../examples/Report_GetCollectionCount.json | 18 + .../examples/Report_GetOverviewStatus.json | 30 + .../examples/Report_GetScopingQuestions.json | 100 + .../2024-06-27/examples/Report_List.json | 88 + ...port_Evidence_Check_Name_Availability.json | 21 + ...port_Snapshot_Check_Name_Availability.json | 21 + ...eport_Webhook_Check_Name_Availability.json | 21 + .../examples/Report_SyncCertRecord.json | 39 + .../2024-06-27/examples/Report_Update.json | 109 + .../2024-06-27/examples/Report_Verify.json | 22 + .../ScopingConfiguration_CreateOrUpdate.json | 97 + .../examples/ScopingConfiguration_Delete.json | 13 + .../examples/ScopingConfiguration_Get.json | 44 + .../examples/ScopingConfiguration_List.json | 47 + ...wnload_Compliance_Detailed_Pdf_Report.json | 29 + ...apshot_Download_Compliance_Pdf_Report.json | 29 + ...d_Snapshot_Download_Compliance_Report.json | 42 + ...nload_Snapshot_Download_Resource_List.json | 34 + .../2024-06-27/examples/Snapshot_Get.json | 184 + .../2024-06-27/examples/Snapshot_List.json | 194 + .../examples/TriggerEvaluation.json | 51 + .../examples/Webhook_CreateOrUpdate.json | 85 + .../2024-06-27/examples/Webhook_Delete.json | 13 + .../2024-06-27/examples/Webhook_Get.json | 41 + .../2024-06-27/examples/Webhook_List.json | 47 + .../2024-06-27/examples/Webhook_Update.json | 55 + .../resource-manager/readme.md | 13 +- .../resource-manager/sdk-suppressions.yaml | 35 + 92 files changed, 11340 insertions(+), 2 deletions(-) create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_CreateOrUpdate.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_Delete.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_Download.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_Get.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_ListByReport.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ListInUseStorageAccountsWithSubscriptions.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ListInUseStorageAccountsWithoutSubscriptions.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Onboard.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Operations_List.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_CheckNameAvailability.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_CreateOrUpdate.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Delete.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Fix.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Get.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_GetCollectionCount.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_GetOverviewStatus.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_GetScopingQuestions.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_List.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_NestedResourceCheckNameAvailability_Report_Evidence_Check_Name_Availability.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_NestedResourceCheckNameAvailability_Report_Snapshot_Check_Name_Availability.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_NestedResourceCheckNameAvailability_Report_Webhook_Check_Name_Availability.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_SyncCertRecord.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Update.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Verify.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_CreateOrUpdate.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_Delete.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_Get.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_List.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Compliance_Detailed_Pdf_Report.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Compliance_Pdf_Report.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Compliance_Report.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Resource_List.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Get.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_List.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/TriggerEvaluation.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_CreateOrUpdate.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_Delete.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_Get.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_List.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_Update.json create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/main.tsp create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/models/models.tsp create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/EvidenceResource.tsp create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/ReportResource.tsp create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/ScopingConfigurationResource.tsp create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/SnapshotResource.tsp create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/WebhookResource.tsp create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/routes.tsp create mode 100644 specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/appcomplianceautomation.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_CreateOrUpdate.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_Delete.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_Download.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_Get.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_ListByReport.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ListInUseStorageAccountsWithSubscriptions.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ListInUseStorageAccountsWithoutSubscriptions.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Onboard.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Operations_List.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_CheckNameAvailability.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_CreateOrUpdate.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Delete.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Fix.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Get.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_GetCollectionCount.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_GetOverviewStatus.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_GetScopingQuestions.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_List.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_NestedResourceCheckNameAvailability_Report_Evidence_Check_Name_Availability.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_NestedResourceCheckNameAvailability_Report_Snapshot_Check_Name_Availability.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_NestedResourceCheckNameAvailability_Report_Webhook_Check_Name_Availability.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_SyncCertRecord.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Update.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Verify.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_CreateOrUpdate.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_Delete.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_Get.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_List.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Compliance_Detailed_Pdf_Report.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Compliance_Pdf_Report.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Compliance_Report.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Resource_List.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Get.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_List.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/TriggerEvaluation.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_CreateOrUpdate.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_Delete.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_Get.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_List.json create mode 100644 specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_Update.json create mode 100644 specification/appcomplianceautomation/resource-manager/sdk-suppressions.yaml diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_CreateOrUpdate.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_CreateOrUpdate.json new file mode 100644 index 000000000000..af439f4648bc --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_CreateOrUpdate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "evidenceName": "evidence1", + "parameters": { + "properties": { + "controlId": "Operational_Security_10", + "evidenceType": "File", + "filePath": "/test-byos/evidence1.png", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services" + } + }, + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "name": "evidence1", + "type": "Microsfot.AppComplianceAutomation/reports/evidences", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/evidences/evidence1", + "properties": { + "controlId": "Operational_Security_10", + "evidenceType": "File", + "extraData": "sampleData", + "filePath": "/acat-container/evidence1.png", + "provisioningState": "Succeeded", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "evidence1", + "type": "Microsfot.AppComplianceAutomation/reports/evidences", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/evidences/evidence1", + "properties": { + "controlId": "Operational_Security_10", + "evidenceType": "File", + "extraData": "sampleData", + "filePath": "/acat-container/evidence1.png", + "provisioningState": "Succeeded", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Evidence_CreateOrUpdate", + "title": "Evidence_CreateOrUpdate" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_Delete.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_Delete.json new file mode 100644 index 000000000000..890214acc94b --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "evidenceName": "evidence1", + "reportName": "testReportName" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Evidence_Delete", + "title": "Evidence_Delete" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_Download.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_Download.json new file mode 100644 index 000000000000..7827cea38d1f --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_Download.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "evidenceName": "evidence1", + "parameters": { + "offerGuid": "00000000-0000-0000-0000-000000000000", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000" + }, + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "evidenceFile": { + "url": "this is a url" + } + } + } + }, + "operationId": "Evidence_Download", + "title": "Evidence_Download" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_Get.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_Get.json new file mode 100644 index 000000000000..3ce86f20bad4 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "evidenceName": "evidence1", + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "name": "evidence1", + "type": "Microsfot.AppComplianceAutomation/reports/evidences", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/evidences/evidence1", + "properties": { + "controlId": "Operational_Security_10", + "evidenceType": "File", + "extraData": "sampleData", + "filePath": "/acat-container/evidence1.png", + "provisioningState": "Succeeded", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Evidence_Get", + "title": "Evidence_Get" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_ListByReport.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_ListByReport.json new file mode 100644 index 000000000000..b93a76ee8334 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Evidence_ListByReport.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "reportName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "evidence1", + "type": "Microsfot.AppComplianceAutomation/reports/evidences", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/evidences/evidence1", + "properties": { + "controlId": "Operational_Security_10", + "evidenceType": "File", + "extraData": "sampleData", + "filePath": "/acat-container/evidence1.png", + "provisioningState": "Succeeded", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + ] + } + } + }, + "operationId": "Evidence_ListByReport", + "title": "Evidence_ListByReport" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ListInUseStorageAccountsWithSubscriptions.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ListInUseStorageAccountsWithSubscriptions.json new file mode 100644 index 000000000000..e5596d869abe --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ListInUseStorageAccountsWithSubscriptions.json @@ -0,0 +1,33 @@ +{ + "operationId": "ProviderActions_ListInUseStorageAccounts", + "title": "ListInUseStorageAccountsWithSubscriptions", + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "subscriptionIds": [ + "0000000-0000-0000-0000-000000000001", + "0000000-0000-0000-0000-000000000002" + ] + } + }, + "responses": { + "200": { + "body": { + "storageAccountList": [ + { + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroup": "tetsRG", + "accountName": "SA_name1", + "location": "WEST US" + }, + { + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroup": "tetsRG", + "accountName": "SA_name2", + "location": "WEST US" + } + ] + } + } + } +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ListInUseStorageAccountsWithoutSubscriptions.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ListInUseStorageAccountsWithoutSubscriptions.json new file mode 100644 index 000000000000..7b9ccfcd9e83 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ListInUseStorageAccountsWithoutSubscriptions.json @@ -0,0 +1,28 @@ +{ + "operationId": "ProviderActions_ListInUseStorageAccounts", + "title": "ListInUseStorageAccountsWithoutSubscriptions", + "parameters": { + "api-version": "2024-06-27", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "storageAccountList": [ + { + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroup": "tetsRG", + "accountName": "SA_name1", + "location": "WEST US" + }, + { + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroup": "tetsRG", + "accountName": "SA_name2", + "location": "WEST US" + } + ] + } + } + } +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Onboard.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Onboard.json new file mode 100644 index 000000000000..3aaaff41bbd4 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Onboard.json @@ -0,0 +1,29 @@ +{ + "operationId": "ProviderActions_Onboard", + "title": "Onboard", + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "subscriptionIds": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001" + ] + } + }, + "responses": { + "200": { + "body": { + "subscriptionIds": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001" + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}", + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}" + } + } + } +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Operations_List.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Operations_List.json new file mode 100644 index 000000000000..289f672cdec0 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Operations_List.json @@ -0,0 +1,25 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AppComplianceAutomation/reports/write", + "isDataAction": false, + "display": { + "provider": "Microsoft AppComplianceAutomation", + "resource": "Microsoft.AppComplianceAutomation/reports", + "operation": "Microsoft.AppComplianceAutomation/reports/write", + "description": "Create new reports." + } + } + ] + } + } + } +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_CheckNameAvailability.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_CheckNameAvailability.json new file mode 100644 index 000000000000..bcd762897e0a --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "operationId": "ProviderActions_CheckNameAvailability", + "title": "Report_CheckNameAvailability", + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "name": "reportABC", + "type": "Microsoft.AppComplianceAutomation/reports" + } + }, + "responses": { + "200": { + "body": { + "message": "An report named 'reportABC' is already in use.", + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + } +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_CreateOrUpdate.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_CreateOrUpdate.json new file mode 100644 index 000000000000..2efea20388ba --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_CreateOrUpdate.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "properties": { + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + } + ], + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-04T05:00:00.000Z" + } + }, + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "name": "testReportName", + "type": "Microsfot.AppComplianceAutomation/reports", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName", + "properties": { + "certRecords": [ + { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + ], + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "passedCount": 0 + } + }, + "lastTriggerTime": "2022-03-02T05:00:00.000Z", + "nextTriggerTime": "2022-03-02T05:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Active", + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-02T05:00:00.000Z" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "testReportName", + "type": "Microsfot.AppComplianceAutomation/reports", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName", + "properties": { + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "passedCount": 0 + } + }, + "lastTriggerTime": "2022-03-02T05:00:00.000Z", + "nextTriggerTime": "2022-03-02T05:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Active", + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-02T05:00:00.000Z" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Report_CreateOrUpdate", + "title": "Report_CreateOrUpdate" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Delete.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Delete.json new file mode 100644 index 000000000000..80a2ac5a5f87 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + }, + "204": {} + }, + "operationId": "Report_Delete", + "title": "Report_Delete" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Fix.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Fix.json new file mode 100644 index 000000000000..bcc813dce1b6 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Fix.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReport" + }, + "responses": { + "200": { + "body": { + "reason": "", + "result": "Succeeded" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Report_Fix", + "title": "Report_Fix" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Get.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Get.json new file mode 100644 index 000000000000..968fefe131b4 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Get.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReport" + }, + "responses": { + "200": { + "body": { + "name": "testReportName", + "type": "Microsfot.AppComplianceAutomation/reports", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName", + "properties": { + "certRecords": [ + { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + ], + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "passedCount": 0 + } + }, + "errors": [ + "resource-inaccessible" + ], + "lastTriggerTime": "2022-03-02T05:00:00.000Z", + "nextTriggerTime": "2022-03-02T05:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Failed", + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-02T05:00:00.000Z" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Report_Get", + "title": "Report_Get" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_GetCollectionCount.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_GetCollectionCount.json new file mode 100644 index 000000000000..5bc1b448f3d4 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_GetCollectionCount.json @@ -0,0 +1,18 @@ +{ + "operationId": "ProviderActions_GetCollectionCount", + "title": "Report_GetCollectionCount", + "parameters": { + "api-version": "2024-06-27", + "$filter": "Name eq 'Milk'", + "parameters": { + "type": "Microsoft.AppComplianceAutomation/reports" + } + }, + "responses": { + "200": { + "body": { + "count": 100 + } + } + } +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_GetOverviewStatus.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_GetOverviewStatus.json new file mode 100644 index 000000000000..1ddbfccb5cb5 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_GetOverviewStatus.json @@ -0,0 +1,30 @@ +{ + "operationId": "ProviderActions_GetOverviewStatus", + "title": "Report_GetOverviewStatus", + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "type": "Microsoft.AppComplianceAutomation/reports" + } + }, + "responses": { + "200": { + "body": { + "statusList": [ + { + "statusName": "Active", + "statusValue": "100" + }, + { + "statusName": "Failed", + "statusValue": "0" + }, + { + "statusName": "Disabled", + "statusValue": "0" + } + ] + } + } + } +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_GetScopingQuestions.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_GetScopingQuestions.json new file mode 100644 index 000000000000..08ef357ea5fd --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_GetScopingQuestions.json @@ -0,0 +1,100 @@ +{ + "operationId": "Report_GetScopingQuestions", + "title": "Report_GetScopingQuestions", + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "questions": [ + { + "questionId": "DHP_G07_customerDataProcess", + "inputType": "Boolean", + "optionIds": [], + "rules": [ + "Required" + ], + "showSubQuestionsValue": "true", + "superiorQuestionId": null + }, + { + "questionId": "DHP_G04_graphPermissionData", + "inputType": "Text", + "optionIds": [], + "rules": [ + "Required", + "CharLength" + ], + "showSubQuestionsValue": null, + "superiorQuestionId": "DHP_G07_customerDataProcess" + }, + { + "questionId": "DHP_G06_customerDataStorage", + "inputType": "Boolean", + "optionIds": [], + "rules": [ + "Required" + ], + "showSubQuestionsValue": "true", + "superiorQuestionId": null + }, + { + "questionId": "DHP_G05_graphPermissionInfo", + "inputType": "Text", + "optionIds": [], + "rules": [ + "Required", + "CharLength", + "PreventNonEnglishChar" + ], + "showSubQuestionsValue": null, + "superiorQuestionId": "DHP_G06_customerDataStorage" + }, + { + "questionId": "DHP_G08_storageLocation", + "inputType": "MultiSelectDropdown", + "optionIds": [ + "Croatia", + "Cuba", + "Curaçao", + "Cyprus", + "Czechia", + "Côte d'Ivoire", + "Denmark", + "Djibouti", + "Dominica", + "Dominican Republic (the)", + "Ecuador", + "Egypt" + ], + "rules": [ + "Required" + ], + "showSubQuestionsValue": null, + "superiorQuestionId": "DHP_G06_customerDataStorage" + }, + { + "questionId": "LEG03_complianceDataTermination", + "superiorQuestionId": "DHP_G06_customerDataStorage", + "inputType": "SingleSelectEnum", + "optionIds": [], + "rules": [ + "Required" + ], + "showSubQuestionsValue": null + } + ] + }, + "systemData": { + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "createdAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z" + } + } + } +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_List.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_List.json new file mode 100644 index 000000000000..0821ff0492b8 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_List.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "$skipToken": "1", + "$top": "100", + "api-version": "2024-06-27", + "offerGuid": "00000000-0000-0000-0000-000000000000", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports?api-version=2024-06-27&skipToken=1&top=100", + "value": [ + { + "name": "testReportName", + "type": "Microsfot.AppComplianceAutomation/reports", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName", + "properties": { + "certRecords": [ + { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + ], + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "notApplicableCount": 0, + "passedCount": 0, + "pendingCount": 0 + } + }, + "errors": [], + "lastTriggerTime": "2022-03-02T05:00:00.000Z", + "nextTriggerTime": "2022-03-02T05:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Active", + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-02T05:00:00.000Z" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + ] + } + } + }, + "operationId": "Report_List", + "title": "Report_List" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_NestedResourceCheckNameAvailability_Report_Evidence_Check_Name_Availability.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_NestedResourceCheckNameAvailability_Report_Evidence_Check_Name_Availability.json new file mode 100644 index 000000000000..b15d2c857cb6 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_NestedResourceCheckNameAvailability_Report_Evidence_Check_Name_Availability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "name": "evidenceABC", + "type": "Microsoft.AppComplianceAutomation/reports/evidences" + }, + "reportName": "reportABC" + }, + "responses": { + "200": { + "body": { + "message": "An evidence named 'evidenceABC' is already in use.", + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + }, + "operationId": "Report_NestedResourceCheckNameAvailability", + "title": "Report_EvidenceCheckNameAvailability" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_NestedResourceCheckNameAvailability_Report_Snapshot_Check_Name_Availability.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_NestedResourceCheckNameAvailability_Report_Snapshot_Check_Name_Availability.json new file mode 100644 index 000000000000..4064467ccddc --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_NestedResourceCheckNameAvailability_Report_Snapshot_Check_Name_Availability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "name": "snapshotABC", + "type": "Microsoft.AppComplianceAutomation/reports/snapshots" + }, + "reportName": "reportABC" + }, + "responses": { + "200": { + "body": { + "message": "An snapshot named 'snapshotABC' is already in use.", + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + }, + "operationId": "Report_NestedResourceCheckNameAvailability", + "title": "Report_SnapshotCheckNameAvailability" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_NestedResourceCheckNameAvailability_Report_Webhook_Check_Name_Availability.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_NestedResourceCheckNameAvailability_Report_Webhook_Check_Name_Availability.json new file mode 100644 index 000000000000..388d47f9a2c2 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_NestedResourceCheckNameAvailability_Report_Webhook_Check_Name_Availability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "name": "webhookABC", + "type": "Microsoft.AppComplianceAutomation/reports/webhooks" + }, + "reportName": "reportABC" + }, + "responses": { + "200": { + "body": { + "message": "An webhook named 'webhookABC' is already in use.", + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + }, + "operationId": "Report_NestedResourceCheckNameAvailability", + "title": "Report_WebhookCheckNameAvailability" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_SyncCertRecord.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_SyncCertRecord.json new file mode 100644 index 000000000000..00f3a43324da --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_SyncCertRecord.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "certRecord": { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + }, + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "certRecord": { + "offerGuid": "addb13fc-64bf-4005-b693-4c2f094e2187", + "certificationStatus": "CertIngestion", + "ingestionStatus": "InitialDocumentResubmitted", + "controls": [] + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Report_SyncCertRecord", + "title": "Report_SyncCertRecord" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Update.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Update.json new file mode 100644 index 000000000000..fba98d1d3712 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Update.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "properties": { + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-04T05:00:00.000Z" + } + }, + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "name": "testReportName", + "type": "Microsfot.AppComplianceAutomation/reports", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName", + "properties": { + "certRecords": [ + { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + ], + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "passedCount": 0 + } + }, + "lastTriggerTime": "2022-03-02T05:00:00.000Z", + "nextTriggerTime": "2022-03-02T05:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Active", + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-02T05:00:00.000Z" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Report_Update", + "title": "Report_Update" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Verify.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Verify.json new file mode 100644 index 000000000000..e41d7293a90b --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Report_Verify.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReport" + }, + "responses": { + "200": { + "body": { + "reason": "", + "result": "Succeeded" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Report_Verify", + "title": "Report_Verify" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_CreateOrUpdate.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_CreateOrUpdate.json new file mode 100644 index 000000000000..ac5ce8c3467a --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_CreateOrUpdate.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName", + "scopingConfigurationName": "default", + "parameters": { + "properties": { + "answers": [ + { + "answers": [ + "Azure" + ], + "questionId": "GEN20_hostingEnvironment" + }, + { + "answers": [], + "questionId": "DHP_G07_customerDataProcess" + }, + { + "answers": [], + "questionId": "Tier2InitSub_serviceCommunicate" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AppComplianceAutomation/reports/scopingConfigurations", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/scopingConfigurations/default", + "properties": { + "answers": [ + { + "answers": [ + "Azure" + ], + "questionId": "GEN20_hostingEnvironment" + }, + { + "answers": [], + "questionId": "DHP_G07_customerDataProcess" + }, + { + "answers": [], + "questionId": "Tier2InitSub_serviceCommunicate" + } + ] + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.AppComplianceAutomation/reports/scopingConfigurations", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/scopingConfigurations/default", + "properties": { + "answers": [ + { + "answers": [ + "Azure" + ], + "questionId": "GEN20_hostingEnvironment" + }, + { + "answers": [], + "questionId": "DHP_G07_customerDataProcess" + }, + { + "answers": [], + "questionId": "Tier2InitSub_serviceCommunicate" + } + ] + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "ScopingConfiguration_CreateOrUpdate", + "title": "ScopingConfiguration_CreateOrUpdate" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_Delete.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_Delete.json new file mode 100644 index 000000000000..f5a132637ae2 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName", + "scopingConfigurationName": "default" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ScopingConfiguration_Delete", + "title": "ScopingConfiguration_Delete" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_Get.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_Get.json new file mode 100644 index 000000000000..5ec5a51c5190 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName", + "scopingConfigurationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AppComplianceAutomation/reports/scopingConfigurations", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/scopingConfigurations/default", + "properties": { + "answers": [ + { + "answers": [ + "Azure" + ], + "questionId": "GEN20_hostingEnvironment" + }, + { + "answers": [], + "questionId": "DHP_G07_customerDataProcess" + }, + { + "answers": [], + "questionId": "Tier2InitSub_serviceCommunicate" + } + ] + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "ScopingConfiguration_Get", + "title": "ScopingConfiguration" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_List.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_List.json new file mode 100644 index 000000000000..d29f4275ceb8 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/ScopingConfiguration_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AppComplianceAutomation/reports/scopingConfigurations", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/scopingConfigurations/default", + "properties": { + "answers": [ + { + "answers": [ + "Azure" + ], + "questionId": "GEN20_hostingEnvironment" + }, + { + "answers": [], + "questionId": "DHP_G07_customerDataProcess" + }, + { + "answers": [], + "questionId": "Tier2InitSub_serviceCommunicate" + } + ] + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + ] + } + } + }, + "operationId": "ScopingConfiguration_List", + "title": "ScopingConfiguration_List" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Compliance_Detailed_Pdf_Report.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Compliance_Detailed_Pdf_Report.json new file mode 100644 index 000000000000..d84be3fd0ea1 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Compliance_Detailed_Pdf_Report.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "downloadType": "ComplianceDetailedPdfReport", + "offerGuid": "00000000-0000-0000-0000-000000000000", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000" + }, + "reportName": "testReportName", + "snapshotName": "testSnapshotName" + }, + "responses": { + "200": { + "body": { + "complianceDetailedPdfReport": { + "sasUri": "this is a uri" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Snapshot_Download", + "title": "Snapshot_Download_ComplianceDetailedPdfReport" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Compliance_Pdf_Report.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Compliance_Pdf_Report.json new file mode 100644 index 000000000000..fab4b64e88d1 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Compliance_Pdf_Report.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "downloadType": "CompliancePdfReport", + "offerGuid": "00000000-0000-0000-0000-000000000001", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000" + }, + "reportName": "testReportName", + "snapshotName": "testSnapshotName" + }, + "responses": { + "200": { + "body": { + "compliancePdfReport": { + "sasUri": "this is uri of report" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Snapshot_Download", + "title": "Snapshot_Download_CompliancePdfReport" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Compliance_Report.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Compliance_Report.json new file mode 100644 index 000000000000..e7e5d3d67aed --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Compliance_Report.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "downloadType": "ComplianceReport", + "offerGuid": "00000000-0000-0000-0000-000000000001", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000" + }, + "reportName": "testReportName", + "snapshotName": "testSnapshotName" + }, + "responses": { + "200": { + "body": { + "complianceReport": [ + { + "categoryName": "Data Security & Privacy", + "controlFamilyName": "Incident Response", + "controlId": "Operational_Security_75", + "controlName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlStatus": "Passed", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceStatus": "Healthy", + "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z", + "resourceType": "Microsoft.SignalRService/SignalR", + "responsibilityDescription": "Restrict access to the Kubernetes Service Management API by granting API access only to IP addresses in specific ranges. It is recommended to limit access to authorized IP ranges to ensure that only applications from allowed networks can access the cluster.", + "responsibilityTitle": "Authorized IP ranges should be defined on Kubernetes Services" + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Snapshot_Download", + "title": "Snapshot_Download_ComplianceReport" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Resource_List.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Resource_List.json new file mode 100644 index 000000000000..603716a5154a --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Download_Snapshot_Download_Resource_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "downloadType": "ResourceList", + "offerGuid": "00000000-0000-0000-0000-000000000001", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000" + }, + "reportName": "testReportName", + "snapshotName": "testSnapshotName" + }, + "responses": { + "200": { + "body": { + "resourceList": [ + { + "resourceGroup": "myResourceGroup", + "resourceId": "mySignalRService", + "resourceType": "SignalR", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Snapshot_Download", + "title": "Snapshot_Download_ResourceList" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Get.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Get.json new file mode 100644 index 000000000000..9637ea243640 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_Get.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName", + "snapshotName": "testSnapshot" + }, + "responses": { + "200": { + "body": { + "name": "testSnapshot", + "type": "Microsfot.AppComplianceAutomation/reports/snapshots", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/snapshots/testSnapshot", + "properties": { + "complianceResults": [ + { + "categories": [ + { + "categoryName": "Operational Security", + "categoryStatus": "Passed", + "controlFamilies": [ + { + "controlFamilyName": "Incident Response", + "controlFamilyStatus": "Passed", + "controls": [ + { + "controlDescription": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlDescriptionHyperLink": "https://aka.ms/acat/m365cert/operational/control73", + "controlFullName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlId": "Operational_Security_75", + "controlName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlStatus": "Passed", + "responsibilities": [ + { + "evidenceFiles": [ + "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/reportABC/fileName?api-version=2024-06-27" + ], + "failedResourceCount": 0, + "guidance": "Please upload the screen capture file to ACAT service.", + "justification": "Here is my evidence files", + "recommendationList": [ + { + "recommendationId": "failed_reason_1", + "recommendationShortName": "Invalid TLS Config", + "recommendationSolutions": [ + { + "isRecommendSolution": "true", + "recommendationSolutionContent": "Setting minimal TLS version to 1.2 improves security by ensuring your SQL Managed Instance can only be accessed from clients using TLS 1.2. Using versions of TLS less than 1.2 is not recommended since they have well documented security vulnerabilities", + "recommendationSolutionIndex": "1" + } + ] + }, + { + "recommendationId": "failed_reason_2", + "recommendationShortName": "Invalid AWS TLS Config", + "recommendationSolutions": [ + { + "isRecommendSolution": "true", + "recommendationSolutionContent": "Open the AWS related service, and set its TLS version to 1.2 or higher version.", + "recommendationSolutionIndex": "1" + } + ] + } + ], + "resourceList": [ + { + "recommendationIds": [ + "failed_reason_1" + ], + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceStatus": "Unhealthy", + "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "recommendationIds": [ + "failed_reason_2" + ], + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceStatus": "Unhealthy", + "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z", + "resourceType": "iam.user" + } + ], + "responsibilityDescription": "Restrict access to the Kubernetes Service Management API by granting API access only to IP addresses in specific ranges. It is recommended to limit access to authorized IP ranges to ensure that only applications from allowed networks can access the cluster.", + "responsibilityEnvironment": "Azure", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services", + "responsibilitySeverity": "High", + "responsibilityStatus": "Passed", + "responsibilityTitle": "Authorized IP ranges should be defined on Kubernetes Services", + "responsibilityType": "Automated", + "totalResourceCount": 1 + } + ] + } + ] + } + ] + } + ], + "complianceName": "M365" + } + ], + "createdAt": "2022-03-04T15:33:59.160Z", + "provisioningState": "Succeeded", + "reportProperties": { + "certRecords": [ + { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + ], + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "passedCount": 0 + } + }, + "errors": [], + "lastTriggerTime": "2022-03-04T15:00:00.000Z", + "nextTriggerTime": "2022-03-04T15:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Active", + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-04T15:00:00.000Z" + }, + "reportSystemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + }, + "snapshotName": "testSnapshot" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Snapshot_Get", + "title": "Snapshot_Get" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_List.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_List.json new file mode 100644 index 000000000000..592c4f1160b5 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Snapshot_List.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "$skipToken": "1", + "$top": "100", + "api-version": "2024-06-27", + "offerGuid": "00000000-0000-0000-0000-000000000001", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000", + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReportName/snapshots?api-version=2024-06-27&skipToken=1&top=100", + "value": [ + { + "name": "testSnapshot", + "type": "Microsfot.AppComplianceAutomation/reports/snapshots", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/snapshots/testSnapshot", + "properties": { + "complianceResults": [ + { + "categories": [ + { + "categoryName": "Operational Security", + "categoryStatus": "Passed", + "controlFamilies": [ + { + "controlFamilyName": "Incident Response", + "controlFamilyStatus": "Passed", + "controls": [ + { + "controlDescription": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlDescriptionHyperLink": "https://aka.ms/acat/m365cert/operational/control73", + "controlFullName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlId": "Operational_Security_75", + "controlName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlStatus": "Passed", + "responsibilities": [ + { + "evidenceFiles": [ + "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/reportABC/fileName?api-version=2024-06-27" + ], + "failedResourceCount": 0, + "guidance": "Please upload the screen capture file to ACAT service.", + "justification": "Here is my evidence files", + "recommendationList": [ + { + "recommendationId": "failed_reason_1", + "recommendationShortName": "Invalid TLS Config", + "recommendationSolutions": [ + { + "isRecommendSolution": "true", + "recommendationSolutionContent": "Setting minimal TLS version to 1.2 improves security by ensuring your SQL Managed Instance can only be accessed from clients using TLS 1.2. Using versions of TLS less than 1.2 is not recommended since they have well documented security vulnerabilities", + "recommendationSolutionIndex": "1" + } + ] + }, + { + "recommendationId": "failed_reason_2", + "recommendationShortName": "Invalid AWS TLS Config", + "recommendationSolutions": [ + { + "isRecommendSolution": "true", + "recommendationSolutionContent": "Open the AWS related service, and set its TLS version to 1.2 or higher version.", + "recommendationSolutionIndex": "1" + } + ] + } + ], + "resourceList": [ + { + "recommendationIds": [ + "failed_reason_1" + ], + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceStatus": "Unhealthy", + "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "recommendationIds": [ + "failed_reason_2" + ], + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceStatus": "Unhealthy", + "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z", + "resourceType": "iam.user" + } + ], + "responsibilityDescription": "Restrict access to the Kubernetes Service Management API by granting API access only to IP addresses in specific ranges. It is recommended to limit access to authorized IP ranges to ensure that only applications from allowed networks can access the cluster.", + "responsibilityEnvironment": "Azure", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services", + "responsibilitySeverity": "High", + "responsibilityStatus": "Passed", + "responsibilityTitle": "Authorized IP ranges should be defined on Kubernetes Services", + "responsibilityType": "Automated", + "totalResourceCount": 1 + } + ] + } + ] + } + ] + } + ], + "complianceName": "M365" + } + ], + "createdAt": "2022-03-04T15:33:59.160Z", + "provisioningState": "Succeeded", + "reportProperties": { + "certRecords": [ + { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + ], + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "notApplicableCount": 0, + "passedCount": 0, + "pendingCount": 0 + } + }, + "errors": [], + "lastTriggerTime": "2022-03-04T15:00:00.000Z", + "nextTriggerTime": "2022-03-04T15:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Active", + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-04T15:00:00.000Z" + }, + "reportSystemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + }, + "snapshotName": "testSnapshot" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + ] + } + } + }, + "operationId": "Snapshot_List", + "title": "Snapshot_List" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/TriggerEvaluation.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/TriggerEvaluation.json new file mode 100644 index 000000000000..e9fd6273c264 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/TriggerEvaluation.json @@ -0,0 +1,51 @@ +{ + "operationId": "ProviderActions_TriggerEvaluation", + "title": "TriggerEvaluation", + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "resourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService" + ] + } + }, + "responses": { + "200": { + "body": { + "properties": { + "evaluationEndTime": "2022-03-04T05:10:00.000Z", + "quickAssessments": [ + { + "description": "Protect your storage accounts from potential threats using virtual network rules as a preferred method instead of IP-based filtering. Disabling IP-based filtering prevents public IPs from accessing your storage accounts.", + "displayName": "Storage accounts should restrict network access using virtual network rules", + "remediationLink": "Protect your storage accounts from potential threats using virtual network rules as a preferred method instead of IP-based filtering. Disabling IP-based filtering prevents public IPs from accessing your storage accounts.", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storettas3iw2megtcarm", + "resourceStatus": "Healthy", + "responsibilityId": "/providers/microsoft.authorization/policydefinitions/2a1a9cdf-e04d-429a-8416-3bfb72a1b26f", + "timestamp": "2022-03-04T05:00:00.000Z" + }, + { + "description": "", + "displayName": "Secure transfer to storage accounts should be enabled", + "remediationLink": "", + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storettas3iw2megtcarm", + "resourceStatus": "Unhealthy", + "responsibilityId": "/providers/Microsoft.Authorization/policyDefinitions/404c3081-a854-4457-ae30-26a93ef643f9", + "timestamp": "2022-03-04T05:00:00.000Z" + } + ], + "resourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storettas3iw2megtcarm" + ], + "triggerTime": "2022-03-04T05:00:00.000Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + } +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_CreateOrUpdate.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_CreateOrUpdate.json new file mode 100644 index 000000000000..02279408de64 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "properties": { + "contentType": "application/json", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "sendAllEvents": "false", + "status": "Enabled", + "updateWebhookKey": "true", + "webhookKey": "00000000-0000-0000-0000-000000000000" + } + }, + "reportName": "testReportName", + "webhookName": "testWebhookName" + }, + "responses": { + "200": { + "body": { + "name": "testWebhookName", + "type": "Microsfot.AppComplianceAutomation/reports/webhooks", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/webhooks/testWebhookName", + "properties": { + "contentType": "application/json", + "deliveryStatus": "Succeeded", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "provisioningState": "Succeeded", + "sendAllEvents": "false", + "status": "Enabled", + "tenantId": "00000000-0000-0000-0000-000000000000", + "webhookId": "00000000-0000-0000-0000-000000000000", + "webhookKeyEnabled": "true" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "testWebhookName", + "type": "Microsfot.AppComplianceAutomation/reports/webhooks", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/webhooks/testWebhookName", + "properties": { + "contentType": "application/json", + "deliveryStatus": "Succeeded", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "provisioningState": "Succeeded", + "sendAllEvents": "false", + "status": "Enabled", + "tenantId": "00000000-0000-0000-0000-000000000000", + "webhookId": "00000000-0000-0000-0000-000000000000", + "webhookKeyEnabled": "true" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Webhook_CreateOrUpdate", + "title": "Webhook_CreateOrUpdate" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_Delete.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_Delete.json new file mode 100644 index 000000000000..681e90bfaf99 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName", + "webhookName": "testWebhookName" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Webhook_Delete", + "title": "Webhook_Delete" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_Get.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_Get.json new file mode 100644 index 000000000000..8433044df3b6 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName", + "webhookName": "testWebhookName" + }, + "responses": { + "200": { + "body": { + "name": "testWebhookName", + "type": "Microsfot.AppComplianceAutomation/reports/webhooks", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/webhooks/testWebhookName", + "properties": { + "contentType": "application/json", + "deliveryStatus": "Succeeded", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "provisioningState": "Succeeded", + "sendAllEvents": "false", + "status": "Enabled", + "tenantId": "00000000-0000-0000-0000-000000000000", + "webhookId": "00000000-0000-0000-0000-000000000000", + "webhookKeyEnabled": "true" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Webhook_Get", + "title": "Webhook_Get" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_List.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_List.json new file mode 100644 index 000000000000..5218b564374a --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "$skipToken": "1", + "$top": "100", + "api-version": "2024-06-27", + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReportName/webhooks?api-version=2024-06-27&skipToken=1&top=100", + "value": [ + { + "name": "testWebhookName", + "type": "Microsfot.AppComplianceAutomation/reports/webhooks", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/snapshots/testWebhookName", + "properties": { + "contentType": "application/json", + "deliveryStatus": "Succeeded", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "provisioningState": "Succeeded", + "sendAllEvents": "false", + "status": "Enabled", + "tenantId": "00000000-0000-0000-0000-000000000000", + "webhookId": "00000000-0000-0000-0000-000000000000", + "webhookKeyEnabled": "false" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + ] + } + } + }, + "operationId": "Webhook_List", + "title": "Webhook_List" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_Update.json b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_Update.json new file mode 100644 index 000000000000..d30eb32aadbe --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/examples/2024-06-27/Webhook_Update.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "properties": { + "contentType": "application/json", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "sendAllEvents": "false", + "status": "Enabled", + "updateWebhookKey": "true", + "webhookKey": "00000000-0000-0000-0000-000000000000" + } + }, + "reportName": "testReportName", + "webhookName": "testWebhookName" + }, + "responses": { + "200": { + "body": { + "name": "testWebhookName", + "type": "Microsfot.AppComplianceAutomation/reports/webhooks", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/testWebhookName", + "properties": { + "contentType": "application/json", + "deliveryStatus": "Succeeded", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "provisioningState": "Succeeded", + "sendAllEvents": "false", + "status": "Enabled", + "tenantId": "00000000-0000-0000-0000-000000000000", + "webhookId": "00000000-0000-0000-0000-000000000000", + "webhookKeyEnabled": "true" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Webhook_Update", + "title": "Webhook_Update" +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/main.tsp b/specification/appcomplianceautomation/AppComplianceAutomation.Management/main.tsp new file mode 100644 index 000000000000..6e9ffc9b4780 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/main.tsp @@ -0,0 +1,39 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models/models.tsp"; +import "./resources/ReportResource.tsp"; +import "./resources/WebhookResource.tsp"; +import "./resources/SnapshotResource.tsp"; +import "./resources/ScopingConfigurationResource.tsp"; +import "./resources/EvidenceResource.tsp"; +import "./routes.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; +/** + * App Compliance Automation Tool for Microsoft 365 API spec + */ +@armProviderNamespace +@service({ + title: "App Compliance Automation Tool for Microsoft 365", +}) +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v3) +namespace Microsoft.AppComplianceAutomation; + +/** + * The available API versions. + */ +enum Versions { + /** + * The 2024-06-27 API version. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_06_27: "2024-06-27", +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/models/models.tsp b/specification/appcomplianceautomation/AppComplianceAutomation.Management/models/models.tsp new file mode 100644 index 000000000000..b04607c54826 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/models/models.tsp @@ -0,0 +1,1876 @@ +import "../main.tsp"; +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-core"; +import "@typespec/openapi"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using OpenAPI; +using Azure.Core; + +namespace Microsoft.AppComplianceAutomation; + +/** + * Indicates the resource status. + */ +union ResourceStatus { + @doc("The resource is healthy.") + Healthy: "Healthy", + + @doc("The resource is unhealthy.") + Unhealthy: "Unhealthy", + + string, +} + +/** + * Report status. + */ +union ReportStatus { + @doc("The report is active.") + Active: "Active", + + @doc("The report is failed.") + Failed: "Failed", + + @doc("The report is under reviewing.") + Reviewing: "Reviewing", + + @doc("The report is disabled.") + Disabled: "Disabled", + + string, +} + +/** + * Resource Origin. + */ +union ResourceOrigin { + @doc("The resource is from Azure.") + Azure: "Azure", + + @doc("The resource is from AWS.") + AWS: "AWS", + + @doc("The resource is from GCP.") + GCP: "GCP", + + string, +} + +/** + * Resource provisioning states. + */ +union ProvisioningState { + @doc("The provision is succeeded.") + Succeeded: "Succeeded", + + @doc("The provision is failed.") + Failed: "Failed", + + @doc("The provision is canceled.") + Canceled: "Canceled", + + @doc("The creation is in progress.") + Creating: "Creating", + + @doc("The deletion is in progress.") + Deleting: "Deleting", + + @doc("The fix of the resource in progress.") + Fixing: "Fixing", + + @doc("The verification of the resource in progress.") + Verifying: "Verifying", + + @doc("The update of the resource in progress.") + Updating: "Updating", + + string, +} + +/** + * Webhook status. + */ +union WebhookStatus { + @doc("The webhook is enabled.") + Enabled: "Enabled", + + @doc("The webhook is disabled.") + Disabled: "Disabled", + + string, +} + +/** + * whether to send notification under any event. + */ +union SendAllEvents { + @doc("Need send notification under any event.") + True: "true", + + @doc("No need to send notification under any event.") + False: "false", + + string, +} + +/** + * notification event. + */ +union NotificationEvent { + @doc("The subscribed report's snapshot is successfully generated.") + generate_snapshot_success: "generate_snapshot_success", + + @doc("The subscribed report's snapshot is failed to generate.") + generate_snapshot_failed: "generate_snapshot_failed", + + @doc("The subscribed report failed while collecting the assessments.") + assessment_failure: "assessment_failure", + + @doc("The subscribed report's configuration is changed.") + report_configuration_changes: "report_configuration_changes", + + @doc("The subscribed report is deleted.") + report_deletion: "report_deletion", + + string, +} + +/** + * content type + */ +union ContentType { + @doc("The content type is application/json.") + ApplicationJson: "application/json", + + string, +} + +/** + * whether to update webhookKey. + */ +union UpdateWebhookKey { + @doc("Need update the webhook key.") + True: "true", + + @doc("No need to update the webhook key.") + False: "false", + + string, +} + +/** + * whether webhookKey is enabled. + */ +union WebhookKeyEnabled { + @doc("The webhookKey is enabled.") + True: "true", + + @doc("The webhookKey is not enabled.") + False: "false", + + string, +} + +/** + * whether to enable ssl verification + */ +union EnableSslVerification { + @doc("The ssl verification is enabled.") + True: "true", + + @doc("The ssl verification is not enabled.") + False: "false", + + string, +} + +/** + * webhook deliveryStatus + */ +union DeliveryStatus { + @doc("The webhook is delivered successfully.") + Succeeded: "Succeeded", + + @doc("The webhook is failed to deliver.") + Failed: "Failed", + + @doc("The webhook is not delivered.") + NotStarted: "NotStarted", + + string, +} + +/** + * Indicates the category status. + */ +union CategoryStatus { + @doc("The category is passed.") + Passed: "Passed", + + @doc("The category is failed.") + Failed: "Failed", + + @doc("The category is not applicable.") + NotApplicable: "NotApplicable", + + @doc("The category is pending for approval.") + PendingApproval: "PendingApproval", + + string, +} + +/** + * Indicates the control family status. + */ +union ControlFamilyStatus { + @doc("The control family is passed.") + Passed: "Passed", + + @doc("The control family is failed.") + Failed: "Failed", + + @doc("The control family is not applicable.") + NotApplicable: "NotApplicable", + + @doc("The control family is pending for approval.") + PendingApproval: "PendingApproval", + + string, +} + +/** + * Indicates the control status. + */ +union ControlStatus { + @doc("The control is passed.") + Passed: "Passed", + + @doc("The control is failed.") + Failed: "Failed", + + @doc("The control is not applicable.") + NotApplicable: "NotApplicable", + + @doc("The control is pending for approval.") + PendingApproval: "PendingApproval", + + string, +} + +/** + * Indicates the customer responsibility type. + */ +union ResponsibilityType { + @doc("The responsibility is automated.") + Automated: "Automated", + + @doc("The responsibility is scoped manual.") + ScopedManual: "ScopedManual", + + @doc("The responsibility is manual.") + Manual: "Manual", + + string, +} + +/** + * Indicates the customer responsibility severity. + */ +union ResponsibilitySeverity { + @doc("The responsibility is high severity.") + High: "High", + + @doc("The responsibility is medium severity.") + Medium: "Medium", + + @doc("The responsibility is low severity.") + Low: "Low", + + string, +} + +/** + * Indicates the customer responsibility status. + */ +union ResponsibilityStatus { + @doc("The responsibility is passed.") + Passed: "Passed", + + @doc("The responsibility is failed.") + Failed: "Failed", + + @doc("The responsibility is not applicable.") + NotApplicable: "NotApplicable", + + @doc("The responsibility is pending for approval.") + PendingApproval: "PendingApproval", + + string, +} + +/** + * Indicates the customer responsibility supported cloud environment. + */ +union ResponsibilityEnvironment { + @doc("The responsibility is supported in Azure.") + Azure: "Azure", + + @doc("The responsibility is supported in AWS.") + AWS: "AWS", + + @doc("The responsibility is supported in GCP.") + GCP: "GCP", + + @doc("The responsibility is general requirement of all environment.") + General: "General", + + string, +} + +/** + * Indicates whether this solution is the recommended. + */ +union IsRecommendSolution { + @doc("This solution is the recommended.") + True: "true", + + @doc("This solution is not the recommended.") + False: "false", + + string, +} + +/** + * Indicates the download type. + */ +union DownloadType { + @doc("Download the compliance report.") + ComplianceReport: "ComplianceReport", + + @doc("Download the compliance pdf report.") + CompliancePdfReport: "CompliancePdfReport", + + @doc("Download the detailed compliance pdf report.") + ComplianceDetailedPdfReport: "ComplianceDetailedPdfReport", + + @doc("Download the resource list of the report.") + ResourceList: "ResourceList", + + string, +} + +/** + * Evidence type + */ +union EvidenceType { + @doc("The evidence is a file.") + File: "File", + + @doc("The evidence auto collected by App Compliance Automation.") + AutoCollectedEvidence: "AutoCollectedEvidence", + + @doc("The evidence is data.") + Data: "Data", + + string, +} + +/** + * Indicates whether the fix action is Succeeded or Failed. + */ +union Result { + @doc("The result is succeeded.") + Succeeded: "Succeeded", + + @doc("The result is failed.") + Failed: "Failed", + + string, +} + +/** + * Scoping question rule. + */ +union Rule { + @doc("The question is required to answer.") + Required: "Required", + + @doc("The question answer length is limited.") + CharLength: "CharLength", + + @doc("The question answer should be an Url.") + Url: "Url", + + @doc("The question answer should be Urls.") + Urls: "Urls", + + @doc("The question answer should be domains.") + Domains: "Domains", + + @doc("The question answer should be a UsPrivacyShield.") + USPrivacyShield: "USPrivacyShield", + + @doc("The question answer should be a PublicSOX.") + PublicSOX: "PublicSOX", + + @doc("The question answer should be a CreditCardPCI.") + CreditCardPCI: "CreditCardPCI", + + @doc("The question answer should be an AzureApplication.") + AzureApplication: "AzureApplication", + + @doc("The question answer should be a valid guid.") + ValidGuid: "ValidGuid", + + @doc("The question answer should be publisher verification.") + PublisherVerification: "PublisherVerification", + + @doc("The question answer should be dynamic dropdown.") + DynamicDropdown: "DynamicDropdown", + + @doc("The question answer should prevent non-english char.") + PreventNonEnglishChar: "PreventNonEnglishChar", + + @doc("The question answer should be a valid email.") + ValidEmail: "ValidEmail", + + string, +} + +/** + * Question input type. + */ +union InputType { + @doc("The input type is a text box.") + None: "None", + + @doc("The input content is text string.") + Text: "Text", + + @doc("The input content should be an email address.") + Email: "Email", + + @doc("The input content should be multiline text.") + MultilineText: "MultilineText", + + @doc("The input content should be a URL.") + Url: "Url", + + @doc("The input content should be a number.") + Number: "Number", + + @doc("The input content should be a boolean.") + Boolean: "Boolean", + + @doc("The input content should be a telephone number.") + Telephone: "Telephone", + + @doc("The input content should be Yes, No or Na.") + YesNoNa: "YesNoNa", + + @doc("The input content should be a date.") + Date: "Date", + + @doc("The input content is a Year, pick from the dropdown list.") + YearPicker: "YearPicker", + + @doc("The input content is a single result seleted from the options.") + SingleSelection: "SingleSelection", + + @doc("The input content is a single result seleted from the dropdown options.") + SingleSelectDropdown: "SingleSelectDropdown", + + @doc("The input content are multiple results seleted from the checkboxes.") + MultiSelectCheckbox: "MultiSelectCheckbox", + + @doc("The input content are multiple results seleted from the dropdown options.") + MultiSelectDropdown: "MultiSelectDropdown", + + @doc("The input content are result seleted from the custom dropdown options.") + MultiSelectDropdownCustom: "MultiSelectDropdownCustom", + + @doc("The input content is a group of answers.") + Group: "Group", + + @doc("The input content is a uploaded file.") + Upload: "Upload", + + string, +} + +/** + * The get collection count request body. + */ +@doc("Get collection count's request object.") +model GetCollectionCountRequest { + /** + * The resource type. + */ + type?: string; +} + +/** + * The get collection count response. + */ +model GetCollectionCountResponse { + /** + * The count of the specified resource. + */ + count?: int32; +} + +/** + * The get overview status request body. + */ +@doc("Get overview status request object.") +model GetOverviewStatusRequest { + /** + * The resource type. + */ + type?: string; +} + +/** + * The get overview status response. + */ +model GetOverviewStatusResponse { + /** + * List of different status items. + */ + @extension("x-ms-identifiers", ["statusName"]) + statusList?: StatusItem[]; +} + +/** + * Single status. + */ +model StatusItem { + /** + * Status name - e.g. "Active", "Failed". + */ + statusName?: string; + + /** + * Status value. e.g. "100", or "100%". + */ + statusValue?: string; +} + +/** + * Onboard subscriptions request. + */ +@doc("Parameters for onboard operation") +model OnboardRequest { + /** + * List of subscription ids to be onboarded + */ + subscriptionIds: string[]; +} + +/** + * Onboard subscriptions response. + */ +@doc("Success. The response indicates given subscriptions has been onboarded.") +model OnboardResponse { + /** + * List of subscription ids that are onboarded + */ + subscriptionIds?: string[]; +} + +/** + * Trigger evaluation request. + */ +model TriggerEvaluationRequest { + /** + * List of resource ids to be evaluated + */ + resourceIds: string[]; +} + +/** + * Trigger evaluation response. + */ +model TriggerEvaluationResponse { + /** + * trigger evaluation property. + */ + properties?: TriggerEvaluationProperty; +} + +/** + * Trigger evaluation response. + */ +model TriggerEvaluationProperty { + /** + * The time when the evaluation is triggered. + */ + @visibility("read") + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + triggerTime?: utcDateTime; + + /** + * The time when the evaluation is end. + */ + @visibility("read") + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + evaluationEndTime?: utcDateTime; + + /** + * List of resource ids to be evaluated + */ + @extension("x-ms-identifiers", ["resourceId"]) + resourceIds?: string[]; + + /** + * List of quick assessments + */ + @extension("x-ms-identifiers", ["resourceId"]) + quickAssessments?: QuickAssessment[]; +} + +/** + * A class represent the quick assessment. + */ +model QuickAssessment { + /** + * Resource id. + */ + @visibility("read") + resourceId?: string; + + /** + * Responsibility id. + */ + @visibility("read") + responsibilityId?: string; + + /** + * The timestamp of resource creation (UTC). + */ + @visibility("read") + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + timestamp?: utcDateTime; + + /** + * Quick assessment status. + */ + @visibility("read") + resourceStatus?: ResourceStatus; + + /** + * Quick assessment display name. + */ + @visibility("read") + displayName?: string; + + /** + * Quick assessment display name. + */ + @visibility("read") + description?: string; + + /** + * Link to remediation steps for this quick assessment. + */ + @visibility("read") + remediationLink?: string; +} + +/** + * List in use storage accounts request. + */ +@doc("Parameters for listing in use storage accounts operation. If subscription list is null, it will check the user's all subscriptions.") +model ListInUseStorageAccountsRequest { + /** + * List of subscription ids to be query. If the list is null or empty, the API will query all the subscriptions of the user. + */ + subscriptionIds?: string[]; +} + +/** + * List in use storage accounts response. + */ +@doc("Parameters for listing in use storage accounts operation. If subscription list is null, it will check the user's all subscriptions.") +model ListInUseStorageAccountsResponse { + /** + * The storage account list which in use in related reports. + */ + @extension("x-ms-identifiers", ["accountName"]) + storageAccountList?: StorageInfo[]; +} + +/** + * The information of 'bring your own storage' account binding to the report + */ +model StorageInfo { + /** + * The subscription id which 'bring your own storage' account belongs to + */ + subscriptionId?: string; + + /** + * The resourceGroup which 'bring your own storage' account belongs to + */ + resourceGroup?: string; + + /** + * 'bring your own storage' account name + */ + accountName?: string; + + /** + * The region of 'bring your own storage' account + */ + location?: string; +} + +/** + * Report's properties. + */ +alias ReportBaseProperties = { + /** + * Report status. + */ + @visibility("read") + status?: ReportStatus; + + /** + * List of report error codes. + */ + @visibility("read") + errors?: string[]; + + /** + * Report's tenant id. + */ + @visibility("read") + tenantId?: string; + + /** + * A list of comma-separated offerGuids indicates a series of offerGuids that map to the report. For example, "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002" and "00000000-0000-0000-0000-000000000003". + */ + offerGuid?: string; + + /** + * Report next collection trigger time. + */ + @visibility("read") + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + nextTriggerTime?: utcDateTime; + + /** + * Report last collection trigger time. + */ + @visibility("read") + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + lastTriggerTime?: utcDateTime; + + /** + * List of subscription Ids. + */ + @visibility("read") + subscriptions?: string[]; + + /** + * Report compliance status. + */ + @visibility("read") + complianceStatus?: ReportComplianceStatus; + + /** + * The information of 'bring your own storage' binding to the report + */ + storageInfo?: StorageInfo; + + /** + * List of synchronized certification records. + */ + @visibility("read") + @extension("x-ms-identifiers", ["offerGuid"]) + certRecords?: CertSyncRecord[]; + + /** + * Azure lifecycle management + */ + @visibility("read") + provisioningState?: ProvisioningState; +}; + +/** + * Create Report's properties. + */ +model ReportProperties { + /** + * Report collection trigger time. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + triggerTime: utcDateTime; + + /** + * Report collection trigger time's time zone, the available list can be obtained by executing "Get-TimeZone -ListAvailable" in PowerShell. + * An example of valid timezone id is "Pacific Standard Time". + */ + timeZone: string; + + /** + * List of resource data. + */ + @extension("x-ms-identifiers", ["resourceId"]) + resources: ResourceMetadata[]; + + ...ReportBaseProperties; +} + +/** + * Patch Report's properties. + */ +model ReportPatchProperties { + /** + * Report collection trigger time. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + triggerTime?: utcDateTime; + + /** + * Report collection trigger time's time zone, the available list can be obtained by executing "Get-TimeZone -ListAvailable" in PowerShell. + * An example of valid timezone id is "Pacific Standard Time". + */ + timeZone?: string; + + /** + * List of resource data. + */ + @extension("x-ms-identifiers", ["resourceId"]) + resources?: ResourceMetadata[]; + + ...ReportBaseProperties; +} + +/** + * Single resource Id's metadata. + */ +model ResourceMetadata { + /** + * Resource Id - e.g. "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1". + */ + resourceId: string; + + /** + * Resource type. e.g. "Microsoft.Compute/virtualMachines" + */ + resourceType?: string; + + /** + * Resource kind. + */ + resourceKind?: string; + + /** + * Resource Origin. + */ + resourceOrigin?: ResourceOrigin; + + /** + * Account Id. For example - the AWS account id. + */ + accountId?: string; +} + +/** + * A list which includes all the compliance result for one report. + */ +model ReportComplianceStatus { + /** + * The Microsoft 365 certification name. + */ + @visibility("read") + m365?: OverviewStatus; +} + +/** + * The overview of the compliance result for one report. + */ +model OverviewStatus { + /** + * The count of all passed control. + */ + @visibility("read") + passedCount?: int32; + + /** + * The count of all failed control. + */ + @visibility("read") + failedCount?: int32; + + /** + * The count of all manual control. + */ + @visibility("read") + manualCount?: int32; + + /** + * The count of all not applicable control. + */ + @visibility("read") + notApplicableCount?: int32; + + /** + * The count of all pending for approval control. + */ + @visibility("read") + pendingCount?: int32; +} + +/** + * A class represent the certification record synchronized from app compliance. + */ +model CertSyncRecord { + /** + * The offerGuid which mapping to the reports. + */ + @minLength(1) + offerGuid?: string; + + /** + * Indicates the status of certification process. + */ + certificationStatus?: string; + + /** + * Indicates the status of compliance process. + */ + ingestionStatus?: string; + + /** + * The control records list to be synchronized. + */ + @extension("x-ms-identifiers", ["controlId"]) + controls?: ControlSyncRecord[]; +} + +/** + * A class represent the control record synchronized from app compliance. + */ +model ControlSyncRecord { + /** + * The Id of the control. e.g. "Operational_Security_10" + */ + controlId?: string; + + /** + * Control status synchronized from app compliance. + */ + controlStatus?: string; +} + +/** + * A class represent a AppComplianceAutomation report resource update properties. + */ +model ReportResourcePatch { + /** + * Report property. + */ + properties?: ReportPatchProperties; +} + +/** + * Synchronize certification record request. + */ +model SyncCertRecordRequest { + /** + * certification record to be synchronized. + */ + certRecord: CertSyncRecord; +} + +/** + * Synchronize certification record response. + */ +model SyncCertRecordResponse { + /** + * certification record synchronized. + */ + certRecord?: CertSyncRecord; +} + +/** + * Webhook properties. + */ +model WebhookProperties { + /** + * Webhook id in database. + */ + @visibility("read") + webhookId?: string; + + /** + * Webhook status. + */ + status?: WebhookStatus; + + /** + * Tenant id. + */ + @visibility("read") + tenantId?: string; + + /** + * whether to send notification under any event. + */ + sendAllEvents?: SendAllEvents; + + /** + * under which event notification should be sent. + */ + events?: NotificationEvent[]; + + /** + * webhook payload url + */ + @pattern("^(http(s)?://)[\\S]{0,64994}$") + payloadUrl?: string; + + /** + * content type + */ + contentType?: ContentType; + + /** + * webhook secret token. If not set, this field value is null; otherwise, please set a string value. + */ + @pattern("^.{0,2048}$") + webhookKey?: string; + + /** + * whether to update webhookKey. + */ + updateWebhookKey?: UpdateWebhookKey; + + /** + * whether webhookKey is enabled. + */ + @visibility("read") + webhookKeyEnabled?: WebhookKeyEnabled; + + /** + * whether to enable ssl verification + */ + enableSslVerification?: EnableSslVerification; + + /** + * webhook deliveryStatus + */ + @visibility("read") + deliveryStatus?: DeliveryStatus; + + /** + * Azure Resource Provisioning State + */ + @visibility("read") + provisioningState?: ProvisioningState; +} + +/** + * A class represent a AppComplianceAutomation webhook resource update properties. + */ +model WebhookResourcePatch { + /** + * Webhook property. + */ + properties?: WebhookProperties; +} + +/** + * Snapshot's properties. + */ +model SnapshotProperties { + /** + * Snapshot name. + */ + @visibility("read") + snapshotName?: string; + + /** + * The timestamp of resource creation (UTC). + */ + @visibility("read") + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdAt?: utcDateTime; + + /** + * Azure lifecycle management + */ + @visibility("read") + provisioningState?: ProvisioningState; + + /** + * The report essential info. + */ + @visibility("read") + reportProperties?: ReportProperties; + + /** + * Metadata pertaining to creation and last modification of the resource. + */ + @visibility("read") + reportSystemData?: SystemData; + + /** + * List of compliance results. + */ + @visibility("read") + @extension("x-ms-identifiers", ["complianceName"]) + complianceResults?: ComplianceResult[]; +} + +/** + * A class represent the compliance result. + */ +model ComplianceResult { + /** + * The name of the compliance. e.g. "M365" + */ + @visibility("read") + complianceName?: string; + + /** + * List of categories. + */ + @visibility("read") + @extension("x-ms-identifiers", ["categoryName"]) + categories?: Category[]; +} + +/** + * A class represent the compliance category. + */ +model Category { + /** + * The name of the compliance category. e.g. "Operational Security" + */ + @visibility("read") + categoryName?: string; + + /** + * Category status. + */ + @visibility("read") + categoryStatus?: CategoryStatus; + + /** + * List of control families. + */ + @visibility("read") + @extension("x-ms-identifiers", ["controlFamilyName"]) + controlFamilies?: ControlFamily[]; +} + +/** + * A class represent the control family. + */ +model ControlFamily { + /** + * The name of the control family. e.g. "Malware Protection - Anti-Virus" + */ + @visibility("read") + controlFamilyName?: string; + + /** + * The control family status + */ + @visibility("read") + controlFamilyStatus?: ControlFamilyStatus; + + /** + * List of controls. + */ + @visibility("read") + @extension("x-ms-identifiers", ["controlId"]) + controls?: Control[]; +} + +/** + * A class represent the control. + */ +model Control { + /** + * The Id of the control. e.g. "Operational_Security_10" + */ + @visibility("read") + controlId?: string; + + /** + * The name of the control. e.g. "Unsupported OS and Software." + */ + @visibility("read") + controlName?: string; + + /** + * The full name of the control. e.g. "Validate that unsupported operating systems and software components are not in use." + */ + @visibility("read") + controlFullName?: string; + + /** + * The control's description + */ + @visibility("read") + controlDescription?: string; + + /** + * The hyper link to the control's description'. + */ + @visibility("read") + controlDescriptionHyperLink?: string; + + /** + * Control status. + */ + @visibility("read") + controlStatus?: ControlStatus; + + /** + * List of customer responsibility. + */ + @visibility("read") + @extension("x-ms-identifiers", ["responsibilityId"]) + responsibilities?: Responsibility[]; +} + +/** + * A class represent the customer responsibility. + */ +model Responsibility { + /** + * The id of the customer responsibility. + */ + @visibility("read") + responsibilityId?: string; + + /** + * The title of the customer responsibility. + */ + @visibility("read") + responsibilityTitle?: string; + + /** + * The description of the customer responsibility. + */ + @visibility("read") + responsibilityDescription?: string; + + /** + * The type of customer responsibility. + */ + @visibility("read") + responsibilityType?: ResponsibilityType; + + /** + * The severity level of this customer responsibility. + */ + @visibility("read") + responsibilitySeverity?: ResponsibilitySeverity; + + /** + * The status of this customer responsibility. + */ + @visibility("read") + responsibilityStatus?: ResponsibilityStatus; + + /** + * The supported cloud environment of this customer responsibility. + */ + @visibility("read") + responsibilityEnvironment?: ResponsibilityEnvironment; + + /** + * The count of all failed resources. + */ + failedResourceCount?: int32; + + /** + * The count of all resources. + */ + totalResourceCount?: int32; + + /** + * List of resource. + */ + @visibility("read") + @extension("x-ms-identifiers", ["resourceId"]) + resourceList?: ResponsibilityResource[]; + + /** + * List of recommendation. + */ + @visibility("read") + @extension("x-ms-identifiers", ["recommendationId"]) + recommendationList?: Recommendation[]; + + /** + * The evidence upload guidance description. + */ + @visibility("read") + guidance?: string; + + /** + * The justification given by the user to clarify the reason. + */ + @visibility("read") + justification?: string; + + /** + * List of evidence file url. + */ + evidenceFiles?: string[]; +} + +/** + * A class represent the resource. + */ +model ResponsibilityResource { + /** + * The Id of the resource. + */ + @visibility("read") + resourceId?: string; + + /** + * Account Id. For example - AWS account Id. + */ + @visibility("read") + accountId?: string; + + /** + * The type of the resource. e.g. "Microsoft.SignalRService/SignalR" + */ + @visibility("read") + resourceType?: string; + + /** + * Resource origin. + */ + @visibility("read") + resourceOrigin?: ResourceOrigin; + + /** + * Resource status. + */ + @visibility("read") + resourceStatus?: ResourceStatus; + + /** + * The status change date for the resource. + */ + @visibility("read") + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + resourceStatusChangeDate?: utcDateTime; + + /** + * List of recommendation id. + */ + recommendationIds?: string[]; +} + +/** + * A class represent the recommendation. + */ +model Recommendation { + /** + * The Id of the recommendation. + */ + @visibility("read") + recommendationId?: string; + + /** + * The short name of the recommendation. e.g. "Invalid TLS config" + */ + @visibility("read") + recommendationShortName?: string; + + /** + * List of recommendation solutions. + */ + @visibility("read") + @extension("x-ms-identifiers", ["recommendationSolutionIndex"]) + recommendationSolutions?: RecommendationSolution[]; +} + +/** + * A class represent the recommendation solution. + */ +model RecommendationSolution { + /** + * The index of the recommendation solution. + */ + @visibility("read") + recommendationSolutionIndex?: string; + + /** + * The detail steps of the recommendation solution. + */ + @visibility("read") + recommendationSolutionContent?: string; + + /** + * Indicates whether this solution is the recommended. + */ + @visibility("read") + isRecommendSolution?: IsRecommendSolution; +} + +/** + * Snapshot's download request. + */ +model SnapshotDownloadRequest { + /** + * Tenant id. + */ + reportCreatorTenantId?: string; + + /** + * Indicates the download type. + */ + downloadType: DownloadType; + + /** + * The offerGuid which mapping to the reports. + */ + @minLength(1) + offerGuid?: string; +} + +/** + * Object that includes all the possible response for the download operation. + */ +model DownloadResponse { + /** + * Resource list of the report + */ + @visibility("read") + @extension("x-ms-identifiers", ["resourceId"]) + resourceList?: ResourceItem[]; + + /** + * List of the compliance result + */ + @visibility("read") + @extension("x-ms-identifiers", ["controlId"]) + complianceReport?: ComplianceReportItem[]; + + /** + * Compliance pdf report + */ + @visibility("read") + compliancePdfReport?: DownloadResponseCompliancePdfReport; + + /** + * The detailed compliance pdf report + */ + @visibility("read") + complianceDetailedPdfReport?: DownloadResponseComplianceDetailedPdfReport; +} + +/** + * Resource Id. + */ +model ResourceItem { + /** + * The subscription Id of this resource. + */ + @visibility("read") + subscriptionId?: string; + + /** + * The resource group name of this resource. + */ + @visibility("read") + resourceGroup?: string; + + /** + * The resource type of this resource. e.g. "Microsoft.SignalRService/SignalR" + */ + @visibility("read") + resourceType?: string; + + /** + * The resource Id - e.g. "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1". + */ + @visibility("read") + resourceId?: string; +} + +/** + * Object that includes all the content for single compliance result. + */ +model ComplianceReportItem { + /** + * The category name. + */ + @visibility("read") + categoryName?: string; + + /** + * The control family name. + */ + @visibility("read") + controlFamilyName?: string; + + /** + * The control Id - e.g. "1". + */ + @visibility("read") + controlId?: string; + + /** + * The control name. + */ + @visibility("read") + controlName?: string; + + /** + * Control status. + */ + @visibility("read") + controlStatus?: ControlStatus; + + /** + * The title of the customer responsibility. + */ + @visibility("read") + responsibilityTitle?: string; + + /** + * The description of the customer responsibility. + */ + @visibility("read") + responsibilityDescription?: string; + + /** + * The Id of the resource. + */ + @visibility("read") + resourceId?: string; + + /** + * The type of the resource. e.g. "Microsoft.SignalRService/SignalR" + */ + @visibility("read") + resourceType?: string; + + /** + * Resource origin. + */ + @visibility("read") + resourceOrigin?: ResourceOrigin; + + /** + * Resource status. + */ + @visibility("read") + resourceStatus?: ResourceStatus; + + /** + * The status change date for the resource. + */ + @visibility("read") + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + resourceStatusChangeDate?: utcDateTime; +} + +/** + * Compliance pdf report + */ +model DownloadResponseCompliancePdfReport { + /** + * The uri of compliance pdf report + */ + @visibility("read") + sasUri?: string; +} + +/** + * The detailed compliance pdf report + */ +model DownloadResponseComplianceDetailedPdfReport { + /** + * The uri of detailed compliance pdf report + */ + @visibility("read") + sasUri?: string; +} + +/** + * ScopingConfiguration's properties. + */ +model ScopingConfigurationProperties { + /** + * List of scoping question answers. + */ + @extension("x-ms-identifiers", ["questionId"]) + answers?: ScopingAnswer[]; + + /** + * Azure lifecycle management + */ + @visibility("read") + provisioningState?: ProvisioningState; +} + +/** + * Scoping question list. + */ +model ScopingQuestions { + /** + * List of scoping questions. + */ + @extension("x-ms-identifiers", ["questionId"]) + questions?: ScopingQuestion[]; +} + +/** + * The definition of a scoping question. + */ +model ScopingQuestion { + /** + * Question id. + */ + @visibility("read") + questionId: string; + + /** + * Superior question id. + */ + @visibility("read") + superiorQuestionId?: string; + + /** + * Input type of the question answer. + */ + @visibility("read") + inputType: InputType; + + /** + * Option id list. + */ + @visibility("read") + optionIds: string[]; + + /** + * The rule of the question. + */ + @visibility("read") + rules: Rule[]; + + /** + * The answer value to show the sub questions. + */ + @visibility("read") + showSubQuestionsValue?: string; +} + +/** + * Scoping answer. + */ +model ScopingAnswer { + /** + * Question id. + */ + @pattern("^[-a-zA-Z0-9_]{1,50}$") + questionId: string; + + /** + * Question answer value list. + */ + answers: string[]; +} + +/** + * Evidence's properties. + */ +model EvidenceProperties { + /** + * Evidence type. + */ + evidenceType?: EvidenceType; + + /** + * The path of the file in storage. + */ + filePath: string; + + /** + * Extra data considered as evidence. + */ + extraData?: string; + + /** + * Control id. + */ + controlId?: string; + + /** + * Responsibility id. + */ + responsibilityId?: string; + + /** + * Azure lifecycle management + */ + @visibility("read") + provisioningState?: ProvisioningState; +} + +/** + * Evidence file's download request. + */ +model EvidenceFileDownloadRequest { + /** + * Tenant id. + */ + reportCreatorTenantId?: string; + + /** + * The offerGuid which mapping to the reports. + */ + @minLength(1) + offerGuid?: string; +} + +/** + * Object that includes all the possible response for the evidence file download operation. + */ +model EvidenceFileDownloadResponse { + /** + * The uri of evidence file + */ + @visibility("read") + evidenceFile?: EvidenceFileDownloadResponseEvidenceFile; +} + +/** + * The uri of evidence file + */ +model EvidenceFileDownloadResponseEvidenceFile { + /** + * The url of evidence file + */ + @visibility("read") + url?: string; +} + +/** + * Report fix result. + */ +model ReportFixResult { + /** + * Indicates whether the fix action is Succeeded or Failed. + */ + @visibility("read") + result?: Result; + + /** + * If the report fix action failed, to indicate the detailed failed reason. + */ + @visibility("read") + reason?: string; +} + +/** + * Report health status verification result. + */ +model ReportVerificationResult { + /** + * Indicates whether the report verification action is Succeeded or Failed. + */ + @visibility("read") + result?: Result; + + /** + * If the report verification action failed, to indicate the detailed failed reason. + */ + @visibility("read") + reason?: string; +} + +/** + * Query parameters for list operations. + */ +model QueryParameters { + /** + * Skip over when retrieving results. + */ + @query("$skipToken") + skipToken?: string; + + /** + * Number of elements to return when retrieving results. + */ + @maxValue(100) + @minValue(1) + @query("$top") + top?: int32; + + /** + * OData Select statement. Limits the properties on each entry to just those requested, e.g. ?$select=reportName,id. + */ + @minLength(1) + @query("$select") + select?: string; + + /** + * The filter to apply on the operation. + */ + @minLength(1) + @query("$filter") + filter?: string; + + /** + * OData order by query option. + */ + @minLength(1) + @query("$orderby") + orderby?: string; + + /** + * The offerGuid which mapping to the reports. + */ + @minLength(1) + @query("offerGuid") + offerGuid?: string; + + /** + * The tenant id of the report creator. + */ + @minLength(1) + @query("reportCreatorTenantId") + reportCreatorTenantId?: string; +} + +/** + * Extra parameters for app compliance. + */ +model ExtraParameter { + /** + * The offerGuid which mapping to the reports. + */ + @minLength(1) + @query("offerGuid") + offerGuid?: string; + + /** + * The tenant id of the report creator. + */ + @minLength(1) + @query("reportCreatorTenantId") + reportCreatorTenantId?: string; +} diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/EvidenceResource.tsp b/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/EvidenceResource.tsp new file mode 100644 index 000000000000..059fafb96781 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/EvidenceResource.tsp @@ -0,0 +1,122 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "../models/models.tsp"; +import "./ReportResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using OpenAPI; +using Azure.ClientGenerator.Core; + +namespace Microsoft.AppComplianceAutomation; +/** + * A class represent an AppComplianceAutomation evidence resource. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "For backward compatibility" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@parentResource(ReportResource) +@includeInapplicableMetadataInPayload(false) +@Azure.ResourceManager.Private.armResourceInternal(EvidenceProperties) +model EvidenceResource extends Azure.ResourceManager.Foundations.ProxyResource { + /** + * The evidence name. + */ + @key("evidenceName") + @segment("evidences") + @visibility("read") + @pattern("^[a-zA-Z0-9-_.]+$") + @path + name: string; + + /** + * Evidence property. + */ + @extension("x-ms-client-flatten", true) + @extension("x-ms-client-name", "properties") + properties: EvidenceProperties; +} + +@armResourceOperations +@tag("AppComplianceAutomation") +interface Evidence { + /** + * Get the evidence metadata + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Evidence_Get") + get is ArmResourceRead< + EvidenceResource, + { + ...Azure.ResourceManager.Foundations.BaseParameters; + } + >; + + /** + * Create or Update an evidence a specified report + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Evidence_CreateOrUpdate") + createOrUpdate is ArmResourceCreateOrReplaceSync< + EvidenceResource, + { + ...Azure.ResourceManager.Foundations.BaseParameters; + ...ExtraParameter; + } + >; + + /** + * Delete an existent evidence from a specified report + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Evidence_Delete") + delete is ArmResourceDeleteSync; + + /** + * Returns a paginated list of evidences for a specified report. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Evidence_ListByReport") + listByReport is ArmResourceListByParent< + EvidenceResource, + { + ...Azure.ResourceManager.Foundations.BaseParameters; + ...QueryParameters; + } + >; + + /** + * Download evidence file. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Evidence_Download") + download is ArmResourceActionSync< + EvidenceResource, + EvidenceFileDownloadRequest, + EvidenceFileDownloadResponse + >; +} + +@@doc(Evidence.createOrUpdate::parameters.resource, + "Parameters for the create or update operation" +); +@@encodedName(Evidence.download::parameters.body, + "application/json", + "parameters" +); +@@doc(Evidence.download::parameters.body, "Parameters for the query operation"); + +@@encodedName(Evidence.createOrUpdate::parameters.resource, + "application/json", + "parameters" +); + +@@OpenAPI.extension(Evidence.createOrUpdate::parameters.resource, + "x-ms-client-name", + "properties" +); + +@@clientName(Evidence.createOrUpdate::parameters.resource, "parameters"); diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/ReportResource.tsp b/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/ReportResource.tsp new file mode 100644 index 000000000000..19be57009d87 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/ReportResource.tsp @@ -0,0 +1,191 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "../models/models.tsp"; + +using Azure.ClientGenerator.Core; +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using OpenAPI; +using Azure.Core; + +namespace Microsoft.AppComplianceAutomation; +/** + * A class represent an AppComplianceAutomation report resource. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "For backward compatibility" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@tenantResource +@includeInapplicableMetadataInPayload(false) +@Azure.ResourceManager.Private.armResourceInternal(ReportProperties) +model ReportResource extends Azure.ResourceManager.Foundations.ProxyResource { + /** + * Report Name. + */ + @pattern("^[-a-zA-Z0-9_]{1,50}$") + @key("reportName") + @segment("reports") + @visibility("read") + @path + name: string; + + /** + * Report property. + */ + @extension("x-ms-client-flatten", true) + @extension("x-ms-client-name", "properties") + properties: ReportProperties; +} + +@armResourceOperations +@tag("AppComplianceAutomation") +interface Report { + /** + * Get the AppComplianceAutomation report and its properties. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Report_Get") + get is ArmResourceRead; + + /** + * Create a new AppComplianceAutomation report or update an exiting AppComplianceAutomation report. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Report_CreateOrUpdate") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + ReportResource, + Azure.ResourceManager.Foundations.BaseParameters + >; + + /** + * Update an exiting AppComplianceAutomation report. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @parameterVisibility + @operationId("Report_Update") + update is ArmCustomPatchAsync< + ReportResource, + ReportResourcePatch, + Azure.ResourceManager.Foundations.BaseParameters + >; + + /** + * Delete an AppComplianceAutomation report. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Report_Delete") + delete is ArmResourceDeleteWithoutOkAsync< + ReportResource, + Azure.ResourceManager.Foundations.BaseParameters + >; + + /** + * Get the AppComplianceAutomation report list for the tenant. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Report_List") + list is ArmResourceListByParent< + ReportResource, + { + ...Azure.ResourceManager.Foundations.BaseParameters; + ...QueryParameters; + } + >; + + /** + * Synchronize attestation record from app compliance. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Report_SyncCertRecord") + syncCertRecord is ArmResourceActionAsync< + ReportResource, + SyncCertRecordRequest, + SyncCertRecordResponse, + Azure.ResourceManager.Foundations.BaseParameters + >; + + /** + * Checks the report's nested resource name availability, e.g: Webhooks, Evidences, Snapshots. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Report_NestedResourceCheckNameAvailability") + checkNameAvailability is ArmResourceActionSync< + ReportResource, + Azure.ResourceManager.Foundations.CheckNameAvailabilityRequest, + Azure.ResourceManager.Foundations.CheckNameAvailabilityResponse + >; + + /** + * Fix the AppComplianceAutomation report error. e.g: App Compliance Automation Tool service unregistered, automation removed. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Report_Fix") + fix is ArmResourceActionAsync< + ReportResource, + void, + ReportFixResult, + Azure.ResourceManager.Foundations.BaseParameters + >; + + /** + * Fix the AppComplianceAutomation report error. e.g: App Compliance Automation Tool service unregistered, automation removed. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Report_GetScopingQuestions") + getScopingQuestions is ArmResourceActionSync< + ReportResource, + void, + ScopingQuestions, + Azure.ResourceManager.Foundations.BaseParameters + >; + + /** + * Verify the AppComplianceAutomation report health status. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Report_Verify") + verify is ArmResourceActionAsync< + ReportResource, + void, + ReportVerificationResult, + Azure.ResourceManager.Foundations.BaseParameters + >; +} + +@@doc(Report.createOrUpdate::parameters.resource, + "Parameters for the create or update operation" +); +@@encodedName(Report.createOrUpdate::parameters.resource, + "application/json", + "parameters" +); + +@@OpenAPI.extension(Report.createOrUpdate::parameters.resource, + "x-ms-client-name", + "properties" +); + +@@clientName(Report.createOrUpdate::parameters.resource, "parameters"); + +@@doc(Report.update::parameters.properties, + "Parameters for the create or update operation" +); +@@doc(Report.syncCertRecord::parameters.body, + "Parameters for synchronize certification record operation" +); +@@doc(Report.checkNameAvailability::parameters.body, + "NameAvailabilityRequest object." +); + +@@encodedName(Report.update::parameters.properties, + "application/json", + "parameters" +); + +@@encodedName(Report.syncCertRecord::parameters.body, + "application/json", + "parameters" +); diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/ScopingConfigurationResource.tsp b/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/ScopingConfigurationResource.tsp new file mode 100644 index 000000000000..518cd41308a5 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/ScopingConfigurationResource.tsp @@ -0,0 +1,96 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; +import "../models/models.tsp"; +import "./ReportResource.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; +using Azure.ClientGenerator.Core; +using OpenAPI; + +namespace Microsoft.AppComplianceAutomation; +/** + * A class represent an AppComplianceAutomation scoping configuration resource. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "For backward compatibility" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@parentResource(ReportResource) +@includeInapplicableMetadataInPayload(false) +@Azure.ResourceManager.Private.armResourceInternal( + ScopingConfigurationProperties +) +model ScopingConfigurationResource + extends Azure.ResourceManager.Foundations.ProxyResource { + @key("scopingConfigurationName") + @segment("scopingConfigurations") + @visibility("read") + @doc("The scoping configuration of the specific report.") + @pattern("^[a-zA-Z0-9_]*$") + @path + name: string; + + /** + * ScopingConfiguration property. + */ + @extension("x-ms-client-flatten", true) + @extension("x-ms-client-name", "properties") + properties: ScopingConfigurationProperties; +} + +@armResourceOperations +@tag("AppComplianceAutomation") +interface ScopingConfiguration { + /** + * Get the AppComplianceAutomation scoping configuration of the specific report. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("ScopingConfiguration_Get") + get is ArmResourceRead; + + /** + * Get the AppComplianceAutomation scoping configuration of the specific report. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("ScopingConfiguration_CreateOrUpdate") + createOrUpdate is ArmResourceCreateOrReplaceSync; + + /** + * Clean the AppComplianceAutomation scoping configuration of the specific report. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("ScopingConfiguration_Delete") + delete is ArmResourceDeleteSync; + + /** + * Returns a list format of the singleton scopingConfiguration for a specified report. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("ScopingConfiguration_List") + list is ArmResourceListByParent; +} + +@@doc(ScopingConfiguration.createOrUpdate::parameters.resource, + "Parameters for the create or update operation, this is a singleton resource, so please make sure you're using 'default' as the name." +); + +@@encodedName(ScopingConfiguration.createOrUpdate::parameters.resource, + "application/json", + "parameters" +); + +@@OpenAPI.extension(ScopingConfiguration.createOrUpdate::parameters.resource, + "x-ms-client-name", + "properties" +); + +@@clientName(ScopingConfiguration.createOrUpdate::parameters.resource, + "parameters" +); diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/SnapshotResource.tsp b/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/SnapshotResource.tsp new file mode 100644 index 000000000000..9fafd95080e9 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/SnapshotResource.tsp @@ -0,0 +1,77 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "../models/models.tsp"; +import "./ReportResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using OpenAPI; + +namespace Microsoft.AppComplianceAutomation; +/** + * A class represent a AppComplianceAutomation snapshot resource. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "For backward compatibility" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@parentResource(ReportResource) +@includeInapplicableMetadataInPayload(false) +@Azure.ResourceManager.Private.armResourceInternal(SnapshotProperties) +model SnapshotResource extends Azure.ResourceManager.Foundations.ProxyResource { + /** + * Snapshot Name. + */ + @path + @key("snapshotName") + @segment("snapshots") + @visibility("read") + @pattern("^[a-zA-Z0-9-_]{1,64}$") + name: string; + + /** + * Snapshot's property. + */ + @extension("x-ms-client-flatten", true) + @extension("x-ms-client-name", "properties") + properties?: SnapshotProperties; +} + +@armResourceOperations +@tag("AppComplianceAutomation") +interface Snapshot { + /** + * Get the AppComplianceAutomation snapshot and its properties. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Snapshot_Get") + get is ArmResourceRead; + + /** + * Get the AppComplianceAutomation snapshot list. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Snapshot_List") + list is ArmResourceListByParent< + SnapshotResource, + { + ...Azure.ResourceManager.Foundations.BaseParameters; + ...QueryParameters; + } + >; + + /** + * Download compliance needs from snapshot, like: Compliance Report, Resource List. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Snapshot_Download") + download is ArmResourceActionAsync< + SnapshotResource, + SnapshotDownloadRequest, + DownloadResponse, + Azure.ResourceManager.Foundations.BaseParameters + >; +} + +@@doc(Snapshot.download::parameters.body, "Parameters for the query operation"); diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/WebhookResource.tsp b/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/WebhookResource.tsp new file mode 100644 index 000000000000..40e57c6edeaa --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/resources/WebhookResource.tsp @@ -0,0 +1,120 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; +import "../models/models.tsp"; +import "./ReportResource.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; +using Azure.ClientGenerator.Core; +using OpenAPI; + +namespace Microsoft.AppComplianceAutomation; +/** + * A class represent an AppComplianceAutomation webhook resource. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "For backward compatibility" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@parentResource(ReportResource) +@includeInapplicableMetadataInPayload(false) +@Azure.ResourceManager.Private.armResourceInternal(WebhookProperties) +model WebhookResource extends Azure.ResourceManager.Foundations.ProxyResource { + /** + * Webhook Name. + */ + @pattern("^[-a-zA-Z0-9_]{1,50}$") + @key("webhookName") + @segment("webhooks") + @visibility("read") + @path + name: string; + + /** + * Webhook property. + */ + @extension("x-ms-client-flatten", true) + @extension("x-ms-client-name", "properties") + properties: WebhookProperties; // Replace 'WebhookProperties' with the actual type +} + +@armResourceOperations +@tag("AppComplianceAutomation") +interface Webhook { + /** + * Get the AppComplianceAutomation webhook and its properties. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Webhook_Get") + get is ArmResourceRead; + + /** + * Create a new AppComplianceAutomation webhook or update an exiting AppComplianceAutomation webhook. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Webhook_CreateOrUpdate") + createOrUpdate is ArmResourceCreateOrReplaceSync; + + /** + * Update an exiting AppComplianceAutomation webhook. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @parameterVisibility + @operationId("Webhook_Update") + update is ArmCustomPatchSync< + WebhookResource, + WebhookResourcePatch, + Response = ArmResponse, + Error = ErrorResponse + >; + + /** + * Delete an AppComplianceAutomation webhook. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Webhook_Delete") + delete is ArmResourceDeleteSync; + + /** + * Get the AppComplianceAutomation webhook list. + */ + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "For backward compatibility" + @operationId("Webhook_List") + list is ArmResourceListByParent< + WebhookResource, + { + ...Azure.ResourceManager.Foundations.BaseParameters; + ...QueryParameters; + } + >; +} + +@@doc(Webhook.createOrUpdate::parameters.resource, + "Parameters for the create or update operation" +); +@@doc(Webhook.update::parameters.properties, + "Parameters for the create or update operation" +); + +@@encodedName(Webhook.update::parameters.properties, + "application/json", + "parameters" +); + +@@encodedName(Webhook.createOrUpdate::parameters.resource, + "application/json", + "parameters" +); + +@@OpenAPI.extension(Webhook.createOrUpdate::parameters.resource, + "x-ms-client-name", + "properties" +); + +@@clientName(Webhook.createOrUpdate::parameters.resource, "parameters"); diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/routes.tsp b/specification/appcomplianceautomation/AppComplianceAutomation.Management/routes.tsp new file mode 100644 index 000000000000..f5e9912fb6f4 --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/routes.tsp @@ -0,0 +1,91 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "./models/models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using OpenAPI; +using Azure.Core; +using Azure.Core.Traits; + +namespace Microsoft.AppComplianceAutomation; + +interface Operations extends Azure.ResourceManager.Operations {} + +alias PlaceholderResource = Azure.ResourceManager.Foundations.ProxyResource; + +alias ArmProviderActionAsync< + Request extends {} | void, + Response extends {} | void, + Parameters extends {} = {}, + LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader +> = Azure.ResourceManager.ArmResourceActionAsync< + PlaceholderResource, + Request, + Response | ArmAcceptedLroResponse<"Accepted", LroHeaders>, + BaseParameters = ApiVersionParameter, + Parameters = Parameters, + LroHeaders = ArmLroLocationHeader> +>; + +alias ArmProviderActionSync< + Request extends {} | void, + Response extends {} | void, + Parameters extends {} = {} +> = Azure.ResourceManager.ArmResourceActionSync< + PlaceholderResource, + Request, + Response, + BaseParameters = ApiVersionParameter, + Parameters = Parameters +>; + +@armResourceOperations +@tag("AppComplianceAutomation") +interface ProviderActions { + @doc("Check if the given name is available for a report.") + checkNameAvailability is ArmProviderActionSync< + Azure.ResourceManager.Foundations.CheckNameAvailabilityRequest, + Azure.ResourceManager.Foundations.CheckNameAvailabilityResponse + >; + + @doc("Get the count of reports.") + getCollectionCount is ArmProviderActionSync< + GetCollectionCountRequest, + GetCollectionCountResponse + >; + + @doc("Get the resource overview status.") + getOverviewStatus is ArmProviderActionSync< + GetOverviewStatusRequest, + GetOverviewStatusResponse + >; + + @doc("Onboard given subscriptions to Microsoft.AppComplianceAutomation provider.") + onboard is ArmProviderActionAsync; + + @doc("Trigger quick evaluation for the given subscriptions.") + triggerEvaluation is ArmProviderActionAsync< + TriggerEvaluationRequest, + TriggerEvaluationResponse + >; + + @doc("List the storage accounts which are in use by related reports") + listInUseStorageAccounts is ArmProviderActionSync< + ListInUseStorageAccountsRequest, + ListInUseStorageAccountsResponse + >; +} + +@@encodedName(ArmProviderActionAsync::parameters.body, + "application/json", + "parameters" +); +@@encodedName(ArmProviderActionSync::parameters.body, + "application/json", + "parameters" +); diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml b/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml new file mode 100644 index 000000000000..f7b8f046327c --- /dev/null +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml @@ -0,0 +1,34 @@ +parameters: + "service-dir": + default: "sdk/appcomplianceautomation" + "dependencies": + "additionalDirectories": [] + default: "" +emit: + - "@azure-tools/typespec-autorest" +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}/appcomplianceautomation.json" + examples-directory: "{project-root}/examples" + "@azure-tools/typespec-python": + flavor: azure + package-dir: "azure-mgmt-appcomplianceautomation" + package-name: "{package-dir}" + "@azure-tools/typespec-ts": + flavor: azure + package-dir: "arm-appcomplianceautomation" + packageDetails: + name: "@azure/arm-appcomplianceautomation" + examples-directory: "{project-root}/examples" + "@azure-tools/typespec-java": + flavor: azure + package-dir: "azure-resourcemanager-appcomplianceautomation" + namespace: "com.azure.resourcemanager.appcomplianceautomation" + service-name: "App Compliance Automation" + examples-directory: "examples" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/appcomplianceautomation.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/appcomplianceautomation.json new file mode 100644 index 000000000000..d602558f2e49 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/appcomplianceautomation.json @@ -0,0 +1,4552 @@ +{ + "swagger": "2.0", + "info": { + "title": "App Compliance Automation Tool for Microsoft 365", + "version": "2024-06-27", + "description": "App Compliance Automation Tool for Microsoft 365 API spec", + "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": "AppComplianceAutomation" + }, + { + "name": "Operations" + } + ], + "paths": { + "/providers/Microsoft.AppComplianceAutomation/checkNameAvailability": { + "post": { + "operationId": "ProviderActions_CheckNameAvailability", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Check if the given name is available for a report.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_CheckNameAvailability": { + "$ref": "./examples/Report_CheckNameAvailability.json" + } + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/getCollectionCount": { + "post": { + "operationId": "ProviderActions_GetCollectionCount", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Get the count of reports.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/GetCollectionCountRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GetCollectionCountResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_GetCollectionCount": { + "$ref": "./examples/Report_GetCollectionCount.json" + } + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/getOverviewStatus": { + "post": { + "operationId": "ProviderActions_GetOverviewStatus", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Get the resource overview status.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/GetOverviewStatusRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GetOverviewStatusResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_GetOverviewStatus": { + "$ref": "./examples/Report_GetOverviewStatus.json" + } + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/listInUseStorageAccounts": { + "post": { + "operationId": "ProviderActions_ListInUseStorageAccounts", + "tags": [ + "AppComplianceAutomation" + ], + "description": "List the storage accounts which are in use by related reports", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ListInUseStorageAccountsRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ListInUseStorageAccountsResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListInUseStorageAccountsWithSubscriptions": { + "$ref": "./examples/ListInUseStorageAccountsWithSubscriptions.json" + }, + "ListInUseStorageAccountsWithoutSubscriptions": { + "$ref": "./examples/ListInUseStorageAccountsWithoutSubscriptions.json" + } + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/onboard": { + "post": { + "operationId": "ProviderActions_Onboard", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Onboard given subscriptions to Microsoft.AppComplianceAutomation provider.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/OnboardRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OnboardResponse" + } + }, + "202": { + "description": "Resource operation 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Onboard": { + "$ref": "./examples/Onboard.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.AppComplianceAutomation/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports": { + "get": { + "operationId": "Report_List", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Get the AppComplianceAutomation report list for the tenant.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/QueryParameters.skipToken" + }, + { + "$ref": "#/parameters/QueryParameters.top" + }, + { + "$ref": "#/parameters/QueryParameters.select" + }, + { + "$ref": "#/parameters/QueryParameters.filter" + }, + { + "$ref": "#/parameters/QueryParameters.orderby" + }, + { + "$ref": "#/parameters/QueryParameters.offerGuid" + }, + { + "$ref": "#/parameters/QueryParameters.reportCreatorTenantId" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_List": { + "$ref": "./examples/Report_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}": { + "get": { + "operationId": "Report_Get", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Get the AppComplianceAutomation report and its properties.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_Get": { + "$ref": "./examples/Report_Get.json" + } + } + }, + "put": { + "operationId": "Report_CreateOrUpdate", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Create a new AppComplianceAutomation report or update an exiting AppComplianceAutomation report.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ReportResource" + }, + "x-ms-client-name": "properties" + } + ], + "responses": { + "200": { + "description": "Resource 'ReportResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/ReportResource" + } + }, + "201": { + "description": "Resource 'ReportResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/ReportResource" + }, + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_CreateOrUpdate": { + "$ref": "./examples/Report_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Report_Update", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Update an exiting AppComplianceAutomation report.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ReportResourcePatch" + }, + "x-ms-client-name": "properties" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportResource" + } + }, + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_Update": { + "$ref": "./examples/Report_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Report_Delete", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Delete an AppComplianceAutomation report.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + } + ], + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_Delete": { + "$ref": "./examples/Report_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/checkNameAvailability": { + "post": { + "operationId": "Report_NestedResourceCheckNameAvailability", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Checks the report's nested resource name availability, e.g: Webhooks, Evidences, Snapshots.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "parameters", + "in": "body", + "description": "NameAvailabilityRequest object.", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_EvidenceCheckNameAvailability": { + "$ref": "./examples/Report_NestedResourceCheckNameAvailability_Report_Evidence_Check_Name_Availability.json" + }, + "Report_SnapshotCheckNameAvailability": { + "$ref": "./examples/Report_NestedResourceCheckNameAvailability_Report_Snapshot_Check_Name_Availability.json" + }, + "Report_WebhookCheckNameAvailability": { + "$ref": "./examples/Report_NestedResourceCheckNameAvailability_Report_Webhook_Check_Name_Availability.json" + } + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/evidences": { + "get": { + "operationId": "Evidence_ListByReport", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Returns a paginated list of evidences for a specified report.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/QueryParameters.skipToken" + }, + { + "$ref": "#/parameters/QueryParameters.top" + }, + { + "$ref": "#/parameters/QueryParameters.select" + }, + { + "$ref": "#/parameters/QueryParameters.filter" + }, + { + "$ref": "#/parameters/QueryParameters.orderby" + }, + { + "$ref": "#/parameters/QueryParameters.offerGuid" + }, + { + "$ref": "#/parameters/QueryParameters.reportCreatorTenantId" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvidenceResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Evidence_ListByReport": { + "$ref": "./examples/Evidence_ListByReport.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/evidences/{evidenceName}": { + "get": { + "operationId": "Evidence_Get", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Get the evidence metadata", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "evidenceName", + "in": "path", + "description": "The evidence name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_.]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvidenceResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Evidence_Get": { + "$ref": "./examples/Evidence_Get.json" + } + } + }, + "put": { + "operationId": "Evidence_CreateOrUpdate", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Create or Update an evidence a specified report", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ExtraParameter.offerGuid" + }, + { + "$ref": "#/parameters/ExtraParameter.reportCreatorTenantId" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "evidenceName", + "in": "path", + "description": "The evidence name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_.]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/EvidenceResource" + }, + "x-ms-client-name": "properties" + } + ], + "responses": { + "200": { + "description": "Resource 'EvidenceResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EvidenceResource" + } + }, + "201": { + "description": "Resource 'EvidenceResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EvidenceResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Evidence_CreateOrUpdate": { + "$ref": "./examples/Evidence_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "Evidence_Delete", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Delete an existent evidence from a specified report", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "evidenceName", + "in": "path", + "description": "The evidence name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_.]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Evidence_Delete": { + "$ref": "./examples/Evidence_Delete.json" + } + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/evidences/{evidenceName}/download": { + "post": { + "operationId": "Evidence_Download", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Download evidence file.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "evidenceName", + "in": "path", + "description": "The evidence name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_.]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters for the query operation", + "required": true, + "schema": { + "$ref": "#/definitions/EvidenceFileDownloadRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvidenceFileDownloadResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Evidence_Download": { + "$ref": "./examples/Evidence_Download.json" + } + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/fix": { + "post": { + "operationId": "Report_Fix", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Fix the AppComplianceAutomation report error. e.g: App Compliance Automation Tool service unregistered, automation removed.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportFixResult" + } + }, + "202": { + "description": "Resource operation 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_Fix": { + "$ref": "./examples/Report_Fix.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/getScopingQuestions": { + "post": { + "operationId": "Report_GetScopingQuestions", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Fix the AppComplianceAutomation report error. e.g: App Compliance Automation Tool service unregistered, automation removed.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScopingQuestions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_GetScopingQuestions": { + "$ref": "./examples/Report_GetScopingQuestions.json" + } + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/scopingConfigurations": { + "get": { + "operationId": "ScopingConfiguration_List", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Returns a list format of the singleton scopingConfiguration for a specified report.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScopingConfigurationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScopingConfiguration_List": { + "$ref": "./examples/ScopingConfiguration_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/scopingConfigurations/{scopingConfigurationName}": { + "get": { + "operationId": "ScopingConfiguration_Get", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Get the AppComplianceAutomation scoping configuration of the specific report.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "scopingConfigurationName", + "in": "path", + "description": "The scoping configuration of the specific report.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScopingConfigurationResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScopingConfiguration": { + "$ref": "./examples/ScopingConfiguration_Get.json" + } + } + }, + "put": { + "operationId": "ScopingConfiguration_CreateOrUpdate", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Get the AppComplianceAutomation scoping configuration of the specific report.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "scopingConfigurationName", + "in": "path", + "description": "The scoping configuration of the specific report.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_]*$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation, this is a singleton resource, so please make sure you're using 'default' as the name.", + "required": true, + "schema": { + "$ref": "#/definitions/ScopingConfigurationResource" + }, + "x-ms-client-name": "properties" + } + ], + "responses": { + "200": { + "description": "Resource 'ScopingConfigurationResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/ScopingConfigurationResource" + } + }, + "201": { + "description": "Resource 'ScopingConfigurationResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/ScopingConfigurationResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScopingConfiguration_CreateOrUpdate": { + "$ref": "./examples/ScopingConfiguration_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "ScopingConfiguration_Delete", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Clean the AppComplianceAutomation scoping configuration of the specific report.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "scopingConfigurationName", + "in": "path", + "description": "The scoping configuration of the specific report.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScopingConfiguration_Delete": { + "$ref": "./examples/ScopingConfiguration_Delete.json" + } + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/snapshots": { + "get": { + "operationId": "Snapshot_List", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Get the AppComplianceAutomation snapshot list.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/QueryParameters.skipToken" + }, + { + "$ref": "#/parameters/QueryParameters.top" + }, + { + "$ref": "#/parameters/QueryParameters.select" + }, + { + "$ref": "#/parameters/QueryParameters.filter" + }, + { + "$ref": "#/parameters/QueryParameters.orderby" + }, + { + "$ref": "#/parameters/QueryParameters.offerGuid" + }, + { + "$ref": "#/parameters/QueryParameters.reportCreatorTenantId" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SnapshotResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshot_List": { + "$ref": "./examples/Snapshot_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/snapshots/{snapshotName}": { + "get": { + "operationId": "Snapshot_Get", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Get the AppComplianceAutomation snapshot and its properties.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "snapshotName", + "in": "path", + "description": "Snapshot Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_]{1,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SnapshotResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshot_Get": { + "$ref": "./examples/Snapshot_Get.json" + } + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/snapshots/{snapshotName}/download": { + "post": { + "operationId": "Snapshot_Download", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Download compliance needs from snapshot, like: Compliance Report, Resource List.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "snapshotName", + "in": "path", + "description": "Snapshot Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-_]{1,64}$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters for the query operation", + "required": true, + "schema": { + "$ref": "#/definitions/SnapshotDownloadRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadResponse" + } + }, + "202": { + "description": "Resource operation 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshot_Download_ComplianceDetailedPdfReport": { + "$ref": "./examples/Snapshot_Download_Snapshot_Download_Compliance_Detailed_Pdf_Report.json" + }, + "Snapshot_Download_CompliancePdfReport": { + "$ref": "./examples/Snapshot_Download_Snapshot_Download_Compliance_Pdf_Report.json" + }, + "Snapshot_Download_ComplianceReport": { + "$ref": "./examples/Snapshot_Download_Snapshot_Download_Compliance_Report.json" + }, + "Snapshot_Download_ResourceList": { + "$ref": "./examples/Snapshot_Download_Snapshot_Download_Resource_List.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/syncCertRecord": { + "post": { + "operationId": "Report_SyncCertRecord", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Synchronize attestation record from app compliance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters for synchronize certification record operation", + "required": true, + "schema": { + "$ref": "#/definitions/SyncCertRecordRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SyncCertRecordResponse" + } + }, + "202": { + "description": "Resource operation 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_SyncCertRecord": { + "$ref": "./examples/Report_SyncCertRecord.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/verify": { + "post": { + "operationId": "Report_Verify", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Verify the AppComplianceAutomation report health status.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportVerificationResult" + } + }, + "202": { + "description": "Resource operation 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Report_Verify": { + "$ref": "./examples/Report_Verify.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/webhooks": { + "get": { + "operationId": "Webhook_List", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Get the AppComplianceAutomation webhook list.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/QueryParameters.skipToken" + }, + { + "$ref": "#/parameters/QueryParameters.top" + }, + { + "$ref": "#/parameters/QueryParameters.select" + }, + { + "$ref": "#/parameters/QueryParameters.filter" + }, + { + "$ref": "#/parameters/QueryParameters.orderby" + }, + { + "$ref": "#/parameters/QueryParameters.offerGuid" + }, + { + "$ref": "#/parameters/QueryParameters.reportCreatorTenantId" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebhookResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Webhook_List": { + "$ref": "./examples/Webhook_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/webhooks/{webhookName}": { + "get": { + "operationId": "Webhook_Get", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Get the AppComplianceAutomation webhook and its properties.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "webhookName", + "in": "path", + "description": "Webhook Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebhookResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Webhook_Get": { + "$ref": "./examples/Webhook_Get.json" + } + } + }, + "put": { + "operationId": "Webhook_CreateOrUpdate", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Create a new AppComplianceAutomation webhook or update an exiting AppComplianceAutomation webhook.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "webhookName", + "in": "path", + "description": "Webhook Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/WebhookResource" + }, + "x-ms-client-name": "properties" + } + ], + "responses": { + "200": { + "description": "Resource 'WebhookResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/WebhookResource" + } + }, + "201": { + "description": "Resource 'WebhookResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/WebhookResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Webhook_CreateOrUpdate": { + "$ref": "./examples/Webhook_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "Webhook_Update", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Update an exiting AppComplianceAutomation webhook.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "webhookName", + "in": "path", + "description": "Webhook Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/WebhookResourcePatch" + }, + "x-ms-client-name": "properties" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebhookResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Webhook_Update": { + "$ref": "./examples/Webhook_Update.json" + } + } + }, + "delete": { + "operationId": "Webhook_Delete", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Delete an AppComplianceAutomation webhook.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "reportName", + "in": "path", + "description": "Report Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + { + "name": "webhookName", + "in": "path", + "description": "Webhook Name.", + "required": true, + "type": "string", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Webhook_Delete": { + "$ref": "./examples/Webhook_Delete.json" + } + } + } + }, + "/providers/Microsoft.AppComplianceAutomation/triggerEvaluation": { + "post": { + "operationId": "ProviderActions_TriggerEvaluation", + "tags": [ + "AppComplianceAutomation" + ], + "description": "Trigger quick evaluation for the given subscriptions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerEvaluationRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TriggerEvaluationResponse" + } + }, + "202": { + "description": "Resource operation 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TriggerEvaluation": { + "$ref": "./examples/TriggerEvaluation.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Category": { + "type": "object", + "description": "A class represent the compliance category.", + "properties": { + "categoryName": { + "type": "string", + "description": "The name of the compliance category. e.g. \"Operational Security\"", + "readOnly": true + }, + "categoryStatus": { + "$ref": "#/definitions/CategoryStatus", + "description": "Category status.", + "readOnly": true + }, + "controlFamilies": { + "type": "array", + "description": "List of control families.", + "items": { + "$ref": "#/definitions/ControlFamily" + }, + "readOnly": true, + "x-ms-identifiers": [ + "controlFamilyName" + ] + } + } + }, + "CategoryStatus": { + "type": "string", + "description": "Indicates the category status.", + "enum": [ + "Passed", + "Failed", + "NotApplicable", + "PendingApproval" + ], + "x-ms-enum": { + "name": "CategoryStatus", + "modelAsString": true, + "values": [ + { + "name": "Passed", + "value": "Passed", + "description": "The category is passed." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The category is failed." + }, + { + "name": "NotApplicable", + "value": "NotApplicable", + "description": "The category is not applicable." + }, + { + "name": "PendingApproval", + "value": "PendingApproval", + "description": "The category is pending for approval." + } + ] + } + }, + "CertSyncRecord": { + "type": "object", + "description": "A class represent the certification record synchronized from app compliance.", + "properties": { + "offerGuid": { + "type": "string", + "description": "The offerGuid which mapping to the reports.", + "minLength": 1 + }, + "certificationStatus": { + "type": "string", + "description": "Indicates the status of certification process." + }, + "ingestionStatus": { + "type": "string", + "description": "Indicates the status of compliance process." + }, + "controls": { + "type": "array", + "description": "The control records list to be synchronized.", + "items": { + "$ref": "#/definitions/ControlSyncRecord" + }, + "x-ms-identifiers": [ + "controlId" + ] + } + } + }, + "ComplianceReportItem": { + "type": "object", + "description": "Object that includes all the content for single compliance result.", + "properties": { + "categoryName": { + "type": "string", + "description": "The category name.", + "readOnly": true + }, + "controlFamilyName": { + "type": "string", + "description": "The control family name.", + "readOnly": true + }, + "controlId": { + "type": "string", + "description": "The control Id - e.g. \"1\".", + "readOnly": true + }, + "controlName": { + "type": "string", + "description": "The control name.", + "readOnly": true + }, + "controlStatus": { + "$ref": "#/definitions/ControlStatus", + "description": "Control status.", + "readOnly": true + }, + "responsibilityTitle": { + "type": "string", + "description": "The title of the customer responsibility.", + "readOnly": true + }, + "responsibilityDescription": { + "type": "string", + "description": "The description of the customer responsibility.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "The Id of the resource.", + "readOnly": true + }, + "resourceType": { + "type": "string", + "description": "The type of the resource. e.g. \"Microsoft.SignalRService/SignalR\"", + "readOnly": true + }, + "resourceOrigin": { + "$ref": "#/definitions/ResourceOrigin", + "description": "Resource origin.", + "readOnly": true + }, + "resourceStatus": { + "$ref": "#/definitions/ResourceStatus", + "description": "Resource status.", + "readOnly": true + }, + "resourceStatusChangeDate": { + "type": "string", + "format": "date-time", + "description": "The status change date for the resource.", + "readOnly": true + } + } + }, + "ComplianceResult": { + "type": "object", + "description": "A class represent the compliance result.", + "properties": { + "complianceName": { + "type": "string", + "description": "The name of the compliance. e.g. \"M365\"", + "readOnly": true + }, + "categories": { + "type": "array", + "description": "List of categories.", + "items": { + "$ref": "#/definitions/Category" + }, + "readOnly": true, + "x-ms-identifiers": [ + "categoryName" + ] + } + } + }, + "ContentType": { + "type": "string", + "description": "content type", + "enum": [ + "application/json" + ], + "x-ms-enum": { + "name": "ContentType", + "modelAsString": true, + "values": [ + { + "name": "ApplicationJson", + "value": "application/json", + "description": "The content type is application/json." + } + ] + } + }, + "Control": { + "type": "object", + "description": "A class represent the control.", + "properties": { + "controlId": { + "type": "string", + "description": "The Id of the control. e.g. \"Operational_Security_10\"", + "readOnly": true + }, + "controlName": { + "type": "string", + "description": "The name of the control. e.g. \"Unsupported OS and Software.\"", + "readOnly": true + }, + "controlFullName": { + "type": "string", + "description": "The full name of the control. e.g. \"Validate that unsupported operating systems and software components are not in use.\"", + "readOnly": true + }, + "controlDescription": { + "type": "string", + "description": "The control's description", + "readOnly": true + }, + "controlDescriptionHyperLink": { + "type": "string", + "description": "The hyper link to the control's description'.", + "readOnly": true + }, + "controlStatus": { + "$ref": "#/definitions/ControlStatus", + "description": "Control status.", + "readOnly": true + }, + "responsibilities": { + "type": "array", + "description": "List of customer responsibility.", + "items": { + "$ref": "#/definitions/Responsibility" + }, + "readOnly": true, + "x-ms-identifiers": [ + "responsibilityId" + ] + } + } + }, + "ControlFamily": { + "type": "object", + "description": "A class represent the control family.", + "properties": { + "controlFamilyName": { + "type": "string", + "description": "The name of the control family. e.g. \"Malware Protection - Anti-Virus\"", + "readOnly": true + }, + "controlFamilyStatus": { + "$ref": "#/definitions/ControlFamilyStatus", + "description": "The control family status", + "readOnly": true + }, + "controls": { + "type": "array", + "description": "List of controls.", + "items": { + "$ref": "#/definitions/Control" + }, + "readOnly": true, + "x-ms-identifiers": [ + "controlId" + ] + } + } + }, + "ControlFamilyStatus": { + "type": "string", + "description": "Indicates the control family status.", + "enum": [ + "Passed", + "Failed", + "NotApplicable", + "PendingApproval" + ], + "x-ms-enum": { + "name": "ControlFamilyStatus", + "modelAsString": true, + "values": [ + { + "name": "Passed", + "value": "Passed", + "description": "The control family is passed." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The control family is failed." + }, + { + "name": "NotApplicable", + "value": "NotApplicable", + "description": "The control family is not applicable." + }, + { + "name": "PendingApproval", + "value": "PendingApproval", + "description": "The control family is pending for approval." + } + ] + } + }, + "ControlStatus": { + "type": "string", + "description": "Indicates the control status.", + "enum": [ + "Passed", + "Failed", + "NotApplicable", + "PendingApproval" + ], + "x-ms-enum": { + "name": "ControlStatus", + "modelAsString": true, + "values": [ + { + "name": "Passed", + "value": "Passed", + "description": "The control is passed." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The control is failed." + }, + { + "name": "NotApplicable", + "value": "NotApplicable", + "description": "The control is not applicable." + }, + { + "name": "PendingApproval", + "value": "PendingApproval", + "description": "The control is pending for approval." + } + ] + } + }, + "ControlSyncRecord": { + "type": "object", + "description": "A class represent the control record synchronized from app compliance.", + "properties": { + "controlId": { + "type": "string", + "description": "The Id of the control. e.g. \"Operational_Security_10\"" + }, + "controlStatus": { + "type": "string", + "description": "Control status synchronized from app compliance." + } + } + }, + "DeliveryStatus": { + "type": "string", + "description": "webhook deliveryStatus", + "enum": [ + "Succeeded", + "Failed", + "NotStarted" + ], + "x-ms-enum": { + "name": "DeliveryStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The webhook is delivered successfully." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The webhook is failed to deliver." + }, + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The webhook is not delivered." + } + ] + }, + "readOnly": true + }, + "DownloadResponse": { + "type": "object", + "description": "Object that includes all the possible response for the download operation.", + "properties": { + "resourceList": { + "type": "array", + "description": "Resource list of the report", + "items": { + "$ref": "#/definitions/ResourceItem" + }, + "readOnly": true, + "x-ms-identifiers": [ + "resourceId" + ] + }, + "complianceReport": { + "type": "array", + "description": "List of the compliance result", + "items": { + "$ref": "#/definitions/ComplianceReportItem" + }, + "readOnly": true, + "x-ms-identifiers": [ + "controlId" + ] + }, + "compliancePdfReport": { + "$ref": "#/definitions/DownloadResponseCompliancePdfReport", + "description": "Compliance pdf report", + "readOnly": true + }, + "complianceDetailedPdfReport": { + "$ref": "#/definitions/DownloadResponseComplianceDetailedPdfReport", + "description": "The detailed compliance pdf report", + "readOnly": true + } + } + }, + "DownloadResponseComplianceDetailedPdfReport": { + "type": "object", + "description": "The detailed compliance pdf report", + "properties": { + "sasUri": { + "type": "string", + "description": "The uri of detailed compliance pdf report", + "readOnly": true + } + } + }, + "DownloadResponseCompliancePdfReport": { + "type": "object", + "description": "Compliance pdf report", + "properties": { + "sasUri": { + "type": "string", + "description": "The uri of compliance pdf report", + "readOnly": true + } + } + }, + "DownloadType": { + "type": "string", + "description": "Indicates the download type.", + "enum": [ + "ComplianceReport", + "CompliancePdfReport", + "ComplianceDetailedPdfReport", + "ResourceList" + ], + "x-ms-enum": { + "name": "DownloadType", + "modelAsString": true, + "values": [ + { + "name": "ComplianceReport", + "value": "ComplianceReport", + "description": "Download the compliance report." + }, + { + "name": "CompliancePdfReport", + "value": "CompliancePdfReport", + "description": "Download the compliance pdf report." + }, + { + "name": "ComplianceDetailedPdfReport", + "value": "ComplianceDetailedPdfReport", + "description": "Download the detailed compliance pdf report." + }, + { + "name": "ResourceList", + "value": "ResourceList", + "description": "Download the resource list of the report." + } + ] + } + }, + "EnableSslVerification": { + "type": "string", + "description": "whether to enable ssl verification", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "EnableSslVerification", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "true", + "description": "The ssl verification is enabled." + }, + { + "name": "False", + "value": "false", + "description": "The ssl verification is not enabled." + } + ] + } + }, + "EvidenceFileDownloadRequest": { + "type": "object", + "description": "Evidence file's download request.", + "properties": { + "reportCreatorTenantId": { + "type": "string", + "description": "Tenant id." + }, + "offerGuid": { + "type": "string", + "description": "The offerGuid which mapping to the reports.", + "minLength": 1 + } + } + }, + "EvidenceFileDownloadResponse": { + "type": "object", + "description": "Object that includes all the possible response for the evidence file download operation.", + "properties": { + "evidenceFile": { + "$ref": "#/definitions/EvidenceFileDownloadResponseEvidenceFile", + "description": "The uri of evidence file", + "readOnly": true + } + } + }, + "EvidenceFileDownloadResponseEvidenceFile": { + "type": "object", + "description": "The uri of evidence file", + "properties": { + "url": { + "type": "string", + "description": "The url of evidence file", + "readOnly": true + } + } + }, + "EvidenceProperties": { + "type": "object", + "description": "Evidence's properties.", + "properties": { + "evidenceType": { + "$ref": "#/definitions/EvidenceType", + "description": "Evidence type." + }, + "filePath": { + "type": "string", + "description": "The path of the file in storage." + }, + "extraData": { + "type": "string", + "description": "Extra data considered as evidence." + }, + "controlId": { + "type": "string", + "description": "Control id." + }, + "responsibilityId": { + "type": "string", + "description": "Responsibility id." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Azure lifecycle management", + "readOnly": true + } + }, + "required": [ + "filePath" + ] + }, + "EvidenceResource": { + "type": "object", + "description": "A class represent an AppComplianceAutomation evidence resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvidenceProperties", + "description": "Evidence property.", + "x-ms-client-flatten": true, + "x-ms-client-name": "properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "EvidenceResourceListResult": { + "type": "object", + "description": "The response of a EvidenceResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvidenceResource items on this page", + "items": { + "$ref": "#/definitions/EvidenceResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvidenceType": { + "type": "string", + "description": "Evidence type", + "enum": [ + "File", + "AutoCollectedEvidence", + "Data" + ], + "x-ms-enum": { + "name": "EvidenceType", + "modelAsString": true, + "values": [ + { + "name": "File", + "value": "File", + "description": "The evidence is a file." + }, + { + "name": "AutoCollectedEvidence", + "value": "AutoCollectedEvidence", + "description": "The evidence auto collected by App Compliance Automation." + }, + { + "name": "Data", + "value": "Data", + "description": "The evidence is data." + } + ] + } + }, + "GetCollectionCountRequest": { + "type": "object", + "description": "Get collection count's request object.", + "properties": { + "type": { + "type": "string", + "description": "The resource type." + } + } + }, + "GetCollectionCountResponse": { + "type": "object", + "description": "The get collection count response.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the specified resource." + } + } + }, + "GetOverviewStatusRequest": { + "type": "object", + "description": "Get overview status request object.", + "properties": { + "type": { + "type": "string", + "description": "The resource type." + } + } + }, + "GetOverviewStatusResponse": { + "type": "object", + "description": "The get overview status response.", + "properties": { + "statusList": { + "type": "array", + "description": "List of different status items.", + "items": { + "$ref": "#/definitions/StatusItem" + }, + "x-ms-identifiers": [ + "statusName" + ] + } + } + }, + "InputType": { + "type": "string", + "description": "Question input type.", + "enum": [ + "None", + "Text", + "Email", + "MultilineText", + "Url", + "Number", + "Boolean", + "Telephone", + "YesNoNa", + "Date", + "YearPicker", + "SingleSelection", + "SingleSelectDropdown", + "MultiSelectCheckbox", + "MultiSelectDropdown", + "MultiSelectDropdownCustom", + "Group", + "Upload" + ], + "x-ms-enum": { + "name": "InputType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "The input type is a text box." + }, + { + "name": "Text", + "value": "Text", + "description": "The input content is text string." + }, + { + "name": "Email", + "value": "Email", + "description": "The input content should be an email address." + }, + { + "name": "MultilineText", + "value": "MultilineText", + "description": "The input content should be multiline text." + }, + { + "name": "Url", + "value": "Url", + "description": "The input content should be a URL." + }, + { + "name": "Number", + "value": "Number", + "description": "The input content should be a number." + }, + { + "name": "Boolean", + "value": "Boolean", + "description": "The input content should be a boolean." + }, + { + "name": "Telephone", + "value": "Telephone", + "description": "The input content should be a telephone number." + }, + { + "name": "YesNoNa", + "value": "YesNoNa", + "description": "The input content should be Yes, No or Na." + }, + { + "name": "Date", + "value": "Date", + "description": "The input content should be a date." + }, + { + "name": "YearPicker", + "value": "YearPicker", + "description": "The input content is a Year, pick from the dropdown list." + }, + { + "name": "SingleSelection", + "value": "SingleSelection", + "description": "The input content is a single result seleted from the options." + }, + { + "name": "SingleSelectDropdown", + "value": "SingleSelectDropdown", + "description": "The input content is a single result seleted from the dropdown options." + }, + { + "name": "MultiSelectCheckbox", + "value": "MultiSelectCheckbox", + "description": "The input content are multiple results seleted from the checkboxes." + }, + { + "name": "MultiSelectDropdown", + "value": "MultiSelectDropdown", + "description": "The input content are multiple results seleted from the dropdown options." + }, + { + "name": "MultiSelectDropdownCustom", + "value": "MultiSelectDropdownCustom", + "description": "The input content are result seleted from the custom dropdown options." + }, + { + "name": "Group", + "value": "Group", + "description": "The input content is a group of answers." + }, + { + "name": "Upload", + "value": "Upload", + "description": "The input content is a uploaded file." + } + ] + } + }, + "IsRecommendSolution": { + "type": "string", + "description": "Indicates whether this solution is the recommended.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "IsRecommendSolution", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "true", + "description": "This solution is the recommended." + }, + { + "name": "False", + "value": "false", + "description": "This solution is not the recommended." + } + ] + } + }, + "ListInUseStorageAccountsRequest": { + "type": "object", + "description": "Parameters for listing in use storage accounts operation. If subscription list is null, it will check the user's all subscriptions.", + "properties": { + "subscriptionIds": { + "type": "array", + "description": "List of subscription ids to be query. If the list is null or empty, the API will query all the subscriptions of the user.", + "items": { + "type": "string" + } + } + } + }, + "ListInUseStorageAccountsResponse": { + "type": "object", + "description": "Parameters for listing in use storage accounts operation. If subscription list is null, it will check the user's all subscriptions.", + "properties": { + "storageAccountList": { + "type": "array", + "description": "The storage account list which in use in related reports.", + "items": { + "$ref": "#/definitions/StorageInfo" + }, + "x-ms-identifiers": [ + "accountName" + ] + } + } + }, + "NotificationEvent": { + "type": "string", + "description": "notification event.", + "enum": [ + "generate_snapshot_success", + "generate_snapshot_failed", + "assessment_failure", + "report_configuration_changes", + "report_deletion" + ], + "x-ms-enum": { + "name": "NotificationEvent", + "modelAsString": true, + "values": [ + { + "name": "generate_snapshot_success", + "value": "generate_snapshot_success", + "description": "The subscribed report's snapshot is successfully generated." + }, + { + "name": "generate_snapshot_failed", + "value": "generate_snapshot_failed", + "description": "The subscribed report's snapshot is failed to generate." + }, + { + "name": "assessment_failure", + "value": "assessment_failure", + "description": "The subscribed report failed while collecting the assessments." + }, + { + "name": "report_configuration_changes", + "value": "report_configuration_changes", + "description": "The subscribed report's configuration is changed." + }, + { + "name": "report_deletion", + "value": "report_deletion", + "description": "The subscribed report is deleted." + } + ] + } + }, + "OnboardRequest": { + "type": "object", + "description": "Parameters for onboard operation", + "properties": { + "subscriptionIds": { + "type": "array", + "description": "List of subscription ids to be onboarded", + "items": { + "type": "string" + } + } + }, + "required": [ + "subscriptionIds" + ] + }, + "OnboardResponse": { + "type": "object", + "description": "Success. The response indicates given subscriptions has been onboarded.", + "properties": { + "subscriptionIds": { + "type": "array", + "description": "List of subscription ids that are onboarded", + "items": { + "type": "string" + } + } + } + }, + "OverviewStatus": { + "type": "object", + "description": "The overview of the compliance result for one report.", + "properties": { + "passedCount": { + "type": "integer", + "format": "int32", + "description": "The count of all passed control.", + "readOnly": true + }, + "failedCount": { + "type": "integer", + "format": "int32", + "description": "The count of all failed control.", + "readOnly": true + }, + "manualCount": { + "type": "integer", + "format": "int32", + "description": "The count of all manual control.", + "readOnly": true + }, + "notApplicableCount": { + "type": "integer", + "format": "int32", + "description": "The count of all not applicable control.", + "readOnly": true + }, + "pendingCount": { + "type": "integer", + "format": "int32", + "description": "The count of all pending for approval control.", + "readOnly": true + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "Resource provisioning states.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Deleting", + "Fixing", + "Verifying", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The provision is succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The provision is failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The provision is canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "The creation is in progress." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The deletion is in progress." + }, + { + "name": "Fixing", + "value": "Fixing", + "description": "The fix of the resource in progress." + }, + { + "name": "Verifying", + "value": "Verifying", + "description": "The verification of the resource in progress." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The update of the resource in progress." + } + ] + }, + "readOnly": true + }, + "QuickAssessment": { + "type": "object", + "description": "A class represent the quick assessment.", + "properties": { + "resourceId": { + "type": "string", + "description": "Resource id.", + "readOnly": true + }, + "responsibilityId": { + "type": "string", + "description": "Responsibility id.", + "readOnly": true + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "readOnly": true + }, + "resourceStatus": { + "$ref": "#/definitions/ResourceStatus", + "description": "Quick assessment status.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Quick assessment display name.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Quick assessment display name.", + "readOnly": true + }, + "remediationLink": { + "type": "string", + "description": "Link to remediation steps for this quick assessment.", + "readOnly": true + } + } + }, + "Recommendation": { + "type": "object", + "description": "A class represent the recommendation.", + "properties": { + "recommendationId": { + "type": "string", + "description": "The Id of the recommendation.", + "readOnly": true + }, + "recommendationShortName": { + "type": "string", + "description": "The short name of the recommendation. e.g. \"Invalid TLS config\"", + "readOnly": true + }, + "recommendationSolutions": { + "type": "array", + "description": "List of recommendation solutions.", + "items": { + "$ref": "#/definitions/RecommendationSolution" + }, + "readOnly": true, + "x-ms-identifiers": [ + "recommendationSolutionIndex" + ] + } + } + }, + "RecommendationSolution": { + "type": "object", + "description": "A class represent the recommendation solution.", + "properties": { + "recommendationSolutionIndex": { + "type": "string", + "description": "The index of the recommendation solution.", + "readOnly": true + }, + "recommendationSolutionContent": { + "type": "string", + "description": "The detail steps of the recommendation solution.", + "readOnly": true + }, + "isRecommendSolution": { + "$ref": "#/definitions/IsRecommendSolution", + "description": "Indicates whether this solution is the recommended.", + "readOnly": true + } + } + }, + "ReportComplianceStatus": { + "type": "object", + "description": "A list which includes all the compliance result for one report.", + "properties": { + "m365": { + "$ref": "#/definitions/OverviewStatus", + "description": "The Microsoft 365 certification name.", + "readOnly": true + } + } + }, + "ReportFixResult": { + "type": "object", + "description": "Report fix result.", + "properties": { + "result": { + "$ref": "#/definitions/Result", + "description": "Indicates whether the fix action is Succeeded or Failed.", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "If the report fix action failed, to indicate the detailed failed reason.", + "readOnly": true + } + } + }, + "ReportPatchProperties": { + "type": "object", + "description": "Patch Report's properties.", + "properties": { + "triggerTime": { + "type": "string", + "format": "date-time", + "description": "Report collection trigger time." + }, + "timeZone": { + "type": "string", + "description": "Report collection trigger time's time zone, the available list can be obtained by executing \"Get-TimeZone -ListAvailable\" in PowerShell.\nAn example of valid timezone id is \"Pacific Standard Time\"." + }, + "resources": { + "type": "array", + "description": "List of resource data.", + "items": { + "$ref": "#/definitions/ResourceMetadata" + }, + "x-ms-identifiers": [ + "resourceId" + ] + }, + "status": { + "$ref": "#/definitions/ReportStatus", + "description": "Report status.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "List of report error codes.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "Report's tenant id.", + "readOnly": true + }, + "offerGuid": { + "type": "string", + "description": "A list of comma-separated offerGuids indicates a series of offerGuids that map to the report. For example, \"00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002\" and \"00000000-0000-0000-0000-000000000003\"." + }, + "nextTriggerTime": { + "type": "string", + "format": "date-time", + "description": "Report next collection trigger time.", + "readOnly": true + }, + "lastTriggerTime": { + "type": "string", + "format": "date-time", + "description": "Report last collection trigger time.", + "readOnly": true + }, + "subscriptions": { + "type": "array", + "description": "List of subscription Ids.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "complianceStatus": { + "$ref": "#/definitions/ReportComplianceStatus", + "description": "Report compliance status.", + "readOnly": true + }, + "storageInfo": { + "$ref": "#/definitions/StorageInfo", + "description": "The information of 'bring your own storage' binding to the report" + }, + "certRecords": { + "type": "array", + "description": "List of synchronized certification records.", + "items": { + "$ref": "#/definitions/CertSyncRecord" + }, + "readOnly": true, + "x-ms-identifiers": [ + "offerGuid" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Azure lifecycle management", + "readOnly": true + } + } + }, + "ReportProperties": { + "type": "object", + "description": "Create Report's properties.", + "properties": { + "triggerTime": { + "type": "string", + "format": "date-time", + "description": "Report collection trigger time." + }, + "timeZone": { + "type": "string", + "description": "Report collection trigger time's time zone, the available list can be obtained by executing \"Get-TimeZone -ListAvailable\" in PowerShell.\nAn example of valid timezone id is \"Pacific Standard Time\"." + }, + "resources": { + "type": "array", + "description": "List of resource data.", + "items": { + "$ref": "#/definitions/ResourceMetadata" + }, + "x-ms-identifiers": [ + "resourceId" + ] + }, + "status": { + "$ref": "#/definitions/ReportStatus", + "description": "Report status.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "List of report error codes.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "Report's tenant id.", + "readOnly": true + }, + "offerGuid": { + "type": "string", + "description": "A list of comma-separated offerGuids indicates a series of offerGuids that map to the report. For example, \"00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002\" and \"00000000-0000-0000-0000-000000000003\"." + }, + "nextTriggerTime": { + "type": "string", + "format": "date-time", + "description": "Report next collection trigger time.", + "readOnly": true + }, + "lastTriggerTime": { + "type": "string", + "format": "date-time", + "description": "Report last collection trigger time.", + "readOnly": true + }, + "subscriptions": { + "type": "array", + "description": "List of subscription Ids.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "complianceStatus": { + "$ref": "#/definitions/ReportComplianceStatus", + "description": "Report compliance status.", + "readOnly": true + }, + "storageInfo": { + "$ref": "#/definitions/StorageInfo", + "description": "The information of 'bring your own storage' binding to the report" + }, + "certRecords": { + "type": "array", + "description": "List of synchronized certification records.", + "items": { + "$ref": "#/definitions/CertSyncRecord" + }, + "readOnly": true, + "x-ms-identifiers": [ + "offerGuid" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Azure lifecycle management", + "readOnly": true + } + }, + "required": [ + "triggerTime", + "timeZone", + "resources" + ] + }, + "ReportResource": { + "type": "object", + "description": "A class represent an AppComplianceAutomation report resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ReportProperties", + "description": "Report property.", + "x-ms-client-flatten": true, + "x-ms-client-name": "properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ReportResourceListResult": { + "type": "object", + "description": "The response of a ReportResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ReportResource items on this page", + "items": { + "$ref": "#/definitions/ReportResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ReportResourcePatch": { + "type": "object", + "description": "A class represent a AppComplianceAutomation report resource update properties.", + "properties": { + "properties": { + "$ref": "#/definitions/ReportPatchProperties", + "description": "Report property." + } + } + }, + "ReportStatus": { + "type": "string", + "description": "Report status.", + "enum": [ + "Active", + "Failed", + "Reviewing", + "Disabled" + ], + "x-ms-enum": { + "name": "ReportStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "The report is active." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The report is failed." + }, + { + "name": "Reviewing", + "value": "Reviewing", + "description": "The report is under reviewing." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The report is disabled." + } + ] + } + }, + "ReportVerificationResult": { + "type": "object", + "description": "Report health status verification result.", + "properties": { + "result": { + "$ref": "#/definitions/Result", + "description": "Indicates whether the report verification action is Succeeded or Failed.", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "If the report verification action failed, to indicate the detailed failed reason.", + "readOnly": true + } + } + }, + "ResourceItem": { + "type": "object", + "description": "Resource Id.", + "properties": { + "subscriptionId": { + "type": "string", + "description": "The subscription Id of this resource.", + "readOnly": true + }, + "resourceGroup": { + "type": "string", + "description": "The resource group name of this resource.", + "readOnly": true + }, + "resourceType": { + "type": "string", + "description": "The resource type of this resource. e.g. \"Microsoft.SignalRService/SignalR\"", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "The resource Id - e.g. \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1\".", + "readOnly": true + } + } + }, + "ResourceMetadata": { + "type": "object", + "description": "Single resource Id's metadata.", + "properties": { + "resourceId": { + "type": "string", + "description": "Resource Id - e.g. \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1\"." + }, + "resourceType": { + "type": "string", + "description": "Resource type. e.g. \"Microsoft.Compute/virtualMachines\"" + }, + "resourceKind": { + "type": "string", + "description": "Resource kind." + }, + "resourceOrigin": { + "$ref": "#/definitions/ResourceOrigin", + "description": "Resource Origin." + }, + "accountId": { + "type": "string", + "description": "Account Id. For example - the AWS account id." + } + }, + "required": [ + "resourceId" + ] + }, + "ResourceOrigin": { + "type": "string", + "description": "Resource Origin.", + "enum": [ + "Azure", + "AWS", + "GCP" + ], + "x-ms-enum": { + "name": "ResourceOrigin", + "modelAsString": true, + "values": [ + { + "name": "Azure", + "value": "Azure", + "description": "The resource is from Azure." + }, + { + "name": "AWS", + "value": "AWS", + "description": "The resource is from AWS." + }, + { + "name": "GCP", + "value": "GCP", + "description": "The resource is from GCP." + } + ] + } + }, + "ResourceStatus": { + "type": "string", + "description": "Indicates the resource status.", + "enum": [ + "Healthy", + "Unhealthy" + ], + "x-ms-enum": { + "name": "ResourceStatus", + "modelAsString": true, + "values": [ + { + "name": "Healthy", + "value": "Healthy", + "description": "The resource is healthy." + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "The resource is unhealthy." + } + ] + } + }, + "Responsibility": { + "type": "object", + "description": "A class represent the customer responsibility.", + "properties": { + "responsibilityId": { + "type": "string", + "description": "The id of the customer responsibility.", + "readOnly": true + }, + "responsibilityTitle": { + "type": "string", + "description": "The title of the customer responsibility.", + "readOnly": true + }, + "responsibilityDescription": { + "type": "string", + "description": "The description of the customer responsibility.", + "readOnly": true + }, + "responsibilityType": { + "$ref": "#/definitions/ResponsibilityType", + "description": "The type of customer responsibility.", + "readOnly": true + }, + "responsibilitySeverity": { + "$ref": "#/definitions/ResponsibilitySeverity", + "description": "The severity level of this customer responsibility.", + "readOnly": true + }, + "responsibilityStatus": { + "$ref": "#/definitions/ResponsibilityStatus", + "description": "The status of this customer responsibility.", + "readOnly": true + }, + "responsibilityEnvironment": { + "$ref": "#/definitions/ResponsibilityEnvironment", + "description": "The supported cloud environment of this customer responsibility.", + "readOnly": true + }, + "failedResourceCount": { + "type": "integer", + "format": "int32", + "description": "The count of all failed resources." + }, + "totalResourceCount": { + "type": "integer", + "format": "int32", + "description": "The count of all resources." + }, + "resourceList": { + "type": "array", + "description": "List of resource.", + "items": { + "$ref": "#/definitions/ResponsibilityResource" + }, + "readOnly": true, + "x-ms-identifiers": [ + "resourceId" + ] + }, + "recommendationList": { + "type": "array", + "description": "List of recommendation.", + "items": { + "$ref": "#/definitions/Recommendation" + }, + "readOnly": true, + "x-ms-identifiers": [ + "recommendationId" + ] + }, + "guidance": { + "type": "string", + "description": "The evidence upload guidance description.", + "readOnly": true + }, + "justification": { + "type": "string", + "description": "The justification given by the user to clarify the reason.", + "readOnly": true + }, + "evidenceFiles": { + "type": "array", + "description": "List of evidence file url.", + "items": { + "type": "string" + } + } + } + }, + "ResponsibilityEnvironment": { + "type": "string", + "description": "Indicates the customer responsibility supported cloud environment.", + "enum": [ + "Azure", + "AWS", + "GCP", + "General" + ], + "x-ms-enum": { + "name": "ResponsibilityEnvironment", + "modelAsString": true, + "values": [ + { + "name": "Azure", + "value": "Azure", + "description": "The responsibility is supported in Azure." + }, + { + "name": "AWS", + "value": "AWS", + "description": "The responsibility is supported in AWS." + }, + { + "name": "GCP", + "value": "GCP", + "description": "The responsibility is supported in GCP." + }, + { + "name": "General", + "value": "General", + "description": "The responsibility is general requirement of all environment." + } + ] + } + }, + "ResponsibilityResource": { + "type": "object", + "description": "A class represent the resource.", + "properties": { + "resourceId": { + "type": "string", + "description": "The Id of the resource.", + "readOnly": true + }, + "accountId": { + "type": "string", + "description": "Account Id. For example - AWS account Id.", + "readOnly": true + }, + "resourceType": { + "type": "string", + "description": "The type of the resource. e.g. \"Microsoft.SignalRService/SignalR\"", + "readOnly": true + }, + "resourceOrigin": { + "$ref": "#/definitions/ResourceOrigin", + "description": "Resource origin.", + "readOnly": true + }, + "resourceStatus": { + "$ref": "#/definitions/ResourceStatus", + "description": "Resource status.", + "readOnly": true + }, + "resourceStatusChangeDate": { + "type": "string", + "format": "date-time", + "description": "The status change date for the resource.", + "readOnly": true + }, + "recommendationIds": { + "type": "array", + "description": "List of recommendation id.", + "items": { + "type": "string" + } + } + } + }, + "ResponsibilitySeverity": { + "type": "string", + "description": "Indicates the customer responsibility severity.", + "enum": [ + "High", + "Medium", + "Low" + ], + "x-ms-enum": { + "name": "ResponsibilitySeverity", + "modelAsString": true, + "values": [ + { + "name": "High", + "value": "High", + "description": "The responsibility is high severity." + }, + { + "name": "Medium", + "value": "Medium", + "description": "The responsibility is medium severity." + }, + { + "name": "Low", + "value": "Low", + "description": "The responsibility is low severity." + } + ] + } + }, + "ResponsibilityStatus": { + "type": "string", + "description": "Indicates the customer responsibility status.", + "enum": [ + "Passed", + "Failed", + "NotApplicable", + "PendingApproval" + ], + "x-ms-enum": { + "name": "ResponsibilityStatus", + "modelAsString": true, + "values": [ + { + "name": "Passed", + "value": "Passed", + "description": "The responsibility is passed." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The responsibility is failed." + }, + { + "name": "NotApplicable", + "value": "NotApplicable", + "description": "The responsibility is not applicable." + }, + { + "name": "PendingApproval", + "value": "PendingApproval", + "description": "The responsibility is pending for approval." + } + ] + } + }, + "ResponsibilityType": { + "type": "string", + "description": "Indicates the customer responsibility type.", + "enum": [ + "Automated", + "ScopedManual", + "Manual" + ], + "x-ms-enum": { + "name": "ResponsibilityType", + "modelAsString": true, + "values": [ + { + "name": "Automated", + "value": "Automated", + "description": "The responsibility is automated." + }, + { + "name": "ScopedManual", + "value": "ScopedManual", + "description": "The responsibility is scoped manual." + }, + { + "name": "Manual", + "value": "Manual", + "description": "The responsibility is manual." + } + ] + } + }, + "Result": { + "type": "string", + "description": "Indicates whether the fix action is Succeeded or Failed.", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "Result", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The result is succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The result is failed." + } + ] + }, + "readOnly": true + }, + "Rule": { + "type": "string", + "description": "Scoping question rule.", + "enum": [ + "Required", + "CharLength", + "Url", + "Urls", + "Domains", + "USPrivacyShield", + "PublicSOX", + "CreditCardPCI", + "AzureApplication", + "ValidGuid", + "PublisherVerification", + "DynamicDropdown", + "PreventNonEnglishChar", + "ValidEmail" + ], + "x-ms-enum": { + "name": "Rule", + "modelAsString": true, + "values": [ + { + "name": "Required", + "value": "Required", + "description": "The question is required to answer." + }, + { + "name": "CharLength", + "value": "CharLength", + "description": "The question answer length is limited." + }, + { + "name": "Url", + "value": "Url", + "description": "The question answer should be an Url." + }, + { + "name": "Urls", + "value": "Urls", + "description": "The question answer should be Urls." + }, + { + "name": "Domains", + "value": "Domains", + "description": "The question answer should be domains." + }, + { + "name": "USPrivacyShield", + "value": "USPrivacyShield", + "description": "The question answer should be a UsPrivacyShield." + }, + { + "name": "PublicSOX", + "value": "PublicSOX", + "description": "The question answer should be a PublicSOX." + }, + { + "name": "CreditCardPCI", + "value": "CreditCardPCI", + "description": "The question answer should be a CreditCardPCI." + }, + { + "name": "AzureApplication", + "value": "AzureApplication", + "description": "The question answer should be an AzureApplication." + }, + { + "name": "ValidGuid", + "value": "ValidGuid", + "description": "The question answer should be a valid guid." + }, + { + "name": "PublisherVerification", + "value": "PublisherVerification", + "description": "The question answer should be publisher verification." + }, + { + "name": "DynamicDropdown", + "value": "DynamicDropdown", + "description": "The question answer should be dynamic dropdown." + }, + { + "name": "PreventNonEnglishChar", + "value": "PreventNonEnglishChar", + "description": "The question answer should prevent non-english char." + }, + { + "name": "ValidEmail", + "value": "ValidEmail", + "description": "The question answer should be a valid email." + } + ] + } + }, + "ScopingAnswer": { + "type": "object", + "description": "Scoping answer.", + "properties": { + "questionId": { + "type": "string", + "description": "Question id.", + "pattern": "^[-a-zA-Z0-9_]{1,50}$" + }, + "answers": { + "type": "array", + "description": "Question answer value list.", + "items": { + "type": "string" + } + } + }, + "required": [ + "questionId", + "answers" + ] + }, + "ScopingConfigurationProperties": { + "type": "object", + "description": "ScopingConfiguration's properties.", + "properties": { + "answers": { + "type": "array", + "description": "List of scoping question answers.", + "items": { + "$ref": "#/definitions/ScopingAnswer" + }, + "x-ms-identifiers": [ + "questionId" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Azure lifecycle management", + "readOnly": true + } + } + }, + "ScopingConfigurationResource": { + "type": "object", + "description": "A class represent an AppComplianceAutomation scoping configuration resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ScopingConfigurationProperties", + "description": "ScopingConfiguration property.", + "x-ms-client-flatten": true, + "x-ms-client-name": "properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ScopingConfigurationResourceListResult": { + "type": "object", + "description": "The response of a ScopingConfigurationResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ScopingConfigurationResource items on this page", + "items": { + "$ref": "#/definitions/ScopingConfigurationResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ScopingQuestion": { + "type": "object", + "description": "The definition of a scoping question.", + "properties": { + "questionId": { + "type": "string", + "description": "Question id.", + "readOnly": true + }, + "superiorQuestionId": { + "type": "string", + "description": "Superior question id.", + "readOnly": true + }, + "inputType": { + "$ref": "#/definitions/InputType", + "description": "Input type of the question answer.", + "readOnly": true + }, + "optionIds": { + "type": "array", + "description": "Option id list.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "rules": { + "type": "array", + "description": "The rule of the question.", + "items": { + "$ref": "#/definitions/Rule" + }, + "readOnly": true + }, + "showSubQuestionsValue": { + "type": "string", + "description": "The answer value to show the sub questions.", + "readOnly": true + } + }, + "required": [ + "questionId", + "inputType", + "optionIds", + "rules" + ] + }, + "ScopingQuestions": { + "type": "object", + "description": "Scoping question list.", + "properties": { + "questions": { + "type": "array", + "description": "List of scoping questions.", + "items": { + "$ref": "#/definitions/ScopingQuestion" + }, + "x-ms-identifiers": [ + "questionId" + ] + } + } + }, + "SendAllEvents": { + "type": "string", + "description": "whether to send notification under any event.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "SendAllEvents", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "true", + "description": "Need send notification under any event." + }, + { + "name": "False", + "value": "false", + "description": "No need to send notification under any event." + } + ] + } + }, + "SnapshotDownloadRequest": { + "type": "object", + "description": "Snapshot's download request.", + "properties": { + "reportCreatorTenantId": { + "type": "string", + "description": "Tenant id." + }, + "downloadType": { + "$ref": "#/definitions/DownloadType", + "description": "Indicates the download type." + }, + "offerGuid": { + "type": "string", + "description": "The offerGuid which mapping to the reports.", + "minLength": 1 + } + }, + "required": [ + "downloadType" + ] + }, + "SnapshotProperties": { + "type": "object", + "description": "Snapshot's properties.", + "properties": { + "snapshotName": { + "type": "string", + "description": "Snapshot name.", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Azure lifecycle management", + "readOnly": true + }, + "reportProperties": { + "$ref": "#/definitions/ReportProperties", + "description": "The report essential info.", + "readOnly": true + }, + "reportSystemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + }, + "complianceResults": { + "type": "array", + "description": "List of compliance results.", + "items": { + "$ref": "#/definitions/ComplianceResult" + }, + "readOnly": true, + "x-ms-identifiers": [ + "complianceName" + ] + } + } + }, + "SnapshotResource": { + "type": "object", + "description": "A class represent a AppComplianceAutomation snapshot resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SnapshotProperties", + "description": "Snapshot's property.", + "x-ms-client-flatten": true, + "x-ms-client-name": "properties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SnapshotResourceListResult": { + "type": "object", + "description": "The response of a SnapshotResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SnapshotResource items on this page", + "items": { + "$ref": "#/definitions/SnapshotResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "StatusItem": { + "type": "object", + "description": "Single status.", + "properties": { + "statusName": { + "type": "string", + "description": "Status name - e.g. \"Active\", \"Failed\"." + }, + "statusValue": { + "type": "string", + "description": "Status value. e.g. \"100\", or \"100%\"." + } + } + }, + "StorageInfo": { + "type": "object", + "description": "The information of 'bring your own storage' account binding to the report", + "properties": { + "subscriptionId": { + "type": "string", + "description": "The subscription id which 'bring your own storage' account belongs to" + }, + "resourceGroup": { + "type": "string", + "description": "The resourceGroup which 'bring your own storage' account belongs to" + }, + "accountName": { + "type": "string", + "description": "'bring your own storage' account name" + }, + "location": { + "type": "string", + "description": "The region of 'bring your own storage' account" + } + } + }, + "SyncCertRecordRequest": { + "type": "object", + "description": "Synchronize certification record request.", + "properties": { + "certRecord": { + "$ref": "#/definitions/CertSyncRecord", + "description": "certification record to be synchronized." + } + }, + "required": [ + "certRecord" + ] + }, + "SyncCertRecordResponse": { + "type": "object", + "description": "Synchronize certification record response.", + "properties": { + "certRecord": { + "$ref": "#/definitions/CertSyncRecord", + "description": "certification record synchronized." + } + } + }, + "TriggerEvaluationProperty": { + "type": "object", + "description": "Trigger evaluation response.", + "properties": { + "triggerTime": { + "type": "string", + "format": "date-time", + "description": "The time when the evaluation is triggered.", + "readOnly": true + }, + "evaluationEndTime": { + "type": "string", + "format": "date-time", + "description": "The time when the evaluation is end.", + "readOnly": true + }, + "resourceIds": { + "type": "array", + "description": "List of resource ids to be evaluated", + "items": { + "type": "string" + }, + "x-ms-identifiers": [ + "resourceId" + ] + }, + "quickAssessments": { + "type": "array", + "description": "List of quick assessments", + "items": { + "$ref": "#/definitions/QuickAssessment" + }, + "x-ms-identifiers": [ + "resourceId" + ] + } + } + }, + "TriggerEvaluationRequest": { + "type": "object", + "description": "Trigger evaluation request.", + "properties": { + "resourceIds": { + "type": "array", + "description": "List of resource ids to be evaluated", + "items": { + "type": "string" + } + } + }, + "required": [ + "resourceIds" + ] + }, + "TriggerEvaluationResponse": { + "type": "object", + "description": "Trigger evaluation response.", + "properties": { + "properties": { + "$ref": "#/definitions/TriggerEvaluationProperty", + "description": "trigger evaluation property." + } + } + }, + "UpdateWebhookKey": { + "type": "string", + "description": "whether to update webhookKey.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "UpdateWebhookKey", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "true", + "description": "Need update the webhook key." + }, + { + "name": "False", + "value": "false", + "description": "No need to update the webhook key." + } + ] + } + }, + "WebhookKeyEnabled": { + "type": "string", + "description": "whether webhookKey is enabled.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "WebhookKeyEnabled", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "true", + "description": "The webhookKey is enabled." + }, + { + "name": "False", + "value": "false", + "description": "The webhookKey is not enabled." + } + ] + } + }, + "WebhookProperties": { + "type": "object", + "description": "Webhook properties.", + "properties": { + "webhookId": { + "type": "string", + "description": "Webhook id in database.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/WebhookStatus", + "description": "Webhook status." + }, + "tenantId": { + "type": "string", + "description": "Tenant id.", + "readOnly": true + }, + "sendAllEvents": { + "$ref": "#/definitions/SendAllEvents", + "description": "whether to send notification under any event." + }, + "events": { + "type": "array", + "description": "under which event notification should be sent.", + "items": { + "$ref": "#/definitions/NotificationEvent" + } + }, + "payloadUrl": { + "type": "string", + "description": "webhook payload url", + "pattern": "^(http(s)?://)[\\S]{0,64994}$" + }, + "contentType": { + "$ref": "#/definitions/ContentType", + "description": "content type" + }, + "webhookKey": { + "type": "string", + "description": "webhook secret token. If not set, this field value is null; otherwise, please set a string value.", + "pattern": "^.{0,2048}$" + }, + "updateWebhookKey": { + "$ref": "#/definitions/UpdateWebhookKey", + "description": "whether to update webhookKey." + }, + "webhookKeyEnabled": { + "$ref": "#/definitions/WebhookKeyEnabled", + "description": "whether webhookKey is enabled.", + "readOnly": true + }, + "enableSslVerification": { + "$ref": "#/definitions/EnableSslVerification", + "description": "whether to enable ssl verification" + }, + "deliveryStatus": { + "$ref": "#/definitions/DeliveryStatus", + "description": "webhook deliveryStatus", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Azure Resource Provisioning State", + "readOnly": true + } + } + }, + "WebhookResource": { + "type": "object", + "description": "A class represent an AppComplianceAutomation webhook resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebhookProperties", + "description": "Webhook property.", + "x-ms-client-flatten": true, + "x-ms-client-name": "properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "WebhookResourceListResult": { + "type": "object", + "description": "The response of a WebhookResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebhookResource items on this page", + "items": { + "$ref": "#/definitions/WebhookResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebhookResourcePatch": { + "type": "object", + "description": "A class represent a AppComplianceAutomation webhook resource update properties.", + "properties": { + "properties": { + "$ref": "#/definitions/WebhookProperties", + "description": "Webhook property." + } + } + }, + "WebhookStatus": { + "type": "string", + "description": "Webhook status.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "WebhookStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The webhook is enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The webhook is disabled." + } + ] + } + } + }, + "parameters": { + "ExtraParameter.offerGuid": { + "name": "offerGuid", + "in": "query", + "description": "The offerGuid which mapping to the reports.", + "required": false, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "ExtraParameter.reportCreatorTenantId": { + "name": "reportCreatorTenantId", + "in": "query", + "description": "The tenant id of the report creator.", + "required": false, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "QueryParameters.filter": { + "name": "$filter", + "in": "query", + "description": "The filter to apply on the operation.", + "required": false, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "filter" + }, + "QueryParameters.offerGuid": { + "name": "offerGuid", + "in": "query", + "description": "The offerGuid which mapping to the reports.", + "required": false, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "QueryParameters.orderby": { + "name": "$orderby", + "in": "query", + "description": "OData order by query option.", + "required": false, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "orderby" + }, + "QueryParameters.reportCreatorTenantId": { + "name": "reportCreatorTenantId", + "in": "query", + "description": "The tenant id of the report creator.", + "required": false, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "QueryParameters.select": { + "name": "$select", + "in": "query", + "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. ?$select=reportName,id.", + "required": false, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "select" + }, + "QueryParameters.skipToken": { + "name": "$skipToken", + "in": "query", + "description": "Skip over when retrieving results.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-client-name": "skipToken" + }, + "QueryParameters.top": { + "name": "$top", + "in": "query", + "description": "Number of elements to return when retrieving results.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "x-ms-parameter-location": "method", + "x-ms-client-name": "top" + } + } +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_CreateOrUpdate.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_CreateOrUpdate.json new file mode 100644 index 000000000000..af439f4648bc --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_CreateOrUpdate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "evidenceName": "evidence1", + "parameters": { + "properties": { + "controlId": "Operational_Security_10", + "evidenceType": "File", + "filePath": "/test-byos/evidence1.png", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services" + } + }, + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "name": "evidence1", + "type": "Microsfot.AppComplianceAutomation/reports/evidences", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/evidences/evidence1", + "properties": { + "controlId": "Operational_Security_10", + "evidenceType": "File", + "extraData": "sampleData", + "filePath": "/acat-container/evidence1.png", + "provisioningState": "Succeeded", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "evidence1", + "type": "Microsfot.AppComplianceAutomation/reports/evidences", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/evidences/evidence1", + "properties": { + "controlId": "Operational_Security_10", + "evidenceType": "File", + "extraData": "sampleData", + "filePath": "/acat-container/evidence1.png", + "provisioningState": "Succeeded", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Evidence_CreateOrUpdate", + "title": "Evidence_CreateOrUpdate" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_Delete.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_Delete.json new file mode 100644 index 000000000000..890214acc94b --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "evidenceName": "evidence1", + "reportName": "testReportName" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Evidence_Delete", + "title": "Evidence_Delete" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_Download.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_Download.json new file mode 100644 index 000000000000..7827cea38d1f --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_Download.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "evidenceName": "evidence1", + "parameters": { + "offerGuid": "00000000-0000-0000-0000-000000000000", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000" + }, + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "evidenceFile": { + "url": "this is a url" + } + } + } + }, + "operationId": "Evidence_Download", + "title": "Evidence_Download" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_Get.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_Get.json new file mode 100644 index 000000000000..3ce86f20bad4 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "evidenceName": "evidence1", + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "name": "evidence1", + "type": "Microsfot.AppComplianceAutomation/reports/evidences", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/evidences/evidence1", + "properties": { + "controlId": "Operational_Security_10", + "evidenceType": "File", + "extraData": "sampleData", + "filePath": "/acat-container/evidence1.png", + "provisioningState": "Succeeded", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Evidence_Get", + "title": "Evidence_Get" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_ListByReport.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_ListByReport.json new file mode 100644 index 000000000000..b93a76ee8334 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Evidence_ListByReport.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "reportName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "evidence1", + "type": "Microsfot.AppComplianceAutomation/reports/evidences", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/evidences/evidence1", + "properties": { + "controlId": "Operational_Security_10", + "evidenceType": "File", + "extraData": "sampleData", + "filePath": "/acat-container/evidence1.png", + "provisioningState": "Succeeded", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + ] + } + } + }, + "operationId": "Evidence_ListByReport", + "title": "Evidence_ListByReport" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ListInUseStorageAccountsWithSubscriptions.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ListInUseStorageAccountsWithSubscriptions.json new file mode 100644 index 000000000000..e5596d869abe --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ListInUseStorageAccountsWithSubscriptions.json @@ -0,0 +1,33 @@ +{ + "operationId": "ProviderActions_ListInUseStorageAccounts", + "title": "ListInUseStorageAccountsWithSubscriptions", + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "subscriptionIds": [ + "0000000-0000-0000-0000-000000000001", + "0000000-0000-0000-0000-000000000002" + ] + } + }, + "responses": { + "200": { + "body": { + "storageAccountList": [ + { + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroup": "tetsRG", + "accountName": "SA_name1", + "location": "WEST US" + }, + { + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroup": "tetsRG", + "accountName": "SA_name2", + "location": "WEST US" + } + ] + } + } + } +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ListInUseStorageAccountsWithoutSubscriptions.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ListInUseStorageAccountsWithoutSubscriptions.json new file mode 100644 index 000000000000..7b9ccfcd9e83 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ListInUseStorageAccountsWithoutSubscriptions.json @@ -0,0 +1,28 @@ +{ + "operationId": "ProviderActions_ListInUseStorageAccounts", + "title": "ListInUseStorageAccountsWithoutSubscriptions", + "parameters": { + "api-version": "2024-06-27", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "storageAccountList": [ + { + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroup": "tetsRG", + "accountName": "SA_name1", + "location": "WEST US" + }, + { + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroup": "tetsRG", + "accountName": "SA_name2", + "location": "WEST US" + } + ] + } + } + } +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Onboard.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Onboard.json new file mode 100644 index 000000000000..3aaaff41bbd4 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Onboard.json @@ -0,0 +1,29 @@ +{ + "operationId": "ProviderActions_Onboard", + "title": "Onboard", + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "subscriptionIds": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001" + ] + } + }, + "responses": { + "200": { + "body": { + "subscriptionIds": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001" + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}", + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}" + } + } + } +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Operations_List.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Operations_List.json new file mode 100644 index 000000000000..289f672cdec0 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AppComplianceAutomation/reports/write", + "isDataAction": false, + "display": { + "provider": "Microsoft AppComplianceAutomation", + "resource": "Microsoft.AppComplianceAutomation/reports", + "operation": "Microsoft.AppComplianceAutomation/reports/write", + "description": "Create new reports." + } + } + ] + } + } + } +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_CheckNameAvailability.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_CheckNameAvailability.json new file mode 100644 index 000000000000..bcd762897e0a --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "operationId": "ProviderActions_CheckNameAvailability", + "title": "Report_CheckNameAvailability", + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "name": "reportABC", + "type": "Microsoft.AppComplianceAutomation/reports" + } + }, + "responses": { + "200": { + "body": { + "message": "An report named 'reportABC' is already in use.", + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + } +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_CreateOrUpdate.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_CreateOrUpdate.json new file mode 100644 index 000000000000..2efea20388ba --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_CreateOrUpdate.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "properties": { + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + } + ], + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-04T05:00:00.000Z" + } + }, + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "name": "testReportName", + "type": "Microsfot.AppComplianceAutomation/reports", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName", + "properties": { + "certRecords": [ + { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + ], + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "passedCount": 0 + } + }, + "lastTriggerTime": "2022-03-02T05:00:00.000Z", + "nextTriggerTime": "2022-03-02T05:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Active", + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-02T05:00:00.000Z" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "testReportName", + "type": "Microsfot.AppComplianceAutomation/reports", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName", + "properties": { + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "passedCount": 0 + } + }, + "lastTriggerTime": "2022-03-02T05:00:00.000Z", + "nextTriggerTime": "2022-03-02T05:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Active", + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-02T05:00:00.000Z" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Report_CreateOrUpdate", + "title": "Report_CreateOrUpdate" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Delete.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Delete.json new file mode 100644 index 000000000000..80a2ac5a5f87 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + }, + "204": {} + }, + "operationId": "Report_Delete", + "title": "Report_Delete" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Fix.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Fix.json new file mode 100644 index 000000000000..bcc813dce1b6 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Fix.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReport" + }, + "responses": { + "200": { + "body": { + "reason": "", + "result": "Succeeded" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Report_Fix", + "title": "Report_Fix" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Get.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Get.json new file mode 100644 index 000000000000..968fefe131b4 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Get.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReport" + }, + "responses": { + "200": { + "body": { + "name": "testReportName", + "type": "Microsfot.AppComplianceAutomation/reports", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName", + "properties": { + "certRecords": [ + { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + ], + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "passedCount": 0 + } + }, + "errors": [ + "resource-inaccessible" + ], + "lastTriggerTime": "2022-03-02T05:00:00.000Z", + "nextTriggerTime": "2022-03-02T05:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Failed", + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-02T05:00:00.000Z" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Report_Get", + "title": "Report_Get" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_GetCollectionCount.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_GetCollectionCount.json new file mode 100644 index 000000000000..5bc1b448f3d4 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_GetCollectionCount.json @@ -0,0 +1,18 @@ +{ + "operationId": "ProviderActions_GetCollectionCount", + "title": "Report_GetCollectionCount", + "parameters": { + "api-version": "2024-06-27", + "$filter": "Name eq 'Milk'", + "parameters": { + "type": "Microsoft.AppComplianceAutomation/reports" + } + }, + "responses": { + "200": { + "body": { + "count": 100 + } + } + } +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_GetOverviewStatus.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_GetOverviewStatus.json new file mode 100644 index 000000000000..1ddbfccb5cb5 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_GetOverviewStatus.json @@ -0,0 +1,30 @@ +{ + "operationId": "ProviderActions_GetOverviewStatus", + "title": "Report_GetOverviewStatus", + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "type": "Microsoft.AppComplianceAutomation/reports" + } + }, + "responses": { + "200": { + "body": { + "statusList": [ + { + "statusName": "Active", + "statusValue": "100" + }, + { + "statusName": "Failed", + "statusValue": "0" + }, + { + "statusName": "Disabled", + "statusValue": "0" + } + ] + } + } + } +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_GetScopingQuestions.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_GetScopingQuestions.json new file mode 100644 index 000000000000..08ef357ea5fd --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_GetScopingQuestions.json @@ -0,0 +1,100 @@ +{ + "operationId": "Report_GetScopingQuestions", + "title": "Report_GetScopingQuestions", + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "questions": [ + { + "questionId": "DHP_G07_customerDataProcess", + "inputType": "Boolean", + "optionIds": [], + "rules": [ + "Required" + ], + "showSubQuestionsValue": "true", + "superiorQuestionId": null + }, + { + "questionId": "DHP_G04_graphPermissionData", + "inputType": "Text", + "optionIds": [], + "rules": [ + "Required", + "CharLength" + ], + "showSubQuestionsValue": null, + "superiorQuestionId": "DHP_G07_customerDataProcess" + }, + { + "questionId": "DHP_G06_customerDataStorage", + "inputType": "Boolean", + "optionIds": [], + "rules": [ + "Required" + ], + "showSubQuestionsValue": "true", + "superiorQuestionId": null + }, + { + "questionId": "DHP_G05_graphPermissionInfo", + "inputType": "Text", + "optionIds": [], + "rules": [ + "Required", + "CharLength", + "PreventNonEnglishChar" + ], + "showSubQuestionsValue": null, + "superiorQuestionId": "DHP_G06_customerDataStorage" + }, + { + "questionId": "DHP_G08_storageLocation", + "inputType": "MultiSelectDropdown", + "optionIds": [ + "Croatia", + "Cuba", + "Curaçao", + "Cyprus", + "Czechia", + "Côte d'Ivoire", + "Denmark", + "Djibouti", + "Dominica", + "Dominican Republic (the)", + "Ecuador", + "Egypt" + ], + "rules": [ + "Required" + ], + "showSubQuestionsValue": null, + "superiorQuestionId": "DHP_G06_customerDataStorage" + }, + { + "questionId": "LEG03_complianceDataTermination", + "superiorQuestionId": "DHP_G06_customerDataStorage", + "inputType": "SingleSelectEnum", + "optionIds": [], + "rules": [ + "Required" + ], + "showSubQuestionsValue": null + } + ] + }, + "systemData": { + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "createdAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z" + } + } + } +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_List.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_List.json new file mode 100644 index 000000000000..0821ff0492b8 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_List.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "$skipToken": "1", + "$top": "100", + "api-version": "2024-06-27", + "offerGuid": "00000000-0000-0000-0000-000000000000", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports?api-version=2024-06-27&skipToken=1&top=100", + "value": [ + { + "name": "testReportName", + "type": "Microsfot.AppComplianceAutomation/reports", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName", + "properties": { + "certRecords": [ + { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + ], + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "notApplicableCount": 0, + "passedCount": 0, + "pendingCount": 0 + } + }, + "errors": [], + "lastTriggerTime": "2022-03-02T05:00:00.000Z", + "nextTriggerTime": "2022-03-02T05:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Active", + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-02T05:00:00.000Z" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + ] + } + } + }, + "operationId": "Report_List", + "title": "Report_List" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_NestedResourceCheckNameAvailability_Report_Evidence_Check_Name_Availability.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_NestedResourceCheckNameAvailability_Report_Evidence_Check_Name_Availability.json new file mode 100644 index 000000000000..b15d2c857cb6 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_NestedResourceCheckNameAvailability_Report_Evidence_Check_Name_Availability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "name": "evidenceABC", + "type": "Microsoft.AppComplianceAutomation/reports/evidences" + }, + "reportName": "reportABC" + }, + "responses": { + "200": { + "body": { + "message": "An evidence named 'evidenceABC' is already in use.", + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + }, + "operationId": "Report_NestedResourceCheckNameAvailability", + "title": "Report_EvidenceCheckNameAvailability" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_NestedResourceCheckNameAvailability_Report_Snapshot_Check_Name_Availability.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_NestedResourceCheckNameAvailability_Report_Snapshot_Check_Name_Availability.json new file mode 100644 index 000000000000..4064467ccddc --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_NestedResourceCheckNameAvailability_Report_Snapshot_Check_Name_Availability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "name": "snapshotABC", + "type": "Microsoft.AppComplianceAutomation/reports/snapshots" + }, + "reportName": "reportABC" + }, + "responses": { + "200": { + "body": { + "message": "An snapshot named 'snapshotABC' is already in use.", + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + }, + "operationId": "Report_NestedResourceCheckNameAvailability", + "title": "Report_SnapshotCheckNameAvailability" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_NestedResourceCheckNameAvailability_Report_Webhook_Check_Name_Availability.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_NestedResourceCheckNameAvailability_Report_Webhook_Check_Name_Availability.json new file mode 100644 index 000000000000..388d47f9a2c2 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_NestedResourceCheckNameAvailability_Report_Webhook_Check_Name_Availability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "name": "webhookABC", + "type": "Microsoft.AppComplianceAutomation/reports/webhooks" + }, + "reportName": "reportABC" + }, + "responses": { + "200": { + "body": { + "message": "An webhook named 'webhookABC' is already in use.", + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + }, + "operationId": "Report_NestedResourceCheckNameAvailability", + "title": "Report_WebhookCheckNameAvailability" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_SyncCertRecord.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_SyncCertRecord.json new file mode 100644 index 000000000000..00f3a43324da --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_SyncCertRecord.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "certRecord": { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + }, + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "certRecord": { + "offerGuid": "addb13fc-64bf-4005-b693-4c2f094e2187", + "certificationStatus": "CertIngestion", + "ingestionStatus": "InitialDocumentResubmitted", + "controls": [] + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Report_SyncCertRecord", + "title": "Report_SyncCertRecord" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Update.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Update.json new file mode 100644 index 000000000000..fba98d1d3712 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Update.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "properties": { + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-04T05:00:00.000Z" + } + }, + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "name": "testReportName", + "type": "Microsfot.AppComplianceAutomation/reports", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName", + "properties": { + "certRecords": [ + { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + ], + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "passedCount": 0 + } + }, + "lastTriggerTime": "2022-03-02T05:00:00.000Z", + "nextTriggerTime": "2022-03-02T05:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Active", + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-02T05:00:00.000Z" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Report_Update", + "title": "Report_Update" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Verify.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Verify.json new file mode 100644 index 000000000000..e41d7293a90b --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Report_Verify.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReport" + }, + "responses": { + "200": { + "body": { + "reason": "", + "result": "Succeeded" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Report_Verify", + "title": "Report_Verify" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_CreateOrUpdate.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_CreateOrUpdate.json new file mode 100644 index 000000000000..ac5ce8c3467a --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_CreateOrUpdate.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName", + "scopingConfigurationName": "default", + "parameters": { + "properties": { + "answers": [ + { + "answers": [ + "Azure" + ], + "questionId": "GEN20_hostingEnvironment" + }, + { + "answers": [], + "questionId": "DHP_G07_customerDataProcess" + }, + { + "answers": [], + "questionId": "Tier2InitSub_serviceCommunicate" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AppComplianceAutomation/reports/scopingConfigurations", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/scopingConfigurations/default", + "properties": { + "answers": [ + { + "answers": [ + "Azure" + ], + "questionId": "GEN20_hostingEnvironment" + }, + { + "answers": [], + "questionId": "DHP_G07_customerDataProcess" + }, + { + "answers": [], + "questionId": "Tier2InitSub_serviceCommunicate" + } + ] + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.AppComplianceAutomation/reports/scopingConfigurations", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/scopingConfigurations/default", + "properties": { + "answers": [ + { + "answers": [ + "Azure" + ], + "questionId": "GEN20_hostingEnvironment" + }, + { + "answers": [], + "questionId": "DHP_G07_customerDataProcess" + }, + { + "answers": [], + "questionId": "Tier2InitSub_serviceCommunicate" + } + ] + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "ScopingConfiguration_CreateOrUpdate", + "title": "ScopingConfiguration_CreateOrUpdate" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_Delete.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_Delete.json new file mode 100644 index 000000000000..f5a132637ae2 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName", + "scopingConfigurationName": "default" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ScopingConfiguration_Delete", + "title": "ScopingConfiguration_Delete" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_Get.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_Get.json new file mode 100644 index 000000000000..5ec5a51c5190 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName", + "scopingConfigurationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AppComplianceAutomation/reports/scopingConfigurations", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/scopingConfigurations/default", + "properties": { + "answers": [ + { + "answers": [ + "Azure" + ], + "questionId": "GEN20_hostingEnvironment" + }, + { + "answers": [], + "questionId": "DHP_G07_customerDataProcess" + }, + { + "answers": [], + "questionId": "Tier2InitSub_serviceCommunicate" + } + ] + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "ScopingConfiguration_Get", + "title": "ScopingConfiguration" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_List.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_List.json new file mode 100644 index 000000000000..d29f4275ceb8 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/ScopingConfiguration_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AppComplianceAutomation/reports/scopingConfigurations", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/scopingConfigurations/default", + "properties": { + "answers": [ + { + "answers": [ + "Azure" + ], + "questionId": "GEN20_hostingEnvironment" + }, + { + "answers": [], + "questionId": "DHP_G07_customerDataProcess" + }, + { + "answers": [], + "questionId": "Tier2InitSub_serviceCommunicate" + } + ] + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + ] + } + } + }, + "operationId": "ScopingConfiguration_List", + "title": "ScopingConfiguration_List" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Compliance_Detailed_Pdf_Report.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Compliance_Detailed_Pdf_Report.json new file mode 100644 index 000000000000..d84be3fd0ea1 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Compliance_Detailed_Pdf_Report.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "downloadType": "ComplianceDetailedPdfReport", + "offerGuid": "00000000-0000-0000-0000-000000000000", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000" + }, + "reportName": "testReportName", + "snapshotName": "testSnapshotName" + }, + "responses": { + "200": { + "body": { + "complianceDetailedPdfReport": { + "sasUri": "this is a uri" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Snapshot_Download", + "title": "Snapshot_Download_ComplianceDetailedPdfReport" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Compliance_Pdf_Report.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Compliance_Pdf_Report.json new file mode 100644 index 000000000000..fab4b64e88d1 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Compliance_Pdf_Report.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "downloadType": "CompliancePdfReport", + "offerGuid": "00000000-0000-0000-0000-000000000001", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000" + }, + "reportName": "testReportName", + "snapshotName": "testSnapshotName" + }, + "responses": { + "200": { + "body": { + "compliancePdfReport": { + "sasUri": "this is uri of report" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Snapshot_Download", + "title": "Snapshot_Download_CompliancePdfReport" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Compliance_Report.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Compliance_Report.json new file mode 100644 index 000000000000..e7e5d3d67aed --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Compliance_Report.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "downloadType": "ComplianceReport", + "offerGuid": "00000000-0000-0000-0000-000000000001", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000" + }, + "reportName": "testReportName", + "snapshotName": "testSnapshotName" + }, + "responses": { + "200": { + "body": { + "complianceReport": [ + { + "categoryName": "Data Security & Privacy", + "controlFamilyName": "Incident Response", + "controlId": "Operational_Security_75", + "controlName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlStatus": "Passed", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceStatus": "Healthy", + "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z", + "resourceType": "Microsoft.SignalRService/SignalR", + "responsibilityDescription": "Restrict access to the Kubernetes Service Management API by granting API access only to IP addresses in specific ranges. It is recommended to limit access to authorized IP ranges to ensure that only applications from allowed networks can access the cluster.", + "responsibilityTitle": "Authorized IP ranges should be defined on Kubernetes Services" + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Snapshot_Download", + "title": "Snapshot_Download_ComplianceReport" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Resource_List.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Resource_List.json new file mode 100644 index 000000000000..603716a5154a --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Download_Snapshot_Download_Resource_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "downloadType": "ResourceList", + "offerGuid": "00000000-0000-0000-0000-000000000001", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000" + }, + "reportName": "testReportName", + "snapshotName": "testSnapshotName" + }, + "responses": { + "200": { + "body": { + "resourceList": [ + { + "resourceGroup": "myResourceGroup", + "resourceId": "mySignalRService", + "resourceType": "SignalR", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + }, + "operationId": "Snapshot_Download", + "title": "Snapshot_Download_ResourceList" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Get.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Get.json new file mode 100644 index 000000000000..9637ea243640 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_Get.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName", + "snapshotName": "testSnapshot" + }, + "responses": { + "200": { + "body": { + "name": "testSnapshot", + "type": "Microsfot.AppComplianceAutomation/reports/snapshots", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/snapshots/testSnapshot", + "properties": { + "complianceResults": [ + { + "categories": [ + { + "categoryName": "Operational Security", + "categoryStatus": "Passed", + "controlFamilies": [ + { + "controlFamilyName": "Incident Response", + "controlFamilyStatus": "Passed", + "controls": [ + { + "controlDescription": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlDescriptionHyperLink": "https://aka.ms/acat/m365cert/operational/control73", + "controlFullName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlId": "Operational_Security_75", + "controlName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlStatus": "Passed", + "responsibilities": [ + { + "evidenceFiles": [ + "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/reportABC/fileName?api-version=2024-06-27" + ], + "failedResourceCount": 0, + "guidance": "Please upload the screen capture file to ACAT service.", + "justification": "Here is my evidence files", + "recommendationList": [ + { + "recommendationId": "failed_reason_1", + "recommendationShortName": "Invalid TLS Config", + "recommendationSolutions": [ + { + "isRecommendSolution": "true", + "recommendationSolutionContent": "Setting minimal TLS version to 1.2 improves security by ensuring your SQL Managed Instance can only be accessed from clients using TLS 1.2. Using versions of TLS less than 1.2 is not recommended since they have well documented security vulnerabilities", + "recommendationSolutionIndex": "1" + } + ] + }, + { + "recommendationId": "failed_reason_2", + "recommendationShortName": "Invalid AWS TLS Config", + "recommendationSolutions": [ + { + "isRecommendSolution": "true", + "recommendationSolutionContent": "Open the AWS related service, and set its TLS version to 1.2 or higher version.", + "recommendationSolutionIndex": "1" + } + ] + } + ], + "resourceList": [ + { + "recommendationIds": [ + "failed_reason_1" + ], + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceStatus": "Unhealthy", + "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "recommendationIds": [ + "failed_reason_2" + ], + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceStatus": "Unhealthy", + "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z", + "resourceType": "iam.user" + } + ], + "responsibilityDescription": "Restrict access to the Kubernetes Service Management API by granting API access only to IP addresses in specific ranges. It is recommended to limit access to authorized IP ranges to ensure that only applications from allowed networks can access the cluster.", + "responsibilityEnvironment": "Azure", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services", + "responsibilitySeverity": "High", + "responsibilityStatus": "Passed", + "responsibilityTitle": "Authorized IP ranges should be defined on Kubernetes Services", + "responsibilityType": "Automated", + "totalResourceCount": 1 + } + ] + } + ] + } + ] + } + ], + "complianceName": "M365" + } + ], + "createdAt": "2022-03-04T15:33:59.160Z", + "provisioningState": "Succeeded", + "reportProperties": { + "certRecords": [ + { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + ], + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "passedCount": 0 + } + }, + "errors": [], + "lastTriggerTime": "2022-03-04T15:00:00.000Z", + "nextTriggerTime": "2022-03-04T15:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Active", + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-04T15:00:00.000Z" + }, + "reportSystemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + }, + "snapshotName": "testSnapshot" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Snapshot_Get", + "title": "Snapshot_Get" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_List.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_List.json new file mode 100644 index 000000000000..592c4f1160b5 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Snapshot_List.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "$skipToken": "1", + "$top": "100", + "api-version": "2024-06-27", + "offerGuid": "00000000-0000-0000-0000-000000000001", + "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000", + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReportName/snapshots?api-version=2024-06-27&skipToken=1&top=100", + "value": [ + { + "name": "testSnapshot", + "type": "Microsfot.AppComplianceAutomation/reports/snapshots", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/snapshots/testSnapshot", + "properties": { + "complianceResults": [ + { + "categories": [ + { + "categoryName": "Operational Security", + "categoryStatus": "Passed", + "controlFamilies": [ + { + "controlFamilyName": "Incident Response", + "controlFamilyStatus": "Passed", + "controls": [ + { + "controlDescription": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlDescriptionHyperLink": "https://aka.ms/acat/m365cert/operational/control73", + "controlFullName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlId": "Operational_Security_75", + "controlName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise", + "controlStatus": "Passed", + "responsibilities": [ + { + "evidenceFiles": [ + "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/reportABC/fileName?api-version=2024-06-27" + ], + "failedResourceCount": 0, + "guidance": "Please upload the screen capture file to ACAT service.", + "justification": "Here is my evidence files", + "recommendationList": [ + { + "recommendationId": "failed_reason_1", + "recommendationShortName": "Invalid TLS Config", + "recommendationSolutions": [ + { + "isRecommendSolution": "true", + "recommendationSolutionContent": "Setting minimal TLS version to 1.2 improves security by ensuring your SQL Managed Instance can only be accessed from clients using TLS 1.2. Using versions of TLS less than 1.2 is not recommended since they have well documented security vulnerabilities", + "recommendationSolutionIndex": "1" + } + ] + }, + { + "recommendationId": "failed_reason_2", + "recommendationShortName": "Invalid AWS TLS Config", + "recommendationSolutions": [ + { + "isRecommendSolution": "true", + "recommendationSolutionContent": "Open the AWS related service, and set its TLS version to 1.2 or higher version.", + "recommendationSolutionIndex": "1" + } + ] + } + ], + "resourceList": [ + { + "recommendationIds": [ + "failed_reason_1" + ], + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceStatus": "Unhealthy", + "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "recommendationIds": [ + "failed_reason_2" + ], + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceStatus": "Unhealthy", + "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z", + "resourceType": "iam.user" + } + ], + "responsibilityDescription": "Restrict access to the Kubernetes Service Management API by granting API access only to IP addresses in specific ranges. It is recommended to limit access to authorized IP ranges to ensure that only applications from allowed networks can access the cluster.", + "responsibilityEnvironment": "Azure", + "responsibilityId": "authorized_ip_ranges_should_be_defined_on_kubernetes_services", + "responsibilitySeverity": "High", + "responsibilityStatus": "Passed", + "responsibilityTitle": "Authorized IP ranges should be defined on Kubernetes Services", + "responsibilityType": "Automated", + "totalResourceCount": 1 + } + ] + } + ] + } + ] + } + ], + "complianceName": "M365" + } + ], + "createdAt": "2022-03-04T15:33:59.160Z", + "provisioningState": "Succeeded", + "reportProperties": { + "certRecords": [ + { + "certificationStatus": "CertIngestion", + "controls": [ + { + "controlId": "Operational_Security_10", + "controlStatus": "Approved" + } + ], + "ingestionStatus": "EvidenceResubmitted", + "offerGuid": "00000000-0000-0000-0000-000000000001" + } + ], + "complianceStatus": { + "m365": { + "failedCount": 0, + "manualCount": 0, + "notApplicableCount": 0, + "passedCount": 0, + "pendingCount": 0 + } + }, + "errors": [], + "lastTriggerTime": "2022-03-04T15:00:00.000Z", + "nextTriggerTime": "2022-03-04T15:00:00.000Z", + "offerGuid": "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002", + "provisioningState": "Succeeded", + "resources": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "resourceOrigin": "Azure", + "resourceType": "Microsoft.SignalRService/SignalR" + }, + { + "accountId": "000000000000", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/acat-aws/providers/microsoft.security/securityconnectors/acatawsconnector/securityentitydata/aws-iam-user-testuser", + "resourceOrigin": "AWS", + "resourceType": "iam.user" + } + ], + "status": "Active", + "storageInfo": { + "accountName": "testStorageAccount", + "location": "East US", + "resourceGroup": "testResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "subscriptions": [ + "00000000-0000-0000-0000-000000000000" + ], + "tenantId": "00000000-0000-0000-0000-000000000000", + "timeZone": "GMT Standard Time", + "triggerTime": "2022-03-04T15:00:00.000Z" + }, + "reportSystemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + }, + "snapshotName": "testSnapshot" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + ] + } + } + }, + "operationId": "Snapshot_List", + "title": "Snapshot_List" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/TriggerEvaluation.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/TriggerEvaluation.json new file mode 100644 index 000000000000..e9fd6273c264 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/TriggerEvaluation.json @@ -0,0 +1,51 @@ +{ + "operationId": "ProviderActions_TriggerEvaluation", + "title": "TriggerEvaluation", + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "resourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService" + ] + } + }, + "responses": { + "200": { + "body": { + "properties": { + "evaluationEndTime": "2022-03-04T05:10:00.000Z", + "quickAssessments": [ + { + "description": "Protect your storage accounts from potential threats using virtual network rules as a preferred method instead of IP-based filtering. Disabling IP-based filtering prevents public IPs from accessing your storage accounts.", + "displayName": "Storage accounts should restrict network access using virtual network rules", + "remediationLink": "Protect your storage accounts from potential threats using virtual network rules as a preferred method instead of IP-based filtering. Disabling IP-based filtering prevents public IPs from accessing your storage accounts.", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storettas3iw2megtcarm", + "resourceStatus": "Healthy", + "responsibilityId": "/providers/microsoft.authorization/policydefinitions/2a1a9cdf-e04d-429a-8416-3bfb72a1b26f", + "timestamp": "2022-03-04T05:00:00.000Z" + }, + { + "description": "", + "displayName": "Secure transfer to storage accounts should be enabled", + "remediationLink": "", + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storettas3iw2megtcarm", + "resourceStatus": "Unhealthy", + "responsibilityId": "/providers/Microsoft.Authorization/policyDefinitions/404c3081-a854-4457-ae30-26a93ef643f9", + "timestamp": "2022-03-04T05:00:00.000Z" + } + ], + "resourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storettas3iw2megtcarm" + ], + "triggerTime": "2022-03-04T05:00:00.000Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}", + "Location": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}" + } + } + } +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_CreateOrUpdate.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_CreateOrUpdate.json new file mode 100644 index 000000000000..02279408de64 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "properties": { + "contentType": "application/json", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "sendAllEvents": "false", + "status": "Enabled", + "updateWebhookKey": "true", + "webhookKey": "00000000-0000-0000-0000-000000000000" + } + }, + "reportName": "testReportName", + "webhookName": "testWebhookName" + }, + "responses": { + "200": { + "body": { + "name": "testWebhookName", + "type": "Microsfot.AppComplianceAutomation/reports/webhooks", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/webhooks/testWebhookName", + "properties": { + "contentType": "application/json", + "deliveryStatus": "Succeeded", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "provisioningState": "Succeeded", + "sendAllEvents": "false", + "status": "Enabled", + "tenantId": "00000000-0000-0000-0000-000000000000", + "webhookId": "00000000-0000-0000-0000-000000000000", + "webhookKeyEnabled": "true" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "testWebhookName", + "type": "Microsfot.AppComplianceAutomation/reports/webhooks", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/webhooks/testWebhookName", + "properties": { + "contentType": "application/json", + "deliveryStatus": "Succeeded", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "provisioningState": "Succeeded", + "sendAllEvents": "false", + "status": "Enabled", + "tenantId": "00000000-0000-0000-0000-000000000000", + "webhookId": "00000000-0000-0000-0000-000000000000", + "webhookKeyEnabled": "true" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Webhook_CreateOrUpdate", + "title": "Webhook_CreateOrUpdate" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_Delete.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_Delete.json new file mode 100644 index 000000000000..681e90bfaf99 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName", + "webhookName": "testWebhookName" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Webhook_Delete", + "title": "Webhook_Delete" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_Get.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_Get.json new file mode 100644 index 000000000000..8433044df3b6 --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "reportName": "testReportName", + "webhookName": "testWebhookName" + }, + "responses": { + "200": { + "body": { + "name": "testWebhookName", + "type": "Microsfot.AppComplianceAutomation/reports/webhooks", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/webhooks/testWebhookName", + "properties": { + "contentType": "application/json", + "deliveryStatus": "Succeeded", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "provisioningState": "Succeeded", + "sendAllEvents": "false", + "status": "Enabled", + "tenantId": "00000000-0000-0000-0000-000000000000", + "webhookId": "00000000-0000-0000-0000-000000000000", + "webhookKeyEnabled": "true" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Webhook_Get", + "title": "Webhook_Get" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_List.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_List.json new file mode 100644 index 000000000000..5218b564374a --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "$skipToken": "1", + "$top": "100", + "api-version": "2024-06-27", + "reportName": "testReportName" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReportName/webhooks?api-version=2024-06-27&skipToken=1&top=100", + "value": [ + { + "name": "testWebhookName", + "type": "Microsfot.AppComplianceAutomation/reports/webhooks", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/snapshots/testWebhookName", + "properties": { + "contentType": "application/json", + "deliveryStatus": "Succeeded", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "provisioningState": "Succeeded", + "sendAllEvents": "false", + "status": "Enabled", + "tenantId": "00000000-0000-0000-0000-000000000000", + "webhookId": "00000000-0000-0000-0000-000000000000", + "webhookKeyEnabled": "false" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + ] + } + } + }, + "operationId": "Webhook_List", + "title": "Webhook_List" +} diff --git a/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_Update.json b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_Update.json new file mode 100644 index 000000000000..d30eb32aadbe --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/stable/2024-06-27/examples/Webhook_Update.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-06-27", + "parameters": { + "properties": { + "contentType": "application/json", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "sendAllEvents": "false", + "status": "Enabled", + "updateWebhookKey": "true", + "webhookKey": "00000000-0000-0000-0000-000000000000" + } + }, + "reportName": "testReportName", + "webhookName": "testWebhookName" + }, + "responses": { + "200": { + "body": { + "name": "testWebhookName", + "type": "Microsfot.AppComplianceAutomation/reports/webhooks", + "id": "/provider/Microsfot.AppComplianceAutomation/reports/testReportName/testWebhookName", + "properties": { + "contentType": "application/json", + "deliveryStatus": "Succeeded", + "enableSslVerification": "true", + "events": [ + "generate_snapshot_failed" + ], + "payloadUrl": "https://example.com", + "provisioningState": "Succeeded", + "sendAllEvents": "false", + "status": "Enabled", + "tenantId": "00000000-0000-0000-0000-000000000000", + "webhookId": "00000000-0000-0000-0000-000000000000", + "webhookKeyEnabled": "true" + }, + "systemData": { + "createdAt": "2021-05-14T22:34:55.4499903Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "createdByType": "User", + "lastModifiedAt": "2021-05-14T22:34:55.4499903Z", + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "Webhook_Update", + "title": "Webhook_Update" +} diff --git a/specification/appcomplianceautomation/resource-manager/readme.md b/specification/appcomplianceautomation/resource-manager/readme.md index ba57e4c7a43b..c157270c0b4a 100644 --- a/specification/appcomplianceautomation/resource-manager/readme.md +++ b/specification/appcomplianceautomation/resource-manager/readme.md @@ -27,15 +27,23 @@ These are the global settings for the appcomplianceautomation. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2022-11-16-preview +tag: package-2024-06 ``` +### Tag: package-2024-06 + +These settings apply only when `--tag=package-2024-06` is specified on the command line. + +```yaml $(tag) == 'package-2024-06' +input-file: + - Microsoft.AppComplianceAutomation/stable/2024-06-27/appcomplianceautomation.json +``` ### Tag: package-2022-11-16-preview These settings apply only when `--tag=package-2022-11-16-preview` is specified on the command line. -```yaml $(tag) == 'package-2022-11-16-preview' +``` yaml $(tag) == 'package-2022-11-16-preview' input-file: - Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/appcomplianceautomation.json ``` @@ -55,6 +63,7 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js + - repo: azure-sdk-for-net-track2 - repo: azure-resource-manager-schemas - repo: azure-cli-extensions ``` diff --git a/specification/appcomplianceautomation/resource-manager/sdk-suppressions.yaml b/specification/appcomplianceautomation/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..d8de1c66f0bf --- /dev/null +++ b/specification/appcomplianceautomation/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,35 @@ +suppressions: + azure-sdk-for-go: + - package: sdk/resourcemanager/appcomplianceautomation/armappcomplianceautomation + breaking-changes: + - Enum `AssessmentSeverity` has been removed + - Enum `CategoryType` has been removed + - Enum `ComplianceState` has been removed + - Enum `ControlFamilyType` has been removed + - Enum `ControlType` has been removed + - Enum `IsPass` has been removed + - Field `Assessments`, `ControlShortName`, `ControlType` of struct `Control` has been removed + - Field `CategoryType` of struct `Category` has been removed + - Field `ComplianceState`, `ControlType`, `PolicyDescription`, `PolicyDisplayName`, `PolicyID`, `ResourceGroup`, `StatusChangeDate`, `SubscriptionID` of struct `ComplianceReportItem` has been removed + - Field `FamilyName`, `FamilyStatus`, `FamilyType` of struct `ControlFamily` has been removed + - Field `ID` of struct `SnapshotProperties` has been removed + - Field `ID`, `ReportName` of struct `ReportProperties` has been removed + - Field `ReportResourceList` of struct `ReportsClientListResponse` has been removed + - Field `ResourceName`, `Tags` of struct `ResourceMetadata` has been removed + - Field `SnapshotResourceList` of struct `SnapshotsClientListResponse` has been removed + - Function `*ClientFactory.NewSnapshotClient` has been removed + - Function `*ReportClient.BeginCreateOrUpdate` has been removed + - Function `*ReportClient.BeginDelete` has been removed + - Function `*ReportClient.BeginUpdate` has been removed + - Function `*ReportClient.Get` has been removed + - Function `*SnapshotClient.BeginDownload` has been removed + - Function `*SnapshotClient.Get` has been removed + - Function `NewSnapshotClient` has been removed + - Struct `AssessmentResource` has been removed + - Struct `Assessment` has been removed + - Struct `ReportResourceList` has been removed + - Struct `SnapshotResourceList` has been removed + - Type of `ReportResourcePatch.Properties` has been changed from `*ReportProperties` to `*ReportPatchProperties` + - "`CategoryStatusHealthy`, `CategoryStatusUnhealthy` from enum `CategoryStatus` has been removed" + - "`ControlFamilyStatusHealthy`, `ControlFamilyStatusUnhealthy` from enum `ControlFamilyStatus` has been removed" + - "`ResourceStatusNotApplicable` from enum `ResourceStatus` has been removed" \ No newline at end of file From 0031475e8ae9bc16936bd8d88a2cf1981bf4c510 Mon Sep 17 00:00:00 2001 From: Chenjie Shi Date: Tue, 4 Jun 2024 09:32:44 +0800 Subject: [PATCH 24/49] Microsoft.ScVmm TypeSpec onboarding (#26644) * Init tsp for Microsoft.ScVmm * Some changes towards passing tsv * Updates to fix lint errors, remove unused types, regenerate examples, etc. * Created shareable 'force' param * Figured out the incantation to rename a file case-sensitively * Restored string bool enums. * Removed all examples * Regenerate examples * Updated ARM ID properties. Added script to sort output to compare with sorted old swagger * Additional changes. * Removed unused XXUpdate models, Added @secret for password, * Fixed #8, #6, #5 * Fixed #2 * Update swagger to be in sync with previous fixes. * Workaround for CloudCapacity readonly * Additional fixes. * fix ModelValidation * update void * VM Instance Update Properties changes * spell check and prettier validation fix * fix for identifier bug * workaround for https://github.com/Azure/typespec-azure/issues/449 * format * spell and prettier check improvements * use encodedName replace projectdName * Add summary annotations * summary * update kind and void * lro azure-async-operation * fix * tsp compilation warning * TypeSpec Validation fix * Update tspconfig.yaml * config change * Removed Read Only Property from Examples to fix Swagger ModelValidation * Revert Boolean to Enum with type Union in TypeSpec * specs-pr repo PR review changes to specs repo * Remove sorted json file used for comparison * Fix TypeSpec PR pipeline failure * make extendedLocation for VM Instance read and create * typespec validation fix --------- Co-authored-by: Will Temple Co-authored-by: Allen Zhang Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: Harshit Surana --- .../ScVmm.Management/AvailabilitySet.tsp | 67 + .../scvmm/ScVmm.Management/BackCompat.tsp | 3 + .../scvmm/ScVmm.Management/Cloud.tsp | 66 + .../scvmm/ScVmm.Management/GuestAgent.tsp | 41 + .../scvmm/ScVmm.Management/InventoryItem.tsp | 41 + .../VirtualMachineInstance.tsp | 132 + .../VirtualMachineTemplate.tsp | 67 + .../scvmm/ScVmm.Management/VirtualNetwork.tsp | 66 + .../VmInstanceHybridIdentityMetadata.tsp | 37 + .../scvmm/ScVmm.Management/VmmServer.tsp | 66 + ...itySets_CreateOrUpdate_MaximumSet_Gen.json | 85 + ...itySets_CreateOrUpdate_MinimumSet_Gen.json | 33 + ...vailabilitySets_Delete_MaximumSet_Gen.json | 19 + ...vailabilitySets_Delete_MinimumSet_Gen.json | 18 + .../AvailabilitySets_Get_MaximumSet_Gen.json | 40 + .../AvailabilitySets_Get_MinimumSet_Gen.json | 19 + ...ts_ListByResourceGroup_MaximumSet_Gen.json | 44 + ...ts_ListByResourceGroup_MinimumSet_Gen.json | 22 + ...ets_ListBySubscription_MaximumSet_Gen.json | 43 + ...ets_ListBySubscription_MinimumSet_Gen.json | 21 + ...vailabilitySets_Update_MaximumSet_Gen.json | 50 + ...vailabilitySets_Update_MinimumSet_Gen.json | 24 + .../Clouds_CreateOrUpdate_MaximumSet_Gen.json | 121 + .../Clouds_CreateOrUpdate_MinimumSet_Gen.json | 33 + .../Clouds_Delete_MaximumSet_Gen.json | 19 + .../Clouds_Delete_MinimumSet_Gen.json | 18 + .../2023-10-07/Clouds_Get_MaximumSet_Gen.json | 57 + .../2023-10-07/Clouds_Get_MinimumSet_Gen.json | 19 + ...ds_ListByResourceGroup_MaximumSet_Gen.json | 61 + ...ds_ListByResourceGroup_MinimumSet_Gen.json | 22 + ...uds_ListBySubscription_MaximumSet_Gen.json | 60 + ...uds_ListBySubscription_MinimumSet_Gen.json | 21 + .../Clouds_Update_MaximumSet_Gen.json | 67 + .../Clouds_Update_MinimumSet_Gen.json | 24 + .../GuestAgents_Create_MaximumSet_Gen.json | 81 + .../GuestAgents_Create_MinimumSet_Gen.json | 20 + .../GuestAgents_Delete_MaximumSet_Gen.json | 12 + .../GuestAgents_Delete_MinimumSet_Gen.json | 12 + .../GuestAgents_Get_MaximumSet_Gen.json | 38 + .../GuestAgents_Get_MinimumSet_Gen.json | 13 + ...VirtualMachineInstance_MaximumSet_Gen.json | 43 + ...VirtualMachineInstance_MinimumSet_Gen.json | 19 + .../InventoryItems_Create_MaximumSet_Gen.json | 65 + .../InventoryItems_Create_MinimumSet_Gen.json | 20 + .../InventoryItems_Delete_MaximumSet_Gen.json | 15 + .../InventoryItems_Delete_MinimumSet_Gen.json | 15 + .../InventoryItems_Get_MaximumSet_Gen.json | 36 + .../InventoryItems_Get_MinimumSet_Gen.json | 16 + ...yItems_ListByVmmServer_MaximumSet_Gen.json | 40 + ...yItems_ListByVmmServer_MinimumSet_Gen.json | 21 + .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + ...ances_CreateCheckpoint_MaximumSet_Gen.json | 19 + ...ances_CreateCheckpoint_MinimumSet_Gen.json | 16 + ...stances_CreateOrUpdate_MaximumSet_Gen.json | 316 + ...stances_CreateOrUpdate_MinimumSet_Gen.json | 28 + ...ances_DeleteCheckpoint_MaximumSet_Gen.json | 18 + ...ances_DeleteCheckpoint_MinimumSet_Gen.json | 16 + ...achineInstances_Delete_MaximumSet_Gen.json | 18 + ...achineInstances_Delete_MinimumSet_Gen.json | 16 + ...alMachineInstances_Get_MaximumSet_Gen.json | 123 + ...alMachineInstances_Get_MinimumSet_Gen.json | 16 + ...lMachineInstances_List_MaximumSet_Gen.json | 128 + ...lMachineInstances_List_MinimumSet_Gen.json | 20 + ...chineInstances_Restart_MaximumSet_Gen.json | 16 + ...chineInstances_Restart_MinimumSet_Gen.json | 16 + ...nces_RestoreCheckpoint_MaximumSet_Gen.json | 18 + ...nces_RestoreCheckpoint_MinimumSet_Gen.json | 16 + ...MachineInstances_Start_MaximumSet_Gen.json | 16 + ...MachineInstances_Start_MinimumSet_Gen.json | 16 + ...lMachineInstances_Stop_MaximumSet_Gen.json | 18 + ...lMachineInstances_Stop_MinimumSet_Gen.json | 16 + ...achineInstances_Update_MaximumSet_Gen.json | 179 + ...achineInstances_Update_MinimumSet_Gen.json | 21 + ...mplates_CreateOrUpdate_MaximumSet_Gen.json | 197 + ...mplates_CreateOrUpdate_MinimumSet_Gen.json | 33 + ...achineTemplates_Delete_MaximumSet_Gen.json | 19 + ...achineTemplates_Delete_MinimumSet_Gen.json | 18 + ...alMachineTemplates_Get_MaximumSet_Gen.json | 93 + ...alMachineTemplates_Get_MinimumSet_Gen.json | 19 + ...es_ListByResourceGroup_MaximumSet_Gen.json | 97 + ...es_ListByResourceGroup_MinimumSet_Gen.json | 22 + ...tes_ListBySubscription_MaximumSet_Gen.json | 96 + ...tes_ListBySubscription_MinimumSet_Gen.json | 21 + ...achineTemplates_Update_MaximumSet_Gen.json | 103 + ...achineTemplates_Update_MinimumSet_Gen.json | 24 + ...etworks_CreateOrUpdate_MaximumSet_Gen.json | 90 + ...etworks_CreateOrUpdate_MinimumSet_Gen.json | 33 + ...VirtualNetworks_Delete_MaximumSet_Gen.json | 19 + ...VirtualNetworks_Delete_MinimumSet_Gen.json | 18 + .../VirtualNetworks_Get_MaximumSet_Gen.json | 42 + .../VirtualNetworks_Get_MinimumSet_Gen.json | 19 + ...ks_ListByResourceGroup_MaximumSet_Gen.json | 46 + ...ks_ListByResourceGroup_MinimumSet_Gen.json | 22 + ...rks_ListBySubscription_MaximumSet_Gen.json | 45 + ...rks_ListBySubscription_MinimumSet_Gen.json | 21 + ...VirtualNetworks_Update_MaximumSet_Gen.json | 52 + ...VirtualNetworks_Update_MinimumSet_Gen.json | 25 + ...dIdentityMetadatas_Get_MaximumSet_Gen.json | 30 + ...dIdentityMetadatas_Get_MinimumSet_Gen.json | 15 + ...VirtualMachineInstance_MaximumSet_Gen.json | 35 + ...VirtualMachineInstance_MinimumSet_Gen.json | 19 + ...Servers_CreateOrUpdate_MaximumSet_Gen.json | 103 + ...Servers_CreateOrUpdate_MinimumSet_Gen.json | 33 + .../VmmServers_Delete_MaximumSet_Gen.json | 19 + .../VmmServers_Delete_MinimumSet_Gen.json | 18 + .../VmmServers_Get_MaximumSet_Gen.json | 47 + .../VmmServers_Get_MinimumSet_Gen.json | 19 + ...rs_ListByResourceGroup_MaximumSet_Gen.json | 51 + ...rs_ListByResourceGroup_MinimumSet_Gen.json | 22 + ...ers_ListBySubscription_MaximumSet_Gen.json | 50 + ...ers_ListBySubscription_MinimumSet_Gen.json | 21 + .../VmmServers_Update_MaximumSet_Gen.json | 57 + .../VmmServers_Update_MinimumSet_Gen.json | 25 + specification/scvmm/ScVmm.Management/main.tsp | 38 + .../scvmm/ScVmm.Management/models.tsp | 949 +++ .../scvmm/ScVmm.Management/tspconfig.yaml | 14 + ...itySets_CreateOrUpdate_MaximumSet_Gen.json | 85 + ...itySets_CreateOrUpdate_MinimumSet_Gen.json | 33 + ...vailabilitySets_Delete_MaximumSet_Gen.json | 19 + ...vailabilitySets_Delete_MinimumSet_Gen.json | 18 + .../AvailabilitySets_Get_MaximumSet_Gen.json | 40 + .../AvailabilitySets_Get_MinimumSet_Gen.json | 19 + ...ts_ListByResourceGroup_MaximumSet_Gen.json | 44 + ...ts_ListByResourceGroup_MinimumSet_Gen.json | 22 + ...ets_ListBySubscription_MaximumSet_Gen.json | 43 + ...ets_ListBySubscription_MinimumSet_Gen.json | 21 + ...vailabilitySets_Update_MaximumSet_Gen.json | 50 + ...vailabilitySets_Update_MinimumSet_Gen.json | 24 + .../Clouds_CreateOrUpdate_MaximumSet_Gen.json | 121 + .../Clouds_CreateOrUpdate_MinimumSet_Gen.json | 33 + .../Clouds_Delete_MaximumSet_Gen.json | 19 + .../Clouds_Delete_MinimumSet_Gen.json | 18 + .../examples/Clouds_Get_MaximumSet_Gen.json | 57 + .../examples/Clouds_Get_MinimumSet_Gen.json | 19 + ...ds_ListByResourceGroup_MaximumSet_Gen.json | 61 + ...ds_ListByResourceGroup_MinimumSet_Gen.json | 22 + ...uds_ListBySubscription_MaximumSet_Gen.json | 60 + ...uds_ListBySubscription_MinimumSet_Gen.json | 21 + .../Clouds_Update_MaximumSet_Gen.json | 67 + .../Clouds_Update_MinimumSet_Gen.json | 24 + .../examples/CreateAvailabilitySet.json | 55 - ...reateCheckpointVirtualMachineInstance.json | 17 - .../2023-10-07/examples/CreateCloud.json | 69 - .../examples/CreateInventoryItem.json | 44 - .../examples/CreateVMInstanceGuestAgent.json | 44 - .../2023-10-07/examples/CreateVMMServer.json | 65 - .../CreateVirtualMachineInstance.json | 89 - .../CreateVirtualMachineTemplate.json | 67 - .../examples/CreateVirtualNetwork.json | 59 - .../examples/DeleteAvailabilitySet.json | 16 - ...eleteCheckpointVirtualMachineInstance.json | 16 - .../2023-10-07/examples/DeleteCloud.json | 16 - .../examples/DeleteInventoryItem.json | 13 - .../examples/DeleteVMInstanceGuestAgent.json | 10 - .../2023-10-07/examples/DeleteVMMServer.json | 16 - .../DeleteVirtualMachineInstance.json | 14 - .../DeleteVirtualMachineTemplate.json | 16 - .../examples/DeleteVirtualNetwork.json | 16 - .../examples/GetAvailabilitySet.json | 27 - .../stable/2023-10-07/examples/GetCloud.json | 34 - .../2023-10-07/examples/GetInventoryItem.json | 25 - .../examples/GetVMInstanceGuestAgent.json | 20 - .../2023-10-07/examples/GetVMMServer.json | 30 - .../examples/GetVirtualMachineInstance.json | 40 - .../examples/GetVirtualMachineTemplate.json | 33 - .../examples/GetVirtualNetwork.json | 29 - .../GetVmInstanceHybridIdentityMetadata.json | 19 - .../GuestAgents_Create_MaximumSet_Gen.json | 81 + .../GuestAgents_Create_MinimumSet_Gen.json | 20 + .../GuestAgents_Delete_MaximumSet_Gen.json | 12 + .../GuestAgents_Delete_MinimumSet_Gen.json | 12 + .../GuestAgents_Get_MaximumSet_Gen.json | 38 + .../GuestAgents_Get_MinimumSet_Gen.json | 13 + ...VirtualMachineInstance_MaximumSet_Gen.json | 43 + ...VirtualMachineInstance_MinimumSet_Gen.json | 19 + ...bridIdentityMetadata_ListByVmInstance.json | 23 - .../InventoryItems_Create_MaximumSet_Gen.json | 65 + .../InventoryItems_Create_MinimumSet_Gen.json | 20 + .../InventoryItems_Delete_MaximumSet_Gen.json | 15 + .../InventoryItems_Delete_MinimumSet_Gen.json | 15 + .../InventoryItems_Get_MaximumSet_Gen.json | 36 + .../InventoryItems_Get_MinimumSet_Gen.json | 16 + ...yItems_ListByVmmServer_MaximumSet_Gen.json | 40 + ...yItems_ListByVmmServer_MinimumSet_Gen.json | 21 + .../ListAvailabilitySetsByResourceGroup.json | 30 - .../ListAvailabilitySetsBySubscription.json | 29 - .../examples/ListCloudsByResourceGroup.json | 37 - .../examples/ListCloudsBySubscription.json | 36 - .../ListInventoryItemsByVMMServer.json | 28 - .../2023-10-07/examples/ListOperations.json | 148 - .../ListVMMServersByResourceGroup.json | 33 - .../ListVMMServersBySubscription.json | 32 - .../examples/ListVirtualMachineInstances.json | 44 - ...irtualMachineTemplatesByResourceGroup.json | 36 - ...VirtualMachineTemplatesBySubscription.json | 35 - .../ListVirtualNetworksByResourceGroup.json | 32 - .../ListVirtualNetworksBySubscription.json | 31 - .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + .../RestartVirtualMachineInstance.json | 13 - ...storeCheckpointVirtualMachineInstance.json | 16 - .../examples/StartVirtualMachineInstance.json | 13 - .../examples/StopVirtualMachineInstance.json | 16 - .../examples/UpdateAvailabilitySet.json | 42 - .../2023-10-07/examples/UpdateCloud.json | 49 - .../2023-10-07/examples/UpdateVMMServer.json | 45 - .../UpdateVirtualMachineInstance.json | 53 - .../UpdateVirtualMachineTemplate.json | 48 - .../examples/UpdateVirtualNetwork.json | 44 - .../VMInstanceGuestAgent_ListByVm.json | 24 - ...ances_CreateCheckpoint_MaximumSet_Gen.json | 19 + ...ances_CreateCheckpoint_MinimumSet_Gen.json | 16 + ...stances_CreateOrUpdate_MaximumSet_Gen.json | 316 + ...stances_CreateOrUpdate_MinimumSet_Gen.json | 28 + ...ances_DeleteCheckpoint_MaximumSet_Gen.json | 18 + ...ances_DeleteCheckpoint_MinimumSet_Gen.json | 16 + ...achineInstances_Delete_MaximumSet_Gen.json | 18 + ...achineInstances_Delete_MinimumSet_Gen.json | 16 + ...alMachineInstances_Get_MaximumSet_Gen.json | 123 + ...alMachineInstances_Get_MinimumSet_Gen.json | 16 + ...lMachineInstances_List_MaximumSet_Gen.json | 128 + ...lMachineInstances_List_MinimumSet_Gen.json | 20 + ...chineInstances_Restart_MaximumSet_Gen.json | 16 + ...chineInstances_Restart_MinimumSet_Gen.json | 16 + ...nces_RestoreCheckpoint_MaximumSet_Gen.json | 18 + ...nces_RestoreCheckpoint_MinimumSet_Gen.json | 16 + ...MachineInstances_Start_MaximumSet_Gen.json | 16 + ...MachineInstances_Start_MinimumSet_Gen.json | 16 + ...lMachineInstances_Stop_MaximumSet_Gen.json | 18 + ...lMachineInstances_Stop_MinimumSet_Gen.json | 16 + ...achineInstances_Update_MaximumSet_Gen.json | 179 + ...achineInstances_Update_MinimumSet_Gen.json | 21 + ...mplates_CreateOrUpdate_MaximumSet_Gen.json | 197 + ...mplates_CreateOrUpdate_MinimumSet_Gen.json | 33 + ...achineTemplates_Delete_MaximumSet_Gen.json | 19 + ...achineTemplates_Delete_MinimumSet_Gen.json | 18 + ...alMachineTemplates_Get_MaximumSet_Gen.json | 93 + ...alMachineTemplates_Get_MinimumSet_Gen.json | 19 + ...es_ListByResourceGroup_MaximumSet_Gen.json | 97 + ...es_ListByResourceGroup_MinimumSet_Gen.json | 22 + ...tes_ListBySubscription_MaximumSet_Gen.json | 96 + ...tes_ListBySubscription_MinimumSet_Gen.json | 21 + ...achineTemplates_Update_MaximumSet_Gen.json | 103 + ...achineTemplates_Update_MinimumSet_Gen.json | 24 + ...etworks_CreateOrUpdate_MaximumSet_Gen.json | 90 + ...etworks_CreateOrUpdate_MinimumSet_Gen.json | 33 + ...VirtualNetworks_Delete_MaximumSet_Gen.json | 19 + ...VirtualNetworks_Delete_MinimumSet_Gen.json | 18 + .../VirtualNetworks_Get_MaximumSet_Gen.json | 42 + .../VirtualNetworks_Get_MinimumSet_Gen.json | 19 + ...ks_ListByResourceGroup_MaximumSet_Gen.json | 46 + ...ks_ListByResourceGroup_MinimumSet_Gen.json | 22 + ...rks_ListBySubscription_MaximumSet_Gen.json | 45 + ...rks_ListBySubscription_MinimumSet_Gen.json | 21 + ...VirtualNetworks_Update_MaximumSet_Gen.json | 52 + ...VirtualNetworks_Update_MinimumSet_Gen.json | 25 + ...dIdentityMetadatas_Get_MaximumSet_Gen.json | 30 + ...dIdentityMetadatas_Get_MinimumSet_Gen.json | 15 + ...VirtualMachineInstance_MaximumSet_Gen.json | 35 + ...VirtualMachineInstance_MinimumSet_Gen.json | 19 + ...Servers_CreateOrUpdate_MaximumSet_Gen.json | 103 + ...Servers_CreateOrUpdate_MinimumSet_Gen.json | 33 + .../VmmServers_Delete_MaximumSet_Gen.json | 19 + .../VmmServers_Delete_MinimumSet_Gen.json | 18 + .../VmmServers_Get_MaximumSet_Gen.json | 47 + .../VmmServers_Get_MinimumSet_Gen.json | 19 + ...rs_ListByResourceGroup_MaximumSet_Gen.json | 51 + ...rs_ListByResourceGroup_MinimumSet_Gen.json | 22 + ...ers_ListBySubscription_MaximumSet_Gen.json | 50 + ...ers_ListBySubscription_MinimumSet_Gen.json | 21 + .../VmmServers_Update_MaximumSet_Gen.json | 57 + .../VmmServers_Update_MinimumSet_Gen.json | 25 + .../stable/2023-10-07/scvmm.json | 6170 +++++++++-------- 274 files changed, 13455 insertions(+), 4638 deletions(-) create mode 100644 specification/scvmm/ScVmm.Management/AvailabilitySet.tsp create mode 100644 specification/scvmm/ScVmm.Management/BackCompat.tsp create mode 100644 specification/scvmm/ScVmm.Management/Cloud.tsp create mode 100644 specification/scvmm/ScVmm.Management/GuestAgent.tsp create mode 100644 specification/scvmm/ScVmm.Management/InventoryItem.tsp create mode 100644 specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp create mode 100644 specification/scvmm/ScVmm.Management/VirtualMachineTemplate.tsp create mode 100644 specification/scvmm/ScVmm.Management/VirtualNetwork.tsp create mode 100644 specification/scvmm/ScVmm.Management/VmInstanceHybridIdentityMetadata.tsp create mode 100644 specification/scvmm/ScVmm.Management/VmmServer.tsp create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Update_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Update_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Update_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Update_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Create_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Create_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Create_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Create_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_ListByVmmServer_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_ListByVmmServer_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Operations_List_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/Operations_List_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_List_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_List_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Restart_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Restart_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Start_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Start_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Stop_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Stop_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Update_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Update_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Update_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Update_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Update_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Update_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Update_MaximumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Update_MinimumSet_Gen.json create mode 100644 specification/scvmm/ScVmm.Management/main.tsp create mode 100644 specification/scvmm/ScVmm.Management/models.tsp create mode 100644 specification/scvmm/ScVmm.Management/tspconfig.yaml create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Update_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Update_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Update_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Update_MinimumSet_Gen.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateAvailabilitySet.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateCheckpointVirtualMachineInstance.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateCloud.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateInventoryItem.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVMInstanceGuestAgent.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVMMServer.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVirtualMachineInstance.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVirtualMachineTemplate.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVirtualNetwork.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteAvailabilitySet.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteCheckpointVirtualMachineInstance.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteCloud.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteInventoryItem.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVMInstanceGuestAgent.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVMMServer.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVirtualMachineInstance.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVirtualMachineTemplate.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVirtualNetwork.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetAvailabilitySet.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetCloud.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetInventoryItem.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVMInstanceGuestAgent.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVMMServer.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVirtualMachineInstance.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVirtualMachineTemplate.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVirtualNetwork.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVmInstanceHybridIdentityMetadata.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Create_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Create_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/HybridIdentityMetadata_ListByVmInstance.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Create_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Create_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_ListByVmmServer_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_ListByVmmServer_MinimumSet_Gen.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListAvailabilitySetsByResourceGroup.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListAvailabilitySetsBySubscription.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListCloudsByResourceGroup.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListCloudsBySubscription.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListInventoryItemsByVMMServer.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListOperations.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVMMServersByResourceGroup.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVMMServersBySubscription.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualMachineInstances.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualMachineTemplatesByResourceGroup.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualMachineTemplatesBySubscription.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualNetworksByResourceGroup.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualNetworksBySubscription.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Operations_List_MinimumSet_Gen.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/RestartVirtualMachineInstance.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/RestoreCheckpointVirtualMachineInstance.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/StartVirtualMachineInstance.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/StopVirtualMachineInstance.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateAvailabilitySet.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateCloud.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVMMServer.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVirtualMachineInstance.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVirtualMachineTemplate.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVirtualNetwork.json delete mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VMInstanceGuestAgent_ListByVm.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_List_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_List_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Restart_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Restart_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Start_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Start_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Stop_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Stop_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Update_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Update_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Update_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Update_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Update_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Update_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Delete_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Delete_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Get_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Get_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Update_MaximumSet_Gen.json create mode 100644 specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Update_MinimumSet_Gen.json diff --git a/specification/scvmm/ScVmm.Management/AvailabilitySet.tsp b/specification/scvmm/ScVmm.Management/AvailabilitySet.tsp new file mode 100644 index 000000000000..9bd58c92dfb9 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/AvailabilitySet.tsp @@ -0,0 +1,67 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using OpenAPI; + +namespace Microsoft.ScVmm; +/** The AvailabilitySets resource definition. */ +model AvailabilitySet is TrackedResource { + /** Name of the AvailabilitySet. */ + @maxLength(54) + @minLength(1) + @pattern("[a-zA-Z0-9-_\\.]") + @path + @key("availabilitySetResourceName") + @segment("availabilitySets") + name: string; + + /** The extended location. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "This property is allowed but not recognized by the linter" + extendedLocation: ExtendedLocation; +} + +@armResourceOperations +interface AvailabilitySets { + /** Implements AvailabilitySet GET method. */ + @summary("Gets an AvailabilitySet.") + get is ArmResourceRead; + /** Onboards the ScVmm availability set as an Azure resource. */ + @summary("Implements AvailabilitySets PUT method.") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + AvailabilitySet, + LroHeaders = ArmAsyncOperationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; + /** Updates the AvailabilitySets resource. */ + @summary("Implements the AvailabilitySets PATCH method.") + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } + ) + update is ArmTagsPatchAsync; + /** Deregisters the ScVmm availability set from Azure. */ + @summary("Implements AvailabilitySet DELETE method.") + delete is ArmResourceDeleteWithoutOkAsync< + AvailabilitySet, + { + ...Foundations.BaseParameters; + ...QueryForceDelete; + }, + LroHeaders = ArmAsyncOperationHeader & + ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; + /** List of AvailabilitySets in a resource group. */ + @summary("Implements GET AvailabilitySets in a resource group.") + listByResourceGroup is ArmResourceListByParent; + /** List of AvailabilitySets in a subscription. */ + @summary("Implements GET AvailabilitySets in a subscription.") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/scvmm/ScVmm.Management/BackCompat.tsp b/specification/scvmm/ScVmm.Management/BackCompat.tsp new file mode 100644 index 000000000000..1d42eb88d770 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/BackCompat.tsp @@ -0,0 +1,3 @@ +import "@azure-tools/typespec-azure-core"; + +@@visibility(Azure.Core.Page.nextLink, "read"); diff --git a/specification/scvmm/ScVmm.Management/Cloud.tsp b/specification/scvmm/ScVmm.Management/Cloud.tsp new file mode 100644 index 000000000000..11df2b42e155 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/Cloud.tsp @@ -0,0 +1,66 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using OpenAPI; + +namespace Microsoft.ScVmm; +/** The Clouds resource definition. */ +model Cloud is TrackedResource { + /** Name of the Cloud. */ + @maxLength(54) + @minLength(1) + @pattern("[a-zA-Z0-9-_\\.]") + @path + @key("cloudResourceName") + @segment("clouds") + name: string; + + /** The extended location. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "This property is allowed but not recognized by the linter" + extendedLocation: ExtendedLocation; +} + +@armResourceOperations +interface Clouds { + /** Implements Cloud GET method. */ + @summary("Gets a Cloud.") + get is ArmResourceRead; + /** Onboards the ScVmm fabric cloud as an Azure cloud resource. */ + @summary("Implements Clouds PUT method.") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + /** Updates the Clouds resource. */ + @summary("Implements the Clouds PATCH method.") + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } + ) + update is ArmTagsPatchAsync; + /** Deregisters the ScVmm fabric cloud from Azure. */ + @summary("Implements Cloud resource DELETE method.") + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } + ) + delete is ArmResourceDeleteWithoutOkAsync< + Cloud, + { + ...Foundations.BaseParameters; + ...QueryForceDelete; + } + >; + /** List of Clouds in a resource group. */ + @summary("Implements GET Clouds in a resource group.") + listByResourceGroup is ArmResourceListByParent; + /** List of Clouds in a subscription. */ + @summary("Implements GET Clouds in a subscription.") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/scvmm/ScVmm.Management/GuestAgent.tsp b/specification/scvmm/ScVmm.Management/GuestAgent.tsp new file mode 100644 index 000000000000..e2433aecf13a --- /dev/null +++ b/specification/scvmm/ScVmm.Management/GuestAgent.tsp @@ -0,0 +1,41 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./VirtualMachineInstance.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; + +namespace Microsoft.ScVmm; +/** Defines the GuestAgent. */ +@parentResource(VirtualMachineInstance) +@singleton +model GuestAgent is ProxyResource { + /** Name of the guest agent. */ + @key("guestAgentName") + @segment("guestAgents") + @visibility("read") + @maxLength(54) + @minLength(1) + @pattern("[a-zA-Z0-9-_\\.]") + @path + name: string; +} + +@armResourceOperations +interface GuestAgents { + /** Implements GuestAgent GET method. */ + @summary("Gets GuestAgent.") + get is ArmResourceRead; + /** Create Or Update GuestAgent. */ + @summary("Implements GuestAgent PUT method.") + create is ArmResourceCreateOrReplaceAsync; + /** Implements GuestAgent DELETE method. */ + @summary("Deletes a GuestAgent resource.") + delete is ArmResourceDeleteSync; + /** Returns the list of GuestAgent of the given vm. */ + @summary("Implements GET GuestAgent in a vm.") + listByVirtualMachineInstance is ArmResourceListByParent; +} diff --git a/specification/scvmm/ScVmm.Management/InventoryItem.tsp b/specification/scvmm/ScVmm.Management/InventoryItem.tsp new file mode 100644 index 000000000000..454142f39561 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/InventoryItem.tsp @@ -0,0 +1,41 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./VmmServer.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; + +namespace Microsoft.ScVmm; +/** Defines the inventory item. */ +@parentResource(VmmServer) +model InventoryItem is ProxyResource { + /** Name of the inventoryItem. */ + @pattern("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$") + @path + @key("inventoryItemResourceName") + @segment("inventoryItems") + name: string; + + /** Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "This property is allowed but not recognized by the linter" + kind?: string; +} + +@armResourceOperations +interface InventoryItems { + /** Shows an inventory item. */ + @summary("Implements GET InventoryItem method.") + get is ArmResourceRead; + /** Create Or Update InventoryItem. */ + @summary("Implements InventoryItem PUT method.") + create is ArmResourceCreateOrReplaceSync; + /** Deletes an inventoryItem. */ + @summary("Implements inventoryItem DELETE method.") + delete is ArmResourceDeleteSync; + /** Returns the list of inventoryItems in the given VmmServer. */ + @summary("Implements GET for the list of Inventory Items in the VMMServer.") + listByVmmServer is ArmResourceListByParent; +} diff --git a/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp b/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp new file mode 100644 index 000000000000..49377ff789d6 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp @@ -0,0 +1,132 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ScVmm; +/** Define the virtualMachineInstance. */ +@singleton +model VirtualMachineInstance + is ExtensionResource { + /** Name of the virtual machine instance. */ + @key + @segment("virtualMachineInstances") + @visibility("read") + @maxLength(54) + @minLength(1) + @pattern("[a-zA-Z0-9-_\\.]") + @path + name: string; + + /** Gets or sets the extended location. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "This property is allowed but not recognized by the linter" + @visibility("read", "create") + extendedLocation: ExtendedLocation; +} + +/** The type used for update operations of the VirtualMachineInstance. */ +model VirtualMachineInstanceUpdate + is UpdateableProperties> { + /** The update properties of the VirtualMachineInstance. */ + @extension("x-ms-client-flatten", true) + properties?: VirtualMachineInstanceUpdateProperties; +} + +/** Delete From Host */ +union DeleteFromHost { + /** Enable delete from host. */ + `true`: "true", + + /** Disable delete from host. */ + `false`: "false", + + string, +} + +@armResourceOperations +interface VirtualMachineInstances { + /** Retrieves information about a virtual machine instance. */ + @summary("Gets a virtual machine.") + get is ArmResourceRead; + /** The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation. */ + @summary("Implements virtual machine PUT method.") + createOrUpdate is ArmResourceCreateOrUpdateAsync; + /** The operation to update a virtual machine instance. */ + @summary("Updates a virtual machine.") + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } + ) + update is ArmCustomPatchAsync< + VirtualMachineInstance, + VirtualMachineInstanceUpdate + >; + /** The operation to delete a virtual machine instance. */ + @summary("Deletes an virtual machine.") + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } + ) + delete is ArmResourceDeleteWithoutOkAsync< + VirtualMachineInstance, + { + ...Foundations.BaseParameters; + ...QueryForceDelete; + + /** Whether to disable the VM from azure and also delete it from Vmm. */ + @query("deleteFromHost") + deleteFromHost?: DeleteFromHost; + } + >; + /** Lists all of the virtual machine instances within the specified parent resource. */ + @summary("Implements List virtual machine instances.") + listByArm is ArmResourceListByParent; + /** The operation to power off (stop) a virtual machine instance. */ + @summary("Implements the operation to stop a virtual machine.") + stop is ArmResourceActionNoResponseContentAsync< + VirtualMachineInstance, + StopVirtualMachineOptions + >; + /** The operation to start a virtual machine instance. */ + @summary("Implements the operation to start a virtual machine.") + start is ArmResourceActionNoResponseContentAsync< + VirtualMachineInstance, + void + >; + /** The operation to restart a virtual machine instance. */ + @summary("Implements the operation to restart a virtual machine.") + restart is ArmResourceActionNoResponseContentAsync< + VirtualMachineInstance, + void + >; + /** Creates a checkpoint in virtual machine instance. */ + @summary("Implements the operation to creates a checkpoint in a virtual machine instance.") + createCheckpoint is ArmResourceActionNoResponseContentAsync< + VirtualMachineInstance, + VirtualMachineCreateCheckpoint + >; + /** Deletes a checkpoint in virtual machine instance. */ + @summary("Implements the operation to delete a checkpoint in a virtual machine instance.") + deleteCheckpoint is ArmResourceActionNoResponseContentAsync< + VirtualMachineInstance, + VirtualMachineDeleteCheckpoint + >; + /** Restores to a checkpoint in virtual machine instance. */ + @summary("Implements the operation to restores to a checkpoint in a virtual machine instance.") + restoreCheckpoint is ArmResourceActionNoResponseContentAsync< + VirtualMachineInstance, + VirtualMachineRestoreCheckpoint + >; +} diff --git a/specification/scvmm/ScVmm.Management/VirtualMachineTemplate.tsp b/specification/scvmm/ScVmm.Management/VirtualMachineTemplate.tsp new file mode 100644 index 000000000000..4f047ef22e0e --- /dev/null +++ b/specification/scvmm/ScVmm.Management/VirtualMachineTemplate.tsp @@ -0,0 +1,67 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using OpenAPI; + +namespace Microsoft.ScVmm; +/** The VirtualMachineTemplates resource definition. */ +model VirtualMachineTemplate + is TrackedResource { + /** Name of the VirtualMachineTemplate. */ + @maxLength(54) + @minLength(1) + @pattern("[a-zA-Z0-9-_\\.]") + @path + @key("virtualMachineTemplateName") + @segment("virtualMachineTemplates") + name: string; + + /** The extended location. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "This property is allowed but not recognized by the linter" + extendedLocation: ExtendedLocation; +} + +@armResourceOperations +interface VirtualMachineTemplates { + /** Implements VirtualMachineTemplate GET method. */ + @summary("Gets a VirtualMachineTemplate.") + get is ArmResourceRead; + /** Onboards the ScVmm VM Template as an Azure VM Template resource. */ + @summary("Implements VirtualMachineTemplates PUT method.") + createOrUpdate is ArmResourceCreateOrUpdateAsync; + /** Updates the VirtualMachineTemplate resource. */ + @summary("Implements the VirtualMachineTemplate PATCH method.") + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } + ) + update is ArmTagsPatchAsync; + /** Deregisters the ScVmm VM Template from Azure. */ + @summary("Implements VirtualMachineTemplate DELETE method.") + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } + ) + delete is ArmResourceDeleteWithoutOkAsync< + VirtualMachineTemplate, + { + ...Foundations.BaseParameters; + ...QueryForceDelete; + } + >; + /** List of VirtualMachineTemplates in a resource group. */ + @summary("Implements GET VirtualMachineTemplates in a resource group.") + listByResourceGroup is ArmResourceListByParent; + /** List of VirtualMachineTemplates in a subscription. */ + @summary("Implements GET VirtualMachineTemplates in a subscription.") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/scvmm/ScVmm.Management/VirtualNetwork.tsp b/specification/scvmm/ScVmm.Management/VirtualNetwork.tsp new file mode 100644 index 000000000000..12a8e500b1f8 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/VirtualNetwork.tsp @@ -0,0 +1,66 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using OpenAPI; + +namespace Microsoft.ScVmm; +/** The VirtualNetworks resource definition. */ +model VirtualNetwork is TrackedResource { + /** Name of the VirtualNetwork. */ + @maxLength(54) + @minLength(1) + @pattern("[a-zA-Z0-9-_\\.]") + @path + @key("virtualNetworkName") + @segment("virtualNetworks") + name: string; + + /** The extended location. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "This property is allowed but not recognized by the linter" + extendedLocation: ExtendedLocation; +} + +@armResourceOperations +interface VirtualNetworks { + /** Implements VirtualNetwork GET method. */ + @summary("Gets a VirtualNetwork.") + get is ArmResourceRead; + /** Onboards the ScVmm virtual network as an Azure virtual network resource. */ + @summary("Implements VirtualNetworks PUT method.") + createOrUpdate is ArmResourceCreateOrUpdateAsync; + /** Updates the VirtualNetworks resource. */ + @summary("Implements the VirtualNetworks PATCH method.") + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } + ) + update is ArmTagsPatchAsync; + /** Deregisters the ScVmm virtual network from Azure. */ + @summary("Implements VirtualNetwork DELETE method.") + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } + ) + delete is ArmResourceDeleteWithoutOkAsync< + VirtualNetwork, + { + ...Foundations.BaseParameters; + ...QueryForceDelete; + } + >; + /** List of VirtualNetworks in a resource group. */ + @summary("Implements GET VirtualNetworks in a resource group.") + listByResourceGroup is ArmResourceListByParent; + /** List of VirtualNetworks in a subscription. */ + @summary("Implements GET VirtualNetworks in a subscription.") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/scvmm/ScVmm.Management/VmInstanceHybridIdentityMetadata.tsp b/specification/scvmm/ScVmm.Management/VmInstanceHybridIdentityMetadata.tsp new file mode 100644 index 000000000000..a27edd51a540 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/VmInstanceHybridIdentityMetadata.tsp @@ -0,0 +1,37 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./VirtualMachineInstance.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; + +namespace Microsoft.ScVmm; +/** Defines the HybridIdentityMetadata. */ +@parentResource(VirtualMachineInstance) +@singleton +model VmInstanceHybridIdentityMetadata + is ProxyResource { + // TODO/NOTE: key name is used as a workaround for name collision with singleton + /** Name of the VM Instance Hybrid Identity Metadata */ + @key("vmInstanceHybridIdentityMetadataName") + @segment("hybridIdentityMetadata") + @maxLength(54) + @minLength(1) + @pattern("[a-zA-Z0-9-_\\.]") + @path + @visibility("read") + name: string; +} + +@armResourceOperations +interface VmInstanceHybridIdentityMetadatas { + /** Implements HybridIdentityMetadata GET method. */ + @summary("Gets HybridIdentityMetadata.") + get is ArmResourceRead; + /** Returns the list of HybridIdentityMetadata of the given VM. */ + @summary("Implements GET HybridIdentityMetadata in a vm.") + listByVirtualMachineInstance is ArmResourceListByParent; +} diff --git a/specification/scvmm/ScVmm.Management/VmmServer.tsp b/specification/scvmm/ScVmm.Management/VmmServer.tsp new file mode 100644 index 000000000000..3926037810b0 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/VmmServer.tsp @@ -0,0 +1,66 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using OpenAPI; + +namespace Microsoft.ScVmm; +/** The VmmServers resource definition. */ +model VmmServer is TrackedResource { + /** Name of the VmmServer. */ + @maxLength(54) + @minLength(1) + @pattern("[a-zA-Z0-9-_\\.]") + @path + @key("vmmServerName") + @segment("vmmServers") + name: string; + + /** The extended location. */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "This property is allowed but not recognized by the linter" + extendedLocation: ExtendedLocation; +} + +@armResourceOperations +interface VmmServers { + /** Implements VmmServer GET method. */ + @summary("Gets a VMMServer.") + get is ArmResourceRead; + /** Onboards the SCVmm fabric as an Azure VmmServer resource. */ + @summary("Implements VmmServers PUT method.") + createOrUpdate is ArmResourceCreateOrUpdateAsync; + /** Updates the VmmServers resource. */ + @summary("Implements VmmServers PATCH method.") + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } + ) + update is ArmTagsPatchAsync; + /** Removes the SCVmm fabric from Azure. */ + @summary("Implements VmmServers DELETE method.") + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } + ) + delete is ArmResourceDeleteWithoutOkAsync< + VmmServer, + { + ...Foundations.BaseParameters; + ...QueryForceDelete; + } + >; + /** List of VmmServers in a resource group. */ + @summary("Implements GET VmmServers in a resource group.") + listByResourceGroup is ArmResourceListByParent; + /** List of VmmServers in a subscription. */ + @summary("Implements GET VmmServers in a subscription.") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..bd26158035a8 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "title": "AvailabilitySets_CreateOrUpdate_MaximumSet", + "operationId": "AvailabilitySets_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "-", + "resource": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..a9299f054a95 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "AvailabilitySets_CreateOrUpdate_MinimumSet", + "operationId": "AvailabilitySets_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "_", + "resource": { + "extendedLocation": {}, + "location": "jelevilan" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..c92e32da2fc2 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "AvailabilitySets_Delete_MaximumSet", + "operationId": "AvailabilitySets_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "availabilitySetResourceName": "_" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..bfcba119ca0b --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "AvailabilitySets_Delete_MinimumSet", + "operationId": "AvailabilitySets_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "6" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..466b960db7f3 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "AvailabilitySets_Get_MaximumSet", + "operationId": "AvailabilitySets_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "-" + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..712923c73274 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "AvailabilitySets_Get_MinimumSet", + "operationId": "AvailabilitySets_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "V" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..36cffcee69e3 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "AvailabilitySets_ListByResourceGroup_MaximumSet", + "operationId": "AvailabilitySets_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..479fb51446d6 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "AvailabilitySets_ListByResourceGroup_MinimumSet", + "operationId": "AvailabilitySets_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..39403c128bdb --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "AvailabilitySets_ListBySubscription_MaximumSet", + "operationId": "AvailabilitySets_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..b065672c5db2 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "AvailabilitySets_ListBySubscription_MinimumSet", + "operationId": "AvailabilitySets_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Update_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..54a74d0136b6 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Update_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "AvailabilitySets_Update_MaximumSet", + "operationId": "AvailabilitySets_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "-", + "properties": { + "tags": { + "key1460": "vcbwibkvr" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Update_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..53b0a3aa0ada --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/AvailabilitySets_Update_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "AvailabilitySets_Update_MinimumSet", + "operationId": "AvailabilitySets_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "1", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {}, + "location": "jelevilan" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..dec3be9a11c2 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,121 @@ +{ + "title": "Clouds_CreateOrUpdate_MaximumSet", + "operationId": "Clouds_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "2", + "resource": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudCapacity": {} + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..77135d0b0d2c --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "Clouds_CreateOrUpdate_MinimumSet", + "operationId": "Clouds_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "-", + "resource": { + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..5771f63c2eeb --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Clouds_Delete_MaximumSet", + "operationId": "Clouds_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "cloudResourceName": "-" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..1371da91eb2a --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Clouds_Delete_MinimumSet", + "operationId": "Clouds_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "1" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8c14437fabfd --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Get_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "Clouds_Get_MaximumSet", + "operationId": "Clouds_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "_" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..f051952e6e97 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Clouds_Get_MinimumSet", + "operationId": "Clouds_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "i" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..50ad86379ca2 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "Clouds_ListByResourceGroup_MaximumSet", + "operationId": "Clouds_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/aplbh" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..f9478795f23d --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "Clouds_ListByResourceGroup_MinimumSet", + "operationId": "Clouds_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..5be580a6d2fe --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "Clouds_ListBySubscription_MaximumSet", + "operationId": "Clouds_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/aplbh" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..4f3e42081baa --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Clouds_ListBySubscription_MinimumSet", + "operationId": "Clouds_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Update_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..9f58290c10e3 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Update_MaximumSet_Gen.json @@ -0,0 +1,67 @@ +{ + "title": "Clouds_Update_MaximumSet", + "operationId": "Clouds_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "P", + "properties": { + "tags": { + "key5266": "hjpcnwmpnixsolrxnbl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Update_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..c0fc02168235 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Clouds_Update_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Clouds_Update_MinimumSet", + "operationId": "Clouds_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "_", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Create_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..e9b7586788ff --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Create_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "GuestAgents_Create_MaximumSet", + "operationId": "GuestAgents_Create", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "resource": { + "properties": { + "credentials": { + "username": "jqxuwirrcpfv", + "password": "gkvbnmuahumuoibvscoxzfdqwvfuf" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Create_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..0d57f62ac1a8 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Create_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "GuestAgents_Create_MinimumSet", + "operationId": "GuestAgents_Create", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "resource": {} + }, + "responses": { + "200": { + "body": {} + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": {} + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a9e4037d29b5 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Delete_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "GuestAgents_Delete_MaximumSet", + "operationId": "GuestAgents_Delete", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..2b89999988ad --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Delete_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "GuestAgents_Delete_MinimumSet", + "operationId": "GuestAgents_Delete", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..afdabdde6430 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "GuestAgents_Get_MaximumSet", + "operationId": "GuestAgents_Get", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..742ec90dbdbe --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_Get_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "title": "GuestAgents_Get_MinimumSet", + "operationId": "GuestAgents_Get", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json new file mode 100644 index 000000000000..6db4dd3489f8 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "GuestAgents_ListByVirtualMachineInstance_MaximumSet", + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json new file mode 100644 index 000000000000..5174653b5e03 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "GuestAgents_ListByVirtualMachineInstance_MinimumSet", + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Create_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..2d5b6d36d638 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Create_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "InventoryItems_Create_MaximumSet", + "operationId": "InventoryItems_Create", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "O", + "inventoryItemResourceName": "1BdDc2Ab-bDd9-Ebd6-bfdb-C0dbbdB5DEDf", + "resource": { + "properties": { + "inventoryType": "InventoryItemProperties" + }, + "kind": "M\\d_,V." + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "body": { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Create_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..82a0e9acf2e3 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Create_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "InventoryItems_Create_MinimumSet", + "operationId": "InventoryItems_Create", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": ".", + "inventoryItemResourceName": "bbFb0cBb-50ce-4bfc-3eeD-bC26AbCC257a", + "resource": {} + }, + "responses": { + "200": { + "body": {} + }, + "201": { + "body": {} + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..cb9c6e73d3f1 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "InventoryItems_Delete_MaximumSet", + "operationId": "InventoryItems_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "b", + "inventoryItemResourceName": "EcECadfd-Eaaa-e5Ce-ebdA-badeEd3c6af1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..83f5ba5a2a06 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Delete_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "InventoryItems_Delete_MinimumSet", + "operationId": "InventoryItems_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "_", + "inventoryItemResourceName": "cDBcbae6-BC3d-52fe-CedC-7eFeaBFabb82" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..85b101b44afe --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Get_MaximumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "title": "InventoryItems_Get_MaximumSet", + "operationId": "InventoryItems_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "1", + "inventoryItemResourceName": "2bFBede6-EEf8-becB-dBbd-B96DbBFdB3f3" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..bbddea0d16c4 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "InventoryItems_Get_MinimumSet", + "operationId": "InventoryItems_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "_", + "inventoryItemResourceName": "cacb8Ceb-efAC-bebb-ae7C-dec8C5Bb7100" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_ListByVmmServer_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_ListByVmmServer_MaximumSet_Gen.json new file mode 100644 index 000000000000..9bb19122499d --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_ListByVmmServer_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "InventoryItems_ListByVmmServer_MaximumSet", + "operationId": "InventoryItems_ListByVmmServer", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "X" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_ListByVmmServer_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_ListByVmmServer_MinimumSet_Gen.json new file mode 100644 index 000000000000..8399a4d90fec --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/InventoryItems_ListByVmmServer_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "InventoryItems_ListByVmmServer_MinimumSet", + "operationId": "InventoryItems_ListByVmmServer", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "H" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Operations_List_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..e5589330f554 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List_MaximumSet", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-10-07" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rieknsh", + "isDataAction": true, + "display": { + "provider": "avkabpzrbafrbnubspbrsippj", + "resource": "qojushhvjhkwwmboofogcky", + "operation": "v", + "description": "fmwevntnynhgzoksqpjidn" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/Operations_List_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..daa59bb54c11 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MinimumSet", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-10-07" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json new file mode 100644 index 000000000000..fc1ce4ecd762 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualMachineInstances_CreateCheckpoint_MaximumSet", + "operationId": "VirtualMachineInstances_CreateCheckpoint", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": { + "name": "ilvltf", + "description": "zoozhfbepldrgpjqsbhpqebtodrhvy" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json new file mode 100644 index 000000000000..fd1611ee7760 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_CreateCheckpoint_MinimumSet", + "operationId": "VirtualMachineInstances_CreateCheckpoint", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..968d99e12975 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,316 @@ +{ + "title": "VirtualMachineInstances_CreateOrUpdate_MaximumSet", + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "resource": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "adminPassword": "vavtppmmhlspydtkzxda", + "computerName": "uuxpcxuxcufllc", + "osType": "Windows" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql" + } + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql", + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "kz" + } + ] + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql", + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "kz" + } + ] + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..6c976787659b --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "VirtualMachineInstances_CreateOrUpdate_MinimumSet", + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "resource": { + "extendedLocation": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json new file mode 100644 index 000000000000..20b2970f75bf --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_DeleteCheckpoint_MaximumSet", + "operationId": "VirtualMachineInstances_DeleteCheckpoint", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": { + "id": "eenfflimcbgqfsebdusophahjpk" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json new file mode 100644 index 000000000000..da321cb1224b --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_DeleteCheckpoint_MinimumSet", + "operationId": "VirtualMachineInstances_DeleteCheckpoint", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..7ed55835440a --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_Delete_MaximumSet", + "operationId": "VirtualMachineInstances_Delete", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "force": "true", + "deleteFromHost": "true" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..0cf8953301ab --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Delete_MinimumSet", + "operationId": "VirtualMachineInstances_Delete", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a7bf57d14cc6 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Get_MaximumSet_Gen.json @@ -0,0 +1,123 @@ +{ + "title": "VirtualMachineInstances_Get_MaximumSet", + "operationId": "VirtualMachineInstances_Get", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + } + ], + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql" + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..49c8f84417cb --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Get_MinimumSet", + "operationId": "VirtualMachineInstances_Get", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_List_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..a8de59e516b3 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_List_MaximumSet_Gen.json @@ -0,0 +1,128 @@ +{ + "title": "VirtualMachineInstances_List_MaximumSet", + "operationId": "VirtualMachineInstances_List", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + } + ], + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql" + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_List_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..316d14ed91a9 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_List_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "VirtualMachineInstances_List_MinimumSet", + "operationId": "VirtualMachineInstances_List", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Restart_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Restart_MaximumSet_Gen.json new file mode 100644 index 000000000000..216d534d6466 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Restart_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Restart_MaximumSet", + "operationId": "VirtualMachineInstances_Restart", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Restart_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Restart_MinimumSet_Gen.json new file mode 100644 index 000000000000..7bd0879b55a9 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Restart_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Restart_MinimumSet", + "operationId": "VirtualMachineInstances_Restart", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json new file mode 100644 index 000000000000..c890243da685 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_RestoreCheckpoint_MaximumSet", + "operationId": "VirtualMachineInstances_RestoreCheckpoint", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": { + "id": "rweqduwzsn" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json new file mode 100644 index 000000000000..af360f1da610 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_RestoreCheckpoint_MinimumSet", + "operationId": "VirtualMachineInstances_RestoreCheckpoint", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Start_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Start_MaximumSet_Gen.json new file mode 100644 index 000000000000..37d2a02241c0 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Start_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Start_MaximumSet", + "operationId": "VirtualMachineInstances_Start", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Start_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Start_MinimumSet_Gen.json new file mode 100644 index 000000000000..d30c00876c68 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Start_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Start_MinimumSet", + "operationId": "VirtualMachineInstances_Start", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Stop_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Stop_MaximumSet_Gen.json new file mode 100644 index 000000000000..9866e8ef5ac4 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Stop_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_Stop_MaximumSet", + "operationId": "VirtualMachineInstances_Stop", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": { + "skipShutdown": "true" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Stop_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Stop_MinimumSet_Gen.json new file mode 100644 index 000000000000..c0a22fc7ced0 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Stop_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Stop_MinimumSet", + "operationId": "VirtualMachineInstances_Stop", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Update_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..8c5f5877e749 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Update_MaximumSet_Gen.json @@ -0,0 +1,179 @@ +{ + "title": "VirtualMachineInstances_Update_MaximumSet", + "operationId": "VirtualMachineInstances_Update", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "properties": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30 + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + } + } + ] + }, + "infrastructureProfile": { + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql", + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "kz" + } + ] + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Update_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..6a65796f568c --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineInstances_Update_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VirtualMachineInstances_Update_MinimumSet", + "operationId": "VirtualMachineInstances_Update", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {} + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..a3f6ec893749 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,197 @@ +{ + "title": "VirtualMachineTemplates_CreateOrUpdate_MaximumSet", + "operationId": "VirtualMachineTemplates_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "6", + "resource": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "isHighlyAvailable": "true" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..54070d1cf5b4 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "VirtualMachineTemplates_CreateOrUpdate_MinimumSet", + "operationId": "VirtualMachineTemplates_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "P", + "resource": { + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..b3c7aa4c905e --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualMachineTemplates_Delete_MaximumSet", + "operationId": "VirtualMachineTemplates_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "virtualMachineTemplateName": "6" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..57b7122c4b08 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineTemplates_Delete_MinimumSet", + "operationId": "VirtualMachineTemplates_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "5" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b809f2656a43 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Get_MaximumSet_Gen.json @@ -0,0 +1,93 @@ +{ + "title": "VirtualMachineTemplates_Get_MaximumSet", + "operationId": "VirtualMachineTemplates_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "4" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..a826574c701e --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualMachineTemplates_Get_MinimumSet", + "operationId": "VirtualMachineTemplates_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "m" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..d854b51c91ea --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "VirtualMachineTemplates_ListByResourceGroup_MaximumSet", + "operationId": "VirtualMachineTemplates_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/atbdyyso" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..74d2d4c5a6e1 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VirtualMachineTemplates_ListByResourceGroup_MinimumSet", + "operationId": "VirtualMachineTemplates_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..38a7b033562a --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,96 @@ +{ + "title": "VirtualMachineTemplates_ListBySubscription_MaximumSet", + "operationId": "VirtualMachineTemplates_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/atbdyyso" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..d49da9a65cd3 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VirtualMachineTemplates_ListBySubscription_MinimumSet", + "operationId": "VirtualMachineTemplates_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Update_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..e5628d59c929 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Update_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "VirtualMachineTemplates_Update_MaximumSet", + "operationId": "VirtualMachineTemplates_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "g", + "properties": { + "tags": { + "key6634": "wwfhrg" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Update_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..b2b31acbe444 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualMachineTemplates_Update_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "VirtualMachineTemplates_Update_MinimumSet", + "operationId": "VirtualMachineTemplates_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "-", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..2f9bea0d4f22 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "title": "VirtualNetworks_CreateOrUpdate_MaximumSet", + "operationId": "VirtualNetworks_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "_", + "resource": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..19e0de45672e --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "VirtualNetworks_CreateOrUpdate_MinimumSet", + "operationId": "VirtualNetworks_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "-", + "resource": { + "extendedLocation": {}, + "location": "fky" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..800f8ca90845 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualNetworks_Delete_MaximumSet", + "operationId": "VirtualNetworks_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "virtualNetworkName": "." + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..224da31900a6 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualNetworks_Delete_MinimumSet", + "operationId": "VirtualNetworks_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "1" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..aaf6e2a31161 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "VirtualNetworks_Get_MaximumSet", + "operationId": "VirtualNetworks_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "2" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..5ca1b434b8d7 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualNetworks_Get_MinimumSet", + "operationId": "VirtualNetworks_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "-" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..b2c4a8d7b727 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "VirtualNetworks_ListByResourceGroup_MaximumSet", + "operationId": "VirtualNetworks_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..a4aa344196c0 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VirtualNetworks_ListByResourceGroup_MinimumSet", + "operationId": "VirtualNetworks_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..a196e4d38860 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "VirtualNetworks_ListBySubscription_MaximumSet", + "operationId": "VirtualNetworks_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..92556f56363b --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VirtualNetworks_ListBySubscription_MinimumSet", + "operationId": "VirtualNetworks_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Update_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..fdc685c5710d --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Update_MaximumSet_Gen.json @@ -0,0 +1,52 @@ +{ + "title": "VirtualNetworks_Update_MaximumSet", + "operationId": "VirtualNetworks_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "S", + "properties": { + "tags": { + "key9516": "oxduo" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Update_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..8ea701da7b35 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VirtualNetworks_Update_MinimumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "VirtualNetworks_Update_MinimumSet", + "operationId": "VirtualNetworks_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "-", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8651dc85a156 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_Get_MaximumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_Get", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "properties": { + "resourceUid": "mikbntobifeiouinvsalnu", + "publicKey": "hijhfxcdjuzidfjjztoh", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default", + "name": "rxvpcegqc", + "type": "ixqhymswessvylnqgti", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..94920ce51700 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_Get_MinimumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_Get", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json new file mode 100644 index 000000000000..8e2d4776e0d8 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "resourceUid": "mikbntobifeiouinvsalnu", + "publicKey": "hijhfxcdjuzidfjjztoh", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default", + "name": "rxvpcegqc", + "type": "ixqhymswessvylnqgti", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json new file mode 100644 index 000000000000..cb06143e83ce --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb3f5c2817a4 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "VmmServers_CreateOrUpdate_MaximumSet", + "operationId": "VmmServers_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "-", + "resource": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi", + "password": "gaecsnkjr" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4 + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..713b3b0a9670 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "VmmServers_CreateOrUpdate_MinimumSet", + "operationId": "VmmServers_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "w", + "resource": { + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..cbfacb829d81 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VmmServers_Delete_MaximumSet", + "operationId": "VmmServers_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "vmmServerName": "." + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..35fef81e6cd5 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VmmServers_Delete_MinimumSet", + "operationId": "VmmServers_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "8" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..cf34a571f852 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Get_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "VmmServers_Get_MaximumSet", + "operationId": "VmmServers_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "." + }, + "responses": { + "200": { + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..e824ad8ddf26 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VmmServers_Get_MinimumSet", + "operationId": "VmmServers_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "D" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..cf469f65ae64 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "VmmServers_ListByResourceGroup_MaximumSet", + "operationId": "VmmServers_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..fca767a96354 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VmmServers_ListByResourceGroup_MinimumSet", + "operationId": "VmmServers_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..aa5e07d5c9e8 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "VmmServers_ListBySubscription_MaximumSet", + "operationId": "VmmServers_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..109cb8b8d48a --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VmmServers_ListBySubscription_MinimumSet", + "operationId": "VmmServers_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Update_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb5afd132f00 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Update_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "VmmServers_Update_MaximumSet", + "operationId": "VmmServers_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "Y", + "properties": { + "tags": { + "key7187": "oktnfvklfchnquelzzdagtpwfskzc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Update_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..b5d077a0f7a5 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2023-10-07/VmmServers_Update_MinimumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "VmmServers_Update_MinimumSet", + "operationId": "VmmServers_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "_", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/main.tsp b/specification/scvmm/ScVmm.Management/main.tsp new file mode 100644 index 000000000000..acdf29788a24 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/main.tsp @@ -0,0 +1,38 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; +import "./VmmServer.tsp"; +import "./Cloud.tsp"; +import "./VirtualNetwork.tsp"; +import "./VirtualMachineTemplate.tsp"; +import "./AvailabilitySet.tsp"; +import "./InventoryItem.tsp"; +import "./VirtualMachineInstance.tsp"; +import "./VmInstanceHybridIdentityMetadata.tsp"; +import "./GuestAgent.tsp"; +import "./BackCompat.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; +/** The Microsoft.ScVmm Rest API spec. */ +@armProviderNamespace +@service({ + title: "ScVmm", +}) +@versioned(Versions) +namespace Microsoft.ScVmm; + +/** The available API versions. */ +enum Versions { + /** Service version 2023-10-07. */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) + v2023_10_07: "2023-10-07", +} diff --git a/specification/scvmm/ScVmm.Management/models.tsp b/specification/scvmm/ScVmm.Management/models.tsp new file mode 100644 index 000000000000..bbc58d95d93e --- /dev/null +++ b/specification/scvmm/ScVmm.Management/models.tsp @@ -0,0 +1,949 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.OpenAPI; +using Azure.ResourceManager; + +namespace Microsoft.ScVmm; + +interface Operations extends Azure.ResourceManager.Operations {} + +alias VmmServerId = Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ScVmm/vmmServers"; + } +]>; + +alias VirtualNetworkId = Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ScVmm/virtualNetwork"; + } +]>; + +/** A reusable query option to force delete a resource. */ +model QueryForceDelete { + /** Forces the resource to be deleted. */ + @query("force") + force?: ForceDelete; +} + +/** The provisioning state of the resource. */ +union ResourceProvisioningState { + string, + Azure.ResourceManager.ResourceProvisioningState, + + /** The resource is provisioning. */ + Provisioning: "Provisioning", + + /** The resource is updating. */ + Updating: "Updating", + + /** The resource is being deleted. */ + Deleting: "Deleting", + + /** The resource has been accepted. */ + Accepted: "Accepted", + + /** The resource was created. */ + Created: "Created", +} + +/** Virtual machine operating system type. */ +union OsType { + /** Windows operating system. */ + Windows: "Windows", + + /** Linux operating system. */ + Linux: "Linux", + + /** Other operating system. */ + Other: "Other", + + string, +} + +/** Network address allocation method. */ +union AllocationMethod { + /** Dynamically allocated address. */ + Dynamic: "Dynamic", + + /** Statically allocated address. */ + Static: "Static", + + string, +} + +/** Guest agent provisioning action. */ +union ProvisioningAction { + /** Install guest agent. */ + install: "install", + + /** Uninstall guest agent. */ + uninstall: "uninstall", + + /** Repair guest agent. */ + repair: "repair", + + string, +} + +/** Limit CPU for migration. */ +union LimitCpuForMigration { + /** Enable limit CPU for migration. */ + `true`: "true", + + /** Disable limit CPU for migration. */ + `false`: "false", + + string, +} + +/** Dynamic memory enabled. */ +union DynamicMemoryEnabled { + /** Enable dynamic memory. */ + `true`: "true", + + /** Disable dynamic memory. */ + `false`: "false", + + string, +} + +/** Highly available. */ +union IsHighlyAvailable { + /** Enable highly available. */ + `true`: "true", + + /** Disable highly available. */ + `false`: "false", + + string, +} + +/** Create diff disk. */ +union CreateDiffDisk { + /** Enable create diff disk. */ + `true`: "true", + + /** Disable create diff disk. */ + `false`: "false", + + string, +} + +/** Customizable. */ +union IsCustomizable { + /** Enable customizable. */ + `true`: "true", + + /** Disable customizable. */ + `false`: "false", + + string, +} + +/** Skip shutdown. */ +union SkipShutdown { + /** Enable skip shutdown. */ + `true`: "true", + + /** Disable skip shutdown. */ + `false`: "false", + + string, +} + +/** Force Delete */ +union ForceDelete { + /** Enable force delete. */ + `true`: "true", + + /** Disable force delete. */ + `false`: "false", + + string, +} + +/** Defines the resource properties. */ +model VmmServerProperties { + /** Credentials to connect to VmmServer. */ + credentials?: VmmCredential; + + /** Fqdn is the hostname/ip of the vmmServer. */ + @minLength(1) + fqdn: string; + + /** Port is the port on which the vmmServer is listening. */ + @minValue(1) + @maxValue(65535) + port?: int32; + + /** Gets the connection status to the vmmServer. */ + @visibility("read") + connectionStatus?: string; + + /** Gets any error message if connection to vmmServer is having any issue. */ + @visibility("read") + errorMessage?: string; + + /** Unique ID of vmmServer. */ + @visibility("read") + uuid?: string; + + /** Version is the version of the vmmSever. */ + @visibility("read") + version?: string; + + /** Provisioning state of the resource. */ + @visibility("read") + provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; +} + +/** Credentials to connect to VmmServer. */ +model VmmCredential { + /** Username to use to connect to VmmServer. */ + username?: string; + + /** Password to use to connect to VmmServer. */ + @visibility("create", "update") + @secret + password?: string; +} + +/** The extended location. */ +model ExtendedLocation { + /** The extended location type. */ + type?: string; + + /** The extended location name. */ + name?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ExtendedLocation/customLocations"; + } + ]>; +} + +/** Defines the resource properties. */ +model CloudProperties { + /** Gets or sets the inventory Item ID for the resource. */ + inventoryItemId?: string; + + /** Unique ID of the cloud. */ + @pattern("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$") + uuid?: string; + + /** ARM Id of the vmmServer resource in which this resource resides. */ + vmmServerId?: VmmServerId; + + /** Name of the cloud in VmmServer. */ + @visibility("read") + cloudName?: string; + + /** Capacity of the cloud. */ + @visibility("read") + cloudCapacity?: CloudCapacity; + + /** List of QoS policies available for the cloud. */ + @visibility("read") + @encodedName("application/json", "storageQoSPolicies") + storageQosPolicies?: StorageQosPolicy[]; + + /** Provisioning state of the resource. */ + @visibility("read") + provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; +} + +/** Cloud Capacity model */ +model CloudCapacity { + /** CPUCount specifies the maximum number of CPUs that can be allocated in the cloud. */ + @visibility("read") cpuCount?: int64; + + /** MemoryMB specifies a memory usage limit in megabytes. */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is distinct from Mb" + @visibility("read") memoryMB?: int64; + + /** VMCount gives the max number of VMs that can be deployed in the cloud. */ + @visibility("read") vmCount?: int64; +} + +/** The StorageQoSPolicy definition. */ +model StorageQosPolicy { + /** The name of the policy. */ + name?: string; + + /** The ID of the QoS policy. */ + id?: string; + + /** The maximum IO operations per second. */ + iopsMaximum?: int64; + + /** The minimum IO operations per second. */ + iopsMinimum?: int64; + + /** The Bandwidth Limit for internet traffic. */ + bandwidthLimit?: int64; + + /** The underlying policy. */ + policyId?: string; +} + +/** Defines the resource properties. */ +model VirtualNetworkProperties { + /** Gets or sets the inventory Item ID for the resource. */ + inventoryItemId?: string; + + /** Unique ID of the virtual network. */ + @pattern("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$") + uuid?: string; + + /** ARM Id of the vmmServer resource in which this resource resides. */ + vmmServerId?: VmmServerId; + + /** Name of the virtual network in vmmServer. */ + @visibility("read") + networkName?: string; + + /** Provisioning state of the resource. */ + @visibility("read") + provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; +} + +/** Defines the resource properties. */ +model VirtualMachineTemplateProperties { + /** Gets or sets the inventory Item ID for the resource. */ + inventoryItemId?: string; + + /** Unique ID of the virtual machine template. */ + @pattern("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$") + uuid?: string; + + /** ARM Id of the vmmServer resource in which this resource resides. */ + vmmServerId?: VmmServerId; + + /** Gets the type of the os. */ + @visibility("read") + osType?: OsType; + + /** Gets os name. */ + @visibility("read") + osName?: string; + + /** Gets computer name. */ + @visibility("read") + computerName?: string; + + /** MemoryMB is the desired size of a virtual machine's memory, in MB. */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is distinct from Mb" + @visibility("read") + memoryMB?: int32; + + /** Gets the desired number of vCPUs for the vm. */ + @visibility("read") + cpuCount?: int32; + + /** Gets a value indicating whether to enable processor compatibility mode for live migration of VMs. */ + @visibility("read") + limitCpuForMigration?: LimitCpuForMigration; + + /** Gets a value indicating whether to enable dynamic memory or not. */ + @visibility("read") + dynamicMemoryEnabled?: DynamicMemoryEnabled; + + /** Gets a value indicating whether the vm template is customizable or not. */ + @visibility("read") + isCustomizable?: IsCustomizable; + + /** Gets the max dynamic memory for the vm. */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is distinct from Mb" + @visibility("read") + dynamicMemoryMaxMB?: int32; + + /** Gets the min dynamic memory for the vm. */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is distinct from Mb" + @visibility("read") + dynamicMemoryMinMB?: int32; + + /** Gets highly available property. */ + @visibility("read") + isHighlyAvailable?: IsHighlyAvailable; + + /** Gets the generation for the vm. */ + @visibility("read") + generation?: int32; + + /** Gets the network interfaces of the template. */ + @visibility("read") + @extension("x-ms-identifiers", ["name", "nicId"]) + networkInterfaces?: NetworkInterface[]; + + /** Gets the disks of the template. */ + @visibility("read") + @extension("x-ms-identifiers", ["diskId", "name"]) + disks?: VirtualDisk[]; + + /** Provisioning state of the resource. */ + @visibility("read") + provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; +} + +/** Network Interface model */ +model NetworkInterface { + /** Gets or sets the name of the network interface. */ + name?: string; + + /** Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. */ + @visibility("read") + displayName?: string; + + /** Gets the nic ipv4 addresses. */ + @visibility("read") + ipv4Addresses?: string[]; + + /** Gets the nic ipv6 addresses. */ + @visibility("read") + ipv6Addresses?: string[]; + + /** Gets or sets the nic MAC address. */ + macAddress?: string; + + /** Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. */ + virtualNetworkId?: VirtualNetworkId; + + /** Gets the name of the virtual network in vmmServer that the nic is connected to. */ + @visibility("read") + networkName?: string; + + /** Gets or sets the ipv4 address type. */ + ipv4AddressType?: AllocationMethod; + + /** Gets or sets the ipv6 address type. */ + ipv6AddressType?: AllocationMethod; + + /** Gets or sets the mac address type. */ + macAddressType?: AllocationMethod; + + /** Gets or sets the nic id. */ + nicId?: string; +} + +/** Network Interface Update model */ +model NetworkInterfaceUpdate is UpdateableProperties; + +/** Virtual disk model */ +model VirtualDisk { + /** Gets or sets the name of the disk. */ + name?: string; + + /** Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. */ + @visibility("read") + displayName?: string; + + /** Gets or sets the disk id. */ + diskId?: string; + + /** Gets or sets the disk total size. */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "GB is distinct from Gb" + diskSizeGB?: int32; + + /** Gets the max disk size. */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "GB is distinct from Gb" + @visibility("read") + maxDiskSizeGB?: int32; + + /** Gets or sets the disk bus. */ + bus?: int32; + + /** Gets or sets the disk lun. */ + lun?: int32; + + /** Gets or sets the disk bus type. */ + busType?: string; + + /** Gets or sets the disk vhd type. */ + vhdType?: string; + + /** Gets the disk volume type. */ + @visibility("read") + volumeType?: string; + + /** Gets the disk vhd format type. */ + @visibility("read") + vhdFormatType?: string; + + /** Gets or sets the disk id in the template. */ + @visibility("read", "create") + templateDiskId?: string; + + /** The QoS policy for the disk. */ + @encodedName("application/json", "storageQoSPolicy") + storageQosPolicy?: StorageQosPolicyDetails; + + /** Gets or sets a value indicating diff disk. */ + @visibility("read", "create") + createDiffDisk?: CreateDiffDisk; +} + +/** Virtual Disk Update model */ +model VirtualDiskUpdate is UpdateableProperties; + +/** The StorageQoSPolicyDetails definition. */ +model StorageQosPolicyDetails { + /** The name of the policy. */ + name?: string; + + /** The ID of the QoS policy. */ + id?: string; +} + +/** Defines the resource properties. */ +model AvailabilitySetProperties { + /** Name of the availability set. */ + @minLength(1) + availabilitySetName?: string; + + /** ARM Id of the vmmServer resource in which this resource resides. */ + vmmServerId?: VmmServerId; + + /** Provisioning state of the resource. */ + @visibility("read") + provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; +} + +/** The inventory type */ +union InventoryType { + /** Cloud inventory type */ + Cloud: "Cloud", + + /** VirtualNetwork inventory type */ + VirtualNetwork: "VirtualNetwork", + + /** VirtualMachine inventory type */ + VirtualMachine: "VirtualMachine", + + /** VirtualMachineTemplate inventory type */ + VirtualMachineTemplate: "VirtualMachineTemplate", + + string, +} + +/** Defines the resource properties. */ +@discriminator("inventoryType") +model InventoryItemProperties { + /** They inventory type. */ + inventoryType: InventoryType; + + /** Gets the tracked resource id corresponding to the inventory resource. */ + @visibility("read") + managedResourceId?: string; + + /** Gets the UUID (which is assigned by Vmm) for the inventory item. */ + @visibility("read") + uuid?: string; + + /** Gets the Managed Object name in Vmm for the inventory item. */ + @visibility("read") + inventoryItemName?: string; + + /** Provisioning state of the resource. */ + @visibility("read") + provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; +} + +/** Defines the resource properties. */ +model VirtualMachineInstanceProperties { + /** Availability Sets in vm. */ + availabilitySets?: AvailabilitySetListItem[]; + + /** OS properties. */ + @visibility("read", "create") + osProfile?: OsProfileForVmInstance; + + /** Hardware properties. */ + hardwareProfile?: HardwareProfile; + + /** Network properties. */ + networkProfile?: NetworkProfile; + + /** Storage properties. */ + storageProfile?: StorageProfile; + + /** Gets the infrastructure profile. */ + infrastructureProfile?: InfrastructureProfile; + + /** Gets the power state of the virtual machine. */ + @visibility("read") + powerState?: string; + + /** Provisioning state of the resource. */ + @visibility("read") + provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; +} + +/** Virtual Machine Instance Properties Update model */ +model VirtualMachineInstanceUpdateProperties + is UpdateableProperties> { + /** Hardware properties. */ + hardwareProfile?: HardwareProfileUpdate; + + /** Network properties. */ + networkProfile?: NetworkProfileUpdate; + + /** Storage properties. */ + storageProfile?: StorageProfileUpdate; + + /** Gets the infrastructure profile. */ + infrastructureProfile?: InfrastructureProfileUpdate; +} + +/** Availability Set model */ +model AvailabilitySetListItem { + /** Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. */ + id?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ScVmm/availabilitySets"; + } + ]>; + + /** Gets or sets the name of the availability set. */ + name?: string; +} + +/** Defines the resource properties. */ +model OsProfileForVmInstance { + /** Admin password of the virtual machine. */ + @visibility("create", "update") + @secret + adminPassword?: string; + + /** Gets or sets computer name. */ + computerName?: string; + + /** Gets the type of the os. */ + @visibility("read") + osType?: OsType; + + /** Gets os sku. */ + @visibility("read") + osSku?: string; + + /** Gets os version. */ + @visibility("read") + osVersion?: string; +} + +/** Defines the resource properties. */ +model HardwareProfile { + /** MemoryMB is the size of a virtual machine's memory, in MB. */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is distinct from Mb" + memoryMB?: int32; + + /** Gets or sets the number of vCPUs for the vm. */ + cpuCount?: int32; + + /** Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. */ + limitCpuForMigration?: LimitCpuForMigration; + + /** Gets or sets a value indicating whether to enable dynamic memory or not. */ + dynamicMemoryEnabled?: DynamicMemoryEnabled; + + /** Gets or sets the max dynamic memory for the vm. */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is distinct from Mb" + dynamicMemoryMaxMB?: int32; + + /** Gets or sets the min dynamic memory for the vm. */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is distinct from Mb" + dynamicMemoryMinMB?: int32; + + /** Gets highly available property. */ + @visibility("read") + isHighlyAvailable?: IsHighlyAvailable; +} + +/** Defines the resource update properties. */ +model HardwareProfileUpdate is UpdateableProperties; + +/** Defines the resource properties. */ +model NetworkProfile { + /** Gets or sets the list of network interfaces associated with the virtual machine. */ + @extension("x-ms-identifiers", ["name", "nicId"]) + networkInterfaces?: NetworkInterface[]; +} + +/** Defines the resource update properties. */ +model NetworkProfileUpdate + is UpdateableProperties> { + /** Gets or sets the list of network interfaces associated with the virtual machine. */ + @extension("x-ms-identifiers", ["name", "nicId"]) + networkInterfaces?: NetworkInterfaceUpdate[]; +} + +/** Defines the resource properties. */ +model StorageProfile { + /** Gets or sets the list of virtual disks associated with the virtual machine. */ + @extension("x-ms-identifiers", ["diskId", "name"]) + disks?: VirtualDisk[]; +} + +/** Defines the resource update properties. */ +model StorageProfileUpdate + is UpdateableProperties> { + /** Gets or sets the list of virtual disks associated with the virtual machine. */ + @extension("x-ms-identifiers", ["diskId", "name"]) + disks?: VirtualDiskUpdate[]; +} + +/** Specifies the vmmServer infrastructure specific settings for the virtual machine instance. */ +model InfrastructureProfile { + /** Gets or sets the inventory Item ID for the resource. */ + @visibility("read", "create") + inventoryItemId?: string; + + /** ARM Id of the vmmServer resource in which this resource resides. */ + @visibility("read", "create") + vmmServerId?: VmmServerId; + + /** ARM Id of the cloud resource to use for deploying the vm. */ + @visibility("read", "create") + cloudId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ScVmm/clouds"; + } + ]>; + + /** ARM Id of the template resource to use for deploying the vm. */ + @visibility("read", "create") + templateId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ScVmm/virtualMachineTemplates"; + } + ]>; + + /** VMName is the name of VM on the SCVmm server. */ + @minLength(1) + @visibility("read", "create") + vmName?: string; + + /** Unique ID of the virtual machine. */ + @visibility("read", "create") + uuid?: string; + + /** Last restored checkpoint in the vm. */ + @visibility("read") + @encodedName("application/json", "lastRestoredVMCheckpoint") + lastRestoredVmCheckpoint?: Checkpoint; + + /** Checkpoints in the vm. */ + #suppress "@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers" "Workaround for emitter problem" + @visibility("read") + @extension("x-ms-identifiers", ["checkpointID"]) + checkpoints?: Checkpoint[]; + + /** Type of checkpoint supported for the vm. */ + @visibility("read", "create", "update") + checkpointType?: string; + + /** Gets or sets the generation for the vm. */ + @visibility("read", "create") + generation?: int32; + + /** Gets or sets the bios guid for the vm. */ + @visibility("read", "create") + biosGuid?: string; +} + +/** Specifies the vmmServer infrastructure specific update settings for the virtual machine instance. */ +model InfrastructureProfileUpdate + is UpdateableProperties; + +/** Defines the resource properties. */ +model Checkpoint { + /** Gets ID of parent of the checkpoint. */ + @encodedName("application/json", "parentCheckpointID") + parentCheckpointId?: string; + + /** Gets ID of the checkpoint. */ + @encodedName("application/json", "checkpointID") + checkpointId?: string; + + /** Gets name of the checkpoint. */ + name?: string; + + /** Gets description of the checkpoint. */ + description?: string; +} + +/** Defines the stop action properties. */ +model StopVirtualMachineOptions { + /** Gets or sets a value indicating whether to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Defaults to false. */ + skipShutdown?: SkipShutdown = SkipShutdown.`false`; +} + +/** Describes the properties of Hybrid Identity Metadata for a Virtual Machine. */ +model VmInstanceHybridIdentityMetadataProperties { + /** The unique identifier for the resource. */ + resourceUid?: string; + + /** Gets or sets the Public Key. */ + publicKey?: string; + + /** Provisioning state of the resource. */ + @visibility("read") + provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; +} + +/** Defines the create checkpoint action properties. */ +model VirtualMachineCreateCheckpoint { + /** Name of the checkpoint. */ + name?: string; + + /** Description of the checkpoint. */ + description?: string; +} + +/** Defines the delete checkpoint action properties. */ +model VirtualMachineDeleteCheckpoint { + /** ID of the checkpoint to be deleted. */ + id?: string; +} + +/** Defines the restore checkpoint action properties. */ +model VirtualMachineRestoreCheckpoint { + /** ID of the checkpoint to be restored to. */ + id?: string; +} + +/** Defines the resource properties. */ +model GuestAgentProperties { + /** Gets a unique identifier for this resource. */ + @visibility("read") + uuid?: string; + + /** Username / Password Credentials to provision guest agent. */ + credentials?: GuestCredential; + + /** HTTP Proxy configuration for the VM. */ + httpProxyConfig?: HttpProxyConfiguration; + + /** Gets or sets the guest agent provisioning action. */ + provisioningAction?: ProvisioningAction; + + /** Gets the guest agent status. */ + @visibility("read") + status?: string; + + /** Gets the name of the corresponding resource in Kubernetes. */ + @visibility("read") + customResourceName?: string; + + /** Provisioning state of the resource. */ + @visibility("read") + provisioningState?: Microsoft.ScVmm.ResourceProvisioningState; +} + +/** Username / Password Credentials to connect to guest. */ +model GuestCredential { + /** Gets or sets username to connect with the guest. */ + username: string; + + /** Gets or sets the password to connect with the guest. */ + @visibility("create", "update") + @secret + password: string; +} + +/** HTTP Proxy configuration for the VM. */ +model HttpProxyConfiguration { + /** Gets or sets httpsProxy url. */ + httpsProxy?: string; +} + +/** Defines the resource properties. */ +model InventoryItemDetails { + /** Gets or sets the inventory Item ID for the resource. */ + inventoryItemId?: string; + + /** Gets or sets the Managed Object name in Vmm for the resource. */ + inventoryItemName?: string; +} + +/** The Cloud inventory item. */ +model CloudInventoryItem extends InventoryItemProperties { + /** They inventory type. */ + inventoryType: InventoryType.Cloud; +} + +/** The Virtual network inventory item. */ +model VirtualNetworkInventoryItem extends InventoryItemProperties { + /** They inventory type. */ + inventoryType: InventoryType.VirtualNetwork; +} + +/** The Virtual machine template inventory item. */ +model VirtualMachineTemplateInventoryItem extends InventoryItemProperties { + /** Gets the desired number of vCPUs for the vm. */ + @visibility("read") + cpuCount?: int32; + + /** MemoryMB is the desired size of a virtual machine's memory, in MB. */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is distinct from Mb" + @visibility("read") + memoryMB?: int32; + + /** Gets the type of the os. */ + @visibility("read") + osType?: OsType; + + /** Gets os name. */ + @visibility("read") + osName?: string; + + /** They inventory type. */ + inventoryType: InventoryType.VirtualMachineTemplate; +} + +/** The Virtual machine inventory item. */ +model VirtualMachineInventoryItem extends InventoryItemProperties { + /** Gets the type of the os. */ + @visibility("read") + osType?: OsType; + + /** Gets os name. */ + @visibility("read") + osName?: string; + + /** Gets os version. */ + @visibility("read") + osVersion?: string; + + /** Gets the power state of the virtual machine. */ + @visibility("read") + powerState?: string; + + /** Gets or sets the nic ip addresses. */ + ipAddresses?: string[]; + + /** Cloud inventory resource details where the VM is present. */ + cloud?: InventoryItemDetails; + + /** Gets the bios guid. */ + @visibility("read") + biosGuid?: string; + + /** Gets the tracked resource id corresponding to the inventory resource. */ + @visibility("read") + managedMachineResourceId?: Azure.Core.armResourceIdentifier<[]>; + + /** They inventory type. */ + inventoryType: InventoryType.VirtualMachine; +} diff --git a/specification/scvmm/ScVmm.Management/tspconfig.yaml b/specification/scvmm/ScVmm.Management/tspconfig.yaml new file mode 100644 index 000000000000..8345bf5a9d7e --- /dev/null +++ b/specification/scvmm/ScVmm.Management/tspconfig.yaml @@ -0,0 +1,14 @@ +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + omit-unreachable-types: true + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/scvmm.json" + examples-directory: "{project-root}/examples" +linter: + disable: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..bd26158035a8 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "title": "AvailabilitySets_CreateOrUpdate_MaximumSet", + "operationId": "AvailabilitySets_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "-", + "resource": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..a9299f054a95 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "AvailabilitySets_CreateOrUpdate_MinimumSet", + "operationId": "AvailabilitySets_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "_", + "resource": { + "extendedLocation": {}, + "location": "jelevilan" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..c92e32da2fc2 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "AvailabilitySets_Delete_MaximumSet", + "operationId": "AvailabilitySets_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "availabilitySetResourceName": "_" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..bfcba119ca0b --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "AvailabilitySets_Delete_MinimumSet", + "operationId": "AvailabilitySets_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "6" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..466b960db7f3 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "AvailabilitySets_Get_MaximumSet", + "operationId": "AvailabilitySets_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "-" + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..712923c73274 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "AvailabilitySets_Get_MinimumSet", + "operationId": "AvailabilitySets_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "V" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..36cffcee69e3 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "AvailabilitySets_ListByResourceGroup_MaximumSet", + "operationId": "AvailabilitySets_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..479fb51446d6 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "AvailabilitySets_ListByResourceGroup_MinimumSet", + "operationId": "AvailabilitySets_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..39403c128bdb --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "AvailabilitySets_ListBySubscription_MaximumSet", + "operationId": "AvailabilitySets_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..b065672c5db2 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "AvailabilitySets_ListBySubscription_MinimumSet", + "operationId": "AvailabilitySets_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Update_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..54a74d0136b6 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Update_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "AvailabilitySets_Update_MaximumSet", + "operationId": "AvailabilitySets_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "-", + "properties": { + "tags": { + "key1460": "vcbwibkvr" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Update_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..53b0a3aa0ada --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/AvailabilitySets_Update_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "AvailabilitySets_Update_MinimumSet", + "operationId": "AvailabilitySets_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "1", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {}, + "location": "jelevilan" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..dec3be9a11c2 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,121 @@ +{ + "title": "Clouds_CreateOrUpdate_MaximumSet", + "operationId": "Clouds_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "2", + "resource": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudCapacity": {} + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..77135d0b0d2c --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "Clouds_CreateOrUpdate_MinimumSet", + "operationId": "Clouds_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "-", + "resource": { + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..5771f63c2eeb --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Clouds_Delete_MaximumSet", + "operationId": "Clouds_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "cloudResourceName": "-" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..1371da91eb2a --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Clouds_Delete_MinimumSet", + "operationId": "Clouds_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "1" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8c14437fabfd --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Get_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "Clouds_Get_MaximumSet", + "operationId": "Clouds_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "_" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..f051952e6e97 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Clouds_Get_MinimumSet", + "operationId": "Clouds_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "i" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..50ad86379ca2 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "Clouds_ListByResourceGroup_MaximumSet", + "operationId": "Clouds_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/aplbh" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..f9478795f23d --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "Clouds_ListByResourceGroup_MinimumSet", + "operationId": "Clouds_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..5be580a6d2fe --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "Clouds_ListBySubscription_MaximumSet", + "operationId": "Clouds_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/aplbh" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..4f3e42081baa --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Clouds_ListBySubscription_MinimumSet", + "operationId": "Clouds_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Update_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..9f58290c10e3 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Update_MaximumSet_Gen.json @@ -0,0 +1,67 @@ +{ + "title": "Clouds_Update_MaximumSet", + "operationId": "Clouds_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "P", + "properties": { + "tags": { + "key5266": "hjpcnwmpnixsolrxnbl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Update_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..c0fc02168235 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Clouds_Update_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Clouds_Update_MinimumSet", + "operationId": "Clouds_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "_", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateAvailabilitySet.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateAvailabilitySet.json deleted file mode 100644 index 310299b81547..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateAvailabilitySet.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "availabilitySetResourceName": "HRAvailabilitySet", - "body": { - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/VMMServers/ContosoVMMServer", - "availabilitySetName": "hr-avset" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/AvailabilitySets/HRAvailabilitySet", - "name": "HRAvailabilitySet", - "type": "Microsoft.ScVmm/AvailabilitySets", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/VMMServers/ContosoVMMServer", - "availabilitySetName": "hr-avset", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/AvailabilitySets/HRAvailabilitySet", - "name": "HRAvailabilitySet", - "type": "Microsoft.ScVmm/AvailabilitySets", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/VMMServers/ContosoVMMServer", - "availabilitySetName": "hr-avset", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateCheckpointVirtualMachineInstance.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateCheckpointVirtualMachineInstance.json deleted file mode 100644 index 5ce2eb461e25..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateCheckpointVirtualMachineInstance.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", - "body": { - "name": "Demo Checkpoint name", - "description": "Demo Checkpoint description" - } - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ScVmm/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateCloud.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateCloud.json deleted file mode 100644 index b81db907eb3d..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateCloud.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "cloudResourceName": "HRCloud", - "body": { - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/HRCloud", - "name": "HRCloud", - "type": "Microsoft.SCVMM/Clouds", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "cloudName": "HRCloud", - "cloudCapacity": { - "cpuCount": 10, - "memoryMB": 10240, - "vmCount": 10 - } - } - } - }, - "201": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/HRCloud", - "name": "HRCloud", - "type": "Microsoft.SCVMM/Clouds", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "cloudName": "HRCloud", - "cloudCapacity": { - "cpuCount": 10, - "memoryMB": 10240, - "vmCount": 10 - } - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateInventoryItem.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateInventoryItem.json deleted file mode 100644 index 51fd8722d212..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateInventoryItem.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "vmmServerName": "ContosoVMMServer", - "inventoryItemResourceName": "12345678-1234-1234-1234-123456789abc", - "body": { - "properties": { - "inventoryType": "Cloud" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "name": "12345678-1234-1234-1234-123456789abc", - "type": "Microsoft.SCVMM/VMMServers/InventoryItems", - "properties": { - "inventoryType": "Cloud", - "managedResourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/contoso-cloud", - "inventoryItemName": "contoso-cloud", - "uuid": "12345678-1234-1234-1234-123456789abc", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "name": "12345678-1234-1234-1234-123456789abc", - "type": "Microsoft.SCVMM/VMMServers/InventoryItems", - "properties": { - "inventoryType": "Cloud", - "managedResourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/contoso-cloud", - "inventoryItemName": "contoso-cloud", - "uuid": "12345678-1234-1234-1234-123456789abc", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVMInstanceGuestAgent.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVMInstanceGuestAgent.json deleted file mode 100644 index 3709b72c5fa3..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVMInstanceGuestAgent.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", - "body": { - "properties": { - "provisioningAction": "install", - "credentials": { - "username": "tempuser", - "password": "" - }, - "httpProxyConfig": { - "httpsProxy": "http://192.1.2.3:8080" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", - "name": "default", - "type": "Microsoft.ScVmm/VirtualMachineInstances/guestAgents", - "properties": { - "provisioningAction": "install", - "status": "connected", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", - "name": "default", - "type": "Microsoft.ScVmm/VirtualMachineInstances/guestAgents", - "properties": { - "provisioningAction": "install", - "status": "connected", - "provisioningState": "Created" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVMMServer.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVMMServer.json deleted file mode 100644 index 04818c6bffbd..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVMMServer.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "vmmServerName": "ContosoVMMServer", - "body": { - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "fqdn": "VMM.contoso.com", - "port": 1234, - "credentials": { - "username": "testuser", - "password": "password" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "name": "ContosoVMMServer", - "type": "Microsoft.SCVMM/VMMServers", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "fqdn": "VMM.contoso.com", - "port": 1234, - "connectionStatus": "Connected", - "uuid": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "version": "2.0", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "name": "ContosoVMMServer", - "type": "Microsoft.SCVMM/VMMServers", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "fqdn": "VMM.contoso.com", - "port": 1234, - "connectionStatus": "Connected", - "uuid": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "version": "2.0", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVirtualMachineInstance.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVirtualMachineInstance.json deleted file mode 100644 index 652db9992f13..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVirtualMachineInstance.json +++ /dev/null @@ -1,89 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", - "body": { - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso" - }, - "properties": { - "infrastructureProfile": { - "cloudId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/HRCloud", - "templateId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualMachineTemplates/HRVirtualMachineTemplate", - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer" - }, - "hardwareProfile": { - "memoryMB": 4196, - "cpuCount": 4 - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.ScVmm/virtualMachineInstances/default", - "name": "default", - "type": "Microsoft.ScVmm/VirtualMachineInstances", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso" - }, - "properties": { - "infrastructureProfile": { - "cloudId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/HRCloud", - "templateId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualMachineTemplates/HRVirtualMachineTemplate", - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "biosGuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" - }, - "osProfile": { - "computerName": "DemoVM", - "osType": "Windows", - "osSku": "Windows Server 2022", - "osVersion": "10.0.10101" - }, - "hardwareProfile": { - "memoryMB": 4196, - "cpuCount": 4 - }, - "powerState": "Running", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/ContosoAgent/providers/Microsoft.ScVmm/virtualMachineInstances/default", - "name": "default", - "type": "Microsoft.ScVmm/VirtualMachineInstances", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso" - }, - "properties": { - "infrastructureProfile": { - "cloudId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/HRCloud", - "templateId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualMachineTemplates/HRVirtualMachineTemplate", - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "biosGuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" - }, - "osProfile": { - "computerName": "DemoVM", - "osType": "Windows", - "osSku": "Windows Server 2022", - "osVersion": "10.0.10101" - }, - "hardwareProfile": { - "memoryMB": 4196, - "cpuCount": 4 - }, - "powerState": "Running", - "provisioningState": "Created" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVirtualMachineTemplate.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVirtualMachineTemplate.json deleted file mode 100644 index a4380a23f057..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVirtualMachineTemplate.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "virtualMachineTemplateName": "HRVirtualMachineTemplate", - "body": { - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualMachineTemplates/HRVirtualMachineTemplate", - "name": "HRVirtualMachineTemplate", - "type": "Microsoft.SCVMM/VirtualMachineTemplates", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "osType": "Windows", - "osName": "Windows OS", - "computerName": "DemoVM", - "cpuCount": 1, - "memoryMB": 1024 - } - } - }, - "201": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualMachineTemplates/HRVirtualMachineTemplate", - "name": "HRVirtualMachineTemplate", - "type": "Microsoft.SCVMM/VirtualMachineTemplates", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "osType": "Windows", - "osName": "Windows OS", - "computerName": "DemoVM", - "cpuCount": 1, - "memoryMB": 1024 - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVirtualNetwork.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVirtualNetwork.json deleted file mode 100644 index 3896a512eef2..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/CreateVirtualNetwork.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "virtualNetworkName": "HRVirtualNetwork", - "body": { - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualNetworks/HRVirtualNetwork", - "name": "HRVirtualNetwork", - "type": "Microsoft.SCVMM/VirtualNetworks", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "networkName": "HRVirtualNetwork", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualNetworks/HRVirtualNetwork", - "name": "HRVirtualNetwork", - "type": "Microsoft.SCVMM/VirtualNetworks", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "networkName": "HRVirtualNetwork", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteAvailabilitySet.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteAvailabilitySet.json deleted file mode 100644 index b87901257411..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteAvailabilitySet.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "availabilitySetResourceName": "HRAvailabilitySet" - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.SCVMM/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - }, - "204": {} - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteCheckpointVirtualMachineInstance.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteCheckpointVirtualMachineInstance.json deleted file mode 100644 index 326344db7c80..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteCheckpointVirtualMachineInstance.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", - "body": { - "id": "Demo CheckpointID" - } - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ScVmm/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteCloud.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteCloud.json deleted file mode 100644 index 6fddca86d9ca..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteCloud.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "cloudResourceName": "HRCloud" - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.SCVMM/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - }, - "204": {} - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteInventoryItem.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteInventoryItem.json deleted file mode 100644 index 0b46fcfeeb79..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteInventoryItem.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "vmmServerName": "ContosoVMMServer", - "inventoryItemResourceName": "12345678-1234-1234-1234-123456789abc" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVMInstanceGuestAgent.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVMInstanceGuestAgent.json deleted file mode 100644 index b4d3711d4fe1..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVMInstanceGuestAgent.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVMMServer.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVMMServer.json deleted file mode 100644 index e2e28cd4c6e3..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVMMServer.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "vmmServerName": "ContosoVMMServer" - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.SCVMM/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - }, - "204": {} - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVirtualMachineInstance.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVirtualMachineInstance.json deleted file mode 100644 index da5b149484fb..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVirtualMachineInstance.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ScVmm/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - }, - "204": {} - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVirtualMachineTemplate.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVirtualMachineTemplate.json deleted file mode 100644 index f3b5c778fcb4..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVirtualMachineTemplate.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "virtualMachineTemplateName": "HRVirtualMachineTemplate" - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.SCVMM/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - }, - "204": {} - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVirtualNetwork.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVirtualNetwork.json deleted file mode 100644 index d19cacb1fedf..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/DeleteVirtualNetwork.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "virtualNetworkName": "HRVirtualNetwork" - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.SCVMM/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - }, - "204": {} - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetAvailabilitySet.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetAvailabilitySet.json deleted file mode 100644 index eedfdabb38f5..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetAvailabilitySet.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "availabilitySetResourceName": "HRAvailabilitySet" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/AvailabilitySets/HRAvailabilitySet", - "name": "HRAvailabilitySet", - "type": "Microsoft.ScVmm/AvailabilitySets", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/VMMServers/ContosoVMMServer", - "availabilitySetName": "hr-avset", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetCloud.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetCloud.json deleted file mode 100644 index 57097db0fb25..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetCloud.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "cloudResourceName": "HRCloud" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/HRCloud", - "name": "HRCloud", - "type": "Microsoft.SCVMM/Clouds", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "cloudName": "HRCloud", - "cloudCapacity": { - "cpuCount": 10, - "memoryMB": 10240, - "vmCount": 10 - } - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetInventoryItem.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetInventoryItem.json deleted file mode 100644 index 155b57f20c7a..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetInventoryItem.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "vmmServerName": "ContosoVMMServer", - "inventoryItemResourceName": "12345678-1234-1234-1234-123456789abc" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "name": "12345678-1234-1234-1234-123456789abc", - "type": "Microsoft.SCVMM/VMMServers/InventoryItems", - "properties": { - "inventoryType": "Cloud", - "managedResourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/contoso-cloud", - "inventoryItemName": "contoso-cloud", - "uuid": "12345678-1234-1234-1234-123456789abc", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVMInstanceGuestAgent.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVMInstanceGuestAgent.json deleted file mode 100644 index 8e19a18937c3..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVMInstanceGuestAgent.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", - "name": "default", - "type": "Microsoft.ScVmm/VirtualMachineInstances/guestAgents", - "properties": { - "provisioningAction": "install", - "status": "connected", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVMMServer.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVMMServer.json deleted file mode 100644 index 37b6e232b661..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVMMServer.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "vmmServerName": "ContosoVMMServer" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "name": "ContosoVMMServer", - "type": "Microsoft.SCVMM/VMMServers", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "fqdn": "VMM.contoso.com", - "port": 1234, - "connectionStatus": "Connected", - "uuid": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "version": "2.0", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVirtualMachineInstance.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVirtualMachineInstance.json deleted file mode 100644 index 1a97052e6594..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVirtualMachineInstance.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.ScVmm/virtualMachineInstances/default", - "name": "default", - "type": "Microsoft.ScVmm/VirtualMachineInstances", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso" - }, - "properties": { - "infrastructureProfile": { - "cloudId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/HRCloud", - "templateId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualMachineTemplates/HRVirtualMachineTemplate", - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "biosGuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" - }, - "osProfile": { - "computerName": "DemoVM", - "osType": "Windows", - "osSku": "Windows Server 2022", - "osVersion": "10.0.10101" - }, - "hardwareProfile": { - "memoryMB": 4196, - "cpuCount": 4 - }, - "powerState": "Running", - "provisioningState": "Succeeded" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVirtualMachineTemplate.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVirtualMachineTemplate.json deleted file mode 100644 index c131700edcd8..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVirtualMachineTemplate.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "virtualMachineTemplateName": "HRVirtualMachineTemplate" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualMachineTemplates/HRVirtualMachineTemplate", - "name": "HRVirtualMachineTemplate", - "type": "Microsoft.SCVMM/VirtualMachineTemplates", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "osType": "Windows", - "osName": "Windows OS", - "computerName": "DemoVM", - "cpuCount": 1, - "memoryMB": 1024 - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVirtualNetwork.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVirtualNetwork.json deleted file mode 100644 index d3ba35c38d2e..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVirtualNetwork.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "virtualNetworkName": "HRVirtualNetwork" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualNetworks/HRVirtualNetwork", - "name": "HRVirtualNetwork", - "type": "Microsoft.SCVMM/VirtualNetworks", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "networkName": "HRVirtualNetwork", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVmInstanceHybridIdentityMetadata.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVmInstanceHybridIdentityMetadata.json deleted file mode 100644 index da65322f9af3..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GetVmInstanceHybridIdentityMetadata.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.SCVMM/VirtualMachineInstances/default/hybridIdentityMetadata/default", - "name": "testItem", - "type": "Microsoft.SCVMM/VirtualMachineInstances/hybridIdentityMetadata", - "properties": { - "resourceUid": "f8b82dff-38ef-4220-99ef-d3a3f86ddc6c", - "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" - } - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Create_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..e9b7586788ff --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Create_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "GuestAgents_Create_MaximumSet", + "operationId": "GuestAgents_Create", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "resource": { + "properties": { + "credentials": { + "username": "jqxuwirrcpfv", + "password": "gkvbnmuahumuoibvscoxzfdqwvfuf" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Create_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..0d57f62ac1a8 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Create_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "GuestAgents_Create_MinimumSet", + "operationId": "GuestAgents_Create", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "resource": {} + }, + "responses": { + "200": { + "body": {} + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": {} + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a9e4037d29b5 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Delete_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "GuestAgents_Delete_MaximumSet", + "operationId": "GuestAgents_Delete", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..2b89999988ad --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Delete_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "GuestAgents_Delete_MinimumSet", + "operationId": "GuestAgents_Delete", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..afdabdde6430 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "GuestAgents_Get_MaximumSet", + "operationId": "GuestAgents_Get", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..742ec90dbdbe --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_Get_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "title": "GuestAgents_Get_MinimumSet", + "operationId": "GuestAgents_Get", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json new file mode 100644 index 000000000000..6db4dd3489f8 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "GuestAgents_ListByVirtualMachineInstance_MaximumSet", + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json new file mode 100644 index 000000000000..5174653b5e03 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "GuestAgents_ListByVirtualMachineInstance_MinimumSet", + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/HybridIdentityMetadata_ListByVmInstance.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/HybridIdentityMetadata_ListByVmInstance.json deleted file mode 100644 index 23d38af0a006..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/HybridIdentityMetadata_ListByVmInstance.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.SCVMM/VirtualMachineInstances/default/hybridIdentityMetadata/default", - "name": "testItem", - "type": "Microsoft.SCVMM/VirtualMachineInstances/hybridIdentityMetadata", - "properties": { - "resourceUid": "f8b82dff-38ef-4220-99ef-d3a3f86ddc6c", - "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Create_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..2d5b6d36d638 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Create_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "InventoryItems_Create_MaximumSet", + "operationId": "InventoryItems_Create", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "O", + "inventoryItemResourceName": "1BdDc2Ab-bDd9-Ebd6-bfdb-C0dbbdB5DEDf", + "resource": { + "properties": { + "inventoryType": "InventoryItemProperties" + }, + "kind": "M\\d_,V." + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "body": { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Create_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..82a0e9acf2e3 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Create_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "InventoryItems_Create_MinimumSet", + "operationId": "InventoryItems_Create", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": ".", + "inventoryItemResourceName": "bbFb0cBb-50ce-4bfc-3eeD-bC26AbCC257a", + "resource": {} + }, + "responses": { + "200": { + "body": {} + }, + "201": { + "body": {} + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..cb9c6e73d3f1 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "InventoryItems_Delete_MaximumSet", + "operationId": "InventoryItems_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "b", + "inventoryItemResourceName": "EcECadfd-Eaaa-e5Ce-ebdA-badeEd3c6af1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..83f5ba5a2a06 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Delete_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "InventoryItems_Delete_MinimumSet", + "operationId": "InventoryItems_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "_", + "inventoryItemResourceName": "cDBcbae6-BC3d-52fe-CedC-7eFeaBFabb82" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..85b101b44afe --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Get_MaximumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "title": "InventoryItems_Get_MaximumSet", + "operationId": "InventoryItems_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "1", + "inventoryItemResourceName": "2bFBede6-EEf8-becB-dBbd-B96DbBFdB3f3" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..bbddea0d16c4 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "InventoryItems_Get_MinimumSet", + "operationId": "InventoryItems_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "_", + "inventoryItemResourceName": "cacb8Ceb-efAC-bebb-ae7C-dec8C5Bb7100" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_ListByVmmServer_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_ListByVmmServer_MaximumSet_Gen.json new file mode 100644 index 000000000000..9bb19122499d --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_ListByVmmServer_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "InventoryItems_ListByVmmServer_MaximumSet", + "operationId": "InventoryItems_ListByVmmServer", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "X" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_ListByVmmServer_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_ListByVmmServer_MinimumSet_Gen.json new file mode 100644 index 000000000000..8399a4d90fec --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/InventoryItems_ListByVmmServer_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "InventoryItems_ListByVmmServer_MinimumSet", + "operationId": "InventoryItems_ListByVmmServer", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "H" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListAvailabilitySetsByResourceGroup.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListAvailabilitySetsByResourceGroup.json deleted file mode 100644 index a2f78dff3858..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListAvailabilitySetsByResourceGroup.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/AvailabilitySets/HRAvailabilitySet", - "name": "HRAvailabilitySet", - "type": "Microsoft.ScVmm/AvailabilitySets", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/VMMServers/ContosoVMMServer", - "availabilitySetName": "hr-avset", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListAvailabilitySetsBySubscription.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListAvailabilitySetsBySubscription.json deleted file mode 100644 index bfbb304b2244..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListAvailabilitySetsBySubscription.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/AvailabilitySets/HRAvailabilitySet", - "name": "HRAvailabilitySet", - "type": "Microsoft.ScVmm/AvailabilitySets", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/VMMServers/ContosoVMMServer", - "availabilitySetName": "hr-avset", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListCloudsByResourceGroup.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListCloudsByResourceGroup.json deleted file mode 100644 index 0e5991784f2b..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListCloudsByResourceGroup.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/HRCloud", - "name": "HRCloud", - "type": "Microsoft.SCVMM/Clouds", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "cloudName": "HRCloud", - "cloudCapacity": { - "cpuCount": 10, - "memoryMB": 10240, - "vmCount": 10 - } - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListCloudsBySubscription.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListCloudsBySubscription.json deleted file mode 100644 index 1bff15a10a46..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListCloudsBySubscription.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/HRCloud", - "name": "HRCloud", - "type": "Microsoft.SCVMM/Clouds", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "cloudName": "HRCloud", - "cloudCapacity": { - "cpuCount": 10, - "memoryMB": 10240, - "vmCount": 10 - } - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListInventoryItemsByVMMServer.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListInventoryItemsByVMMServer.json deleted file mode 100644 index 6be4d81fd38f..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListInventoryItemsByVMMServer.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "vmmServerName": "ContosoVMMServer" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "name": "12345678-1234-1234-1234-123456789abc", - "type": "Microsoft.SCVMM/VMMServers/InventoryItems", - "properties": { - "inventoryType": "Cloud", - "managedResourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/contoso-cloud", - "inventoryItemName": "contoso-cloud", - "uuid": "12345678-1234-1234-1234-123456789abc", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListOperations.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListOperations.json deleted file mode 100644 index 7b00dafb89d6..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListOperations.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.ScVmm/VmmServers/Read", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "VmmServers", - "operation": "Gets/List VmmServer resources.", - "description": "Gets/List the VmmServer resource data." - } - }, - { - "name": "Microsoft.ScVmm/VmmServers/Write", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "VmmServers", - "operation": "Create or Update VmmServer resource.", - "description": "Read VmmServer." - } - }, - { - "name": "Microsoft.ScVmm/VmmServers/Delete", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "VmmServers", - "operation": "Deletes the VmmServer resource.", - "description": "Deletes the VmmServer resource." - } - }, - { - "name": "Microsoft.ScVmm/Clouds/Read", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "Clouds", - "operation": "Gets/List Cloud resources.", - "description": "Gets/List the Cloud resource data." - } - }, - { - "name": "Microsoft.ScVmm/Clouds/Write", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "Clouds", - "operation": "Create or Update Cloud resource.", - "description": "Create or Update Cloud resource data." - } - }, - { - "name": "Microsoft.ScVmm/Clouds/Delete", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "Clouds", - "operation": "Deletes the Cloud resource.", - "description": "Deletes the Cloud resource." - } - }, - { - "name": "Microsoft.ScVmm/VirtualNetworks/Read", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "VirtualNetworks", - "operation": "Gets/List VirtualNetwork resources.", - "description": "Gets/List the VirtualNetwork resource data." - } - }, - { - "name": "Microsoft.ScVmm/VirtualNetworks/Write", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "VirtualNetworks", - "operation": "Create or Update VirtualNetwork resource.", - "description": "Create or Update VirtualNetwork resource data." - } - }, - { - "name": "Microsoft.ScVmm/VirtualNetworks/Delete", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "VirtualNetworks", - "operation": "Deletes the VirtualNetwork resource.", - "description": "Deletes the VirtualNetwork resource." - } - }, - { - "name": "Microsoft.ScVmm/VirtualMachineTemplates/Read", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "VirtualMachineTemplates", - "operation": "Gets/List VirtualMachineTemplate resources.", - "description": "Gets/List the VirtualMachineTemplate resource data." - } - }, - { - "name": "Microsoft.ScVmm/VirtualMachineTemplates/Write", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "VirtualMachineTemplates", - "operation": "Create or Update VirtualMachineTemplate resource.", - "description": "Create or Update VirtualMachineTemplate resource data." - } - }, - { - "name": "Microsoft.ScVmm/VirtualMachineTemplates/Delete", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "VirtualMachineTemplates", - "operation": "Deletes the VirtualMachineTemplate resource.", - "description": "Deletes the VirtualMachineTemplate resource." - } - }, - { - "name": "Microsoft.ScVmm/VirtualMachines/Read", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "VirtualMachines", - "operation": "Gets/List VirtualMachine resources.", - "description": "Gets/List the VirtualMachine resource data." - } - }, - { - "name": "Microsoft.ScVmm/VirtualMachines/Write", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "VirtualMachines", - "operation": "Create or Update VirtualMachine resource.", - "description": "Create or Update VirtualMachine resource data." - } - }, - { - "name": "Microsoft.ScVmm/VirtualMachines/Delete", - "display": { - "provider": "Microsoft.ScVmm resource provider", - "resource": "VirtualMachines", - "operation": "Deletes the VirtualMachine resource.", - "description": "Deletes the VirtualMachine resource." - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVMMServersByResourceGroup.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVMMServersByResourceGroup.json deleted file mode 100644 index 50c22fb14b2c..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVMMServersByResourceGroup.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "name": "ContosoVMMServer", - "type": "Microsoft.SCVMM/VMMServers", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "fqdn": "VMM.contoso.com", - "port": 1234, - "connectionStatus": "Connected", - "uuid": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "version": "2.0", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVMMServersBySubscription.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVMMServersBySubscription.json deleted file mode 100644 index de82e88ab96b..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVMMServersBySubscription.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "name": "ContosoVMMServer", - "type": "Microsoft.SCVMM/VMMServers", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "fqdn": "VMM.contoso.com", - "port": 1234, - "connectionStatus": "Connected", - "uuid": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "version": "2.0", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualMachineInstances.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualMachineInstances.json deleted file mode 100644 index 8d5b84a8f840..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualMachineInstances.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.ScVmm/virtualMachineInstances/default", - "name": "default", - "type": "Microsoft.ScVmm/VirtualMachineInstances", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso" - }, - "properties": { - "infrastructureProfile": { - "cloudId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/HRCloud", - "templateId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualMachineTemplates/HRVirtualMachineTemplate", - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "biosGuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" - }, - "osProfile": { - "computerName": "DemoVM", - "osType": "Windows", - "osSku": "Windows Server 2022", - "osVersion": "10.0.10101" - }, - "hardwareProfile": { - "memoryMB": 4196, - "cpuCount": 4 - }, - "powerState": "Running", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualMachineTemplatesByResourceGroup.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualMachineTemplatesByResourceGroup.json deleted file mode 100644 index c96d0f09f268..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualMachineTemplatesByResourceGroup.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualMachineTemplates/HRVirtualMachineTemplate", - "name": "HRVirtualMachineTemplate", - "type": "Microsoft.SCVMM/VirtualMachineTemplates", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "osType": "Windows", - "osName": "Windows OS", - "computerName": "DemoVM", - "cpuCount": 1, - "memoryMB": 1024 - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualMachineTemplatesBySubscription.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualMachineTemplatesBySubscription.json deleted file mode 100644 index 84c1792f0ebd..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualMachineTemplatesBySubscription.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualMachineTemplates/HRVirtualMachineTemplate", - "name": "HRVirtualMachineTemplate", - "type": "Microsoft.SCVMM/VirtualMachineTemplates", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "osType": "Windows", - "osName": "Windows OS", - "computerName": "DemoVM", - "cpuCount": 1, - "memoryMB": 1024 - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualNetworksByResourceGroup.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualNetworksByResourceGroup.json deleted file mode 100644 index 571886a83836..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualNetworksByResourceGroup.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualNetworks/HRVirtualNetwork", - "name": "HRVirtualNetwork", - "type": "Microsoft.SCVMM/VirtualNetworks", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "networkName": "HRVirtualNetwork", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc" - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualNetworksBySubscription.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualNetworksBySubscription.json deleted file mode 100644 index e459967fdd8b..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/ListVirtualNetworksBySubscription.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualNetworks/HRVirtualNetwork", - "name": "HRVirtualNetwork", - "type": "Microsoft.SCVMM/VirtualNetworks", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "networkName": "HRVirtualNetwork", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc" - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Operations_List_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..e5589330f554 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List_MaximumSet", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-10-07" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rieknsh", + "isDataAction": true, + "display": { + "provider": "avkabpzrbafrbnubspbrsippj", + "resource": "qojushhvjhkwwmboofogcky", + "operation": "v", + "description": "fmwevntnynhgzoksqpjidn" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Operations_List_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..daa59bb54c11 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MinimumSet", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-10-07" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/RestartVirtualMachineInstance.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/RestartVirtualMachineInstance.json deleted file mode 100644 index 3da1368e1980..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/RestartVirtualMachineInstance.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ScVmm/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/RestoreCheckpointVirtualMachineInstance.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/RestoreCheckpointVirtualMachineInstance.json deleted file mode 100644 index 326344db7c80..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/RestoreCheckpointVirtualMachineInstance.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", - "body": { - "id": "Demo CheckpointID" - } - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ScVmm/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/StartVirtualMachineInstance.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/StartVirtualMachineInstance.json deleted file mode 100644 index 3da1368e1980..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/StartVirtualMachineInstance.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ScVmm/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/StopVirtualMachineInstance.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/StopVirtualMachineInstance.json deleted file mode 100644 index 70cd9dec7e95..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/StopVirtualMachineInstance.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", - "body": { - "skipShutdown": "true" - } - }, - "responses": { - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ScVmm/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateAvailabilitySet.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateAvailabilitySet.json deleted file mode 100644 index 95be09594af3..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateAvailabilitySet.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "availabilitySetResourceName": "HRAvailabilitySet", - "body": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/AvailabilitySets/HRAvailabilitySet", - "name": "HRAvailabilitySet", - "type": "Microsoft.ScVmm/AvailabilitySets", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ScVmm/VMMServers/ContosoVMMServer", - "availabilitySetName": "hr-avset", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.SCVMM/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateCloud.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateCloud.json deleted file mode 100644 index 697d7d8721ab..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateCloud.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "cloudResourceName": "HRCloud", - "body": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/HRCloud", - "name": "HRCloud", - "type": "Microsoft.SCVMM/Clouds", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "cloudName": "HRCloud", - "cloudCapacity": { - "cpuCount": 10, - "memoryMB": 10240, - "vmCount": 10 - } - } - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.SCVMM/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVMMServer.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVMMServer.json deleted file mode 100644 index 6299a0a8b0df..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVMMServer.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "vmmServerName": "ContosoVMMServer", - "body": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "name": "ContosoVMMServer", - "type": "Microsoft.SCVMM/VMMServers", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "fqdn": "VMM.contoso.com", - "port": 1234, - "connectionStatus": "Connected", - "uuid": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "version": "2.0", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.SCVMM/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVirtualMachineInstance.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVirtualMachineInstance.json deleted file mode 100644 index f9f2ff80766a..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVirtualMachineInstance.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", - "body": { - "properties": { - "hardwareProfile": { - "memoryMB": 4196, - "cpuCount": 4 - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.ScVmm/virtualMachineInstances/default", - "name": "default", - "type": "Microsoft.ScVmm/VirtualMachineInstances", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso" - }, - "properties": { - "infrastructureProfile": { - "cloudId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/Clouds/HRCloud", - "templateId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualMachineTemplates/HRVirtualMachineTemplate", - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "biosGuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" - }, - "osProfile": { - "computerName": "DemoVM", - "osType": "Windows", - "osSku": "Windows Server 2022", - "osVersion": "10.0.10101" - }, - "hardwareProfile": { - "memoryMB": 4196, - "cpuCount": 4 - }, - "powerState": "Running", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ScVmm/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVirtualMachineTemplate.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVirtualMachineTemplate.json deleted file mode 100644 index 20953b9efced..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVirtualMachineTemplate.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "virtualMachineTemplateName": "HRVirtualMachineTemplate", - "body": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualMachineTemplates/HRVirtualMachineTemplate", - "name": "HRVirtualMachineTemplate", - "type": "Microsoft.SCVMM/VirtualMachineTemplates", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc", - "osType": "Windows", - "osName": "Windows OS", - "computerName": "DemoVM", - "cpuCount": 1, - "memoryMB": 1024 - } - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.SCVMM/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVirtualNetwork.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVirtualNetwork.json deleted file mode 100644 index efdf4556ef44..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/UpdateVirtualNetwork.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "virtualNetworkName": "HRVirtualNetwork", - "body": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VirtualNetworks/HRVirtualNetwork", - "name": "HRVirtualNetwork", - "type": "Microsoft.SCVMM/VirtualNetworks", - "location": "East US", - "extendedLocation": { - "type": "customLocation", - "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.Arc/customLocations/contoso" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "vmmServerId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer", - "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "provisioningState": "Succeeded", - "networkName": "HRVirtualNetwork", - "inventoryItemId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.SCVMM/VMMServers/ContosoVMMServer/InventoryItems/12345678-1234-1234-1234-123456789abc" - } - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.SCVMM/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-10-07" - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VMInstanceGuestAgent_ListByVm.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VMInstanceGuestAgent_ListByVm.json deleted file mode 100644 index a78ec8eaad89..000000000000 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VMInstanceGuestAgent_ListByVm.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "api-version": "2023-10-07", - "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", - "name": "default", - "type": "Microsoft.ScVmm/VirtualMachineInstances/guestAgents", - "properties": { - "provisioningAction": "install", - "status": "connected", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json new file mode 100644 index 000000000000..fc1ce4ecd762 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualMachineInstances_CreateCheckpoint_MaximumSet", + "operationId": "VirtualMachineInstances_CreateCheckpoint", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": { + "name": "ilvltf", + "description": "zoozhfbepldrgpjqsbhpqebtodrhvy" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json new file mode 100644 index 000000000000..fd1611ee7760 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_CreateCheckpoint_MinimumSet", + "operationId": "VirtualMachineInstances_CreateCheckpoint", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..968d99e12975 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,316 @@ +{ + "title": "VirtualMachineInstances_CreateOrUpdate_MaximumSet", + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "resource": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "adminPassword": "vavtppmmhlspydtkzxda", + "computerName": "uuxpcxuxcufllc", + "osType": "Windows" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql" + } + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql", + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "kz" + } + ] + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql", + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "kz" + } + ] + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..6c976787659b --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "VirtualMachineInstances_CreateOrUpdate_MinimumSet", + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "resource": { + "extendedLocation": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json new file mode 100644 index 000000000000..20b2970f75bf --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_DeleteCheckpoint_MaximumSet", + "operationId": "VirtualMachineInstances_DeleteCheckpoint", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": { + "id": "eenfflimcbgqfsebdusophahjpk" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json new file mode 100644 index 000000000000..da321cb1224b --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_DeleteCheckpoint_MinimumSet", + "operationId": "VirtualMachineInstances_DeleteCheckpoint", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..7ed55835440a --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_Delete_MaximumSet", + "operationId": "VirtualMachineInstances_Delete", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "force": "true", + "deleteFromHost": "true" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..0cf8953301ab --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Delete_MinimumSet", + "operationId": "VirtualMachineInstances_Delete", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a7bf57d14cc6 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Get_MaximumSet_Gen.json @@ -0,0 +1,123 @@ +{ + "title": "VirtualMachineInstances_Get_MaximumSet", + "operationId": "VirtualMachineInstances_Get", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + } + ], + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql" + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..49c8f84417cb --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Get_MinimumSet", + "operationId": "VirtualMachineInstances_Get", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_List_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..a8de59e516b3 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_List_MaximumSet_Gen.json @@ -0,0 +1,128 @@ +{ + "title": "VirtualMachineInstances_List_MaximumSet", + "operationId": "VirtualMachineInstances_List", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + } + ], + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql" + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_List_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..316d14ed91a9 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_List_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "VirtualMachineInstances_List_MinimumSet", + "operationId": "VirtualMachineInstances_List", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Restart_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Restart_MaximumSet_Gen.json new file mode 100644 index 000000000000..216d534d6466 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Restart_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Restart_MaximumSet", + "operationId": "VirtualMachineInstances_Restart", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Restart_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Restart_MinimumSet_Gen.json new file mode 100644 index 000000000000..7bd0879b55a9 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Restart_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Restart_MinimumSet", + "operationId": "VirtualMachineInstances_Restart", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json new file mode 100644 index 000000000000..c890243da685 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_RestoreCheckpoint_MaximumSet", + "operationId": "VirtualMachineInstances_RestoreCheckpoint", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": { + "id": "rweqduwzsn" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json new file mode 100644 index 000000000000..af360f1da610 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_RestoreCheckpoint_MinimumSet", + "operationId": "VirtualMachineInstances_RestoreCheckpoint", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Start_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Start_MaximumSet_Gen.json new file mode 100644 index 000000000000..37d2a02241c0 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Start_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Start_MaximumSet", + "operationId": "VirtualMachineInstances_Start", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Start_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Start_MinimumSet_Gen.json new file mode 100644 index 000000000000..d30c00876c68 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Start_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Start_MinimumSet", + "operationId": "VirtualMachineInstances_Start", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Stop_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Stop_MaximumSet_Gen.json new file mode 100644 index 000000000000..9866e8ef5ac4 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Stop_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_Stop_MaximumSet", + "operationId": "VirtualMachineInstances_Stop", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": { + "skipShutdown": "true" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Stop_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Stop_MinimumSet_Gen.json new file mode 100644 index 000000000000..c0a22fc7ced0 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Stop_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Stop_MinimumSet", + "operationId": "VirtualMachineInstances_Stop", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Update_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..8c5f5877e749 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Update_MaximumSet_Gen.json @@ -0,0 +1,179 @@ +{ + "title": "VirtualMachineInstances_Update_MaximumSet", + "operationId": "VirtualMachineInstances_Update", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "properties": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30 + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + } + } + ] + }, + "infrastructureProfile": { + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql", + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "kz" + } + ] + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Update_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..6a65796f568c --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineInstances_Update_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VirtualMachineInstances_Update_MinimumSet", + "operationId": "VirtualMachineInstances_Update", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {} + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..a3f6ec893749 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,197 @@ +{ + "title": "VirtualMachineTemplates_CreateOrUpdate_MaximumSet", + "operationId": "VirtualMachineTemplates_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "6", + "resource": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "isHighlyAvailable": "true" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..54070d1cf5b4 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "VirtualMachineTemplates_CreateOrUpdate_MinimumSet", + "operationId": "VirtualMachineTemplates_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "P", + "resource": { + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..b3c7aa4c905e --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualMachineTemplates_Delete_MaximumSet", + "operationId": "VirtualMachineTemplates_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "virtualMachineTemplateName": "6" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..57b7122c4b08 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineTemplates_Delete_MinimumSet", + "operationId": "VirtualMachineTemplates_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "5" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b809f2656a43 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Get_MaximumSet_Gen.json @@ -0,0 +1,93 @@ +{ + "title": "VirtualMachineTemplates_Get_MaximumSet", + "operationId": "VirtualMachineTemplates_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "4" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..a826574c701e --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualMachineTemplates_Get_MinimumSet", + "operationId": "VirtualMachineTemplates_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "m" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..d854b51c91ea --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "VirtualMachineTemplates_ListByResourceGroup_MaximumSet", + "operationId": "VirtualMachineTemplates_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/atbdyyso" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..74d2d4c5a6e1 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VirtualMachineTemplates_ListByResourceGroup_MinimumSet", + "operationId": "VirtualMachineTemplates_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..38a7b033562a --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,96 @@ +{ + "title": "VirtualMachineTemplates_ListBySubscription_MaximumSet", + "operationId": "VirtualMachineTemplates_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/atbdyyso" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..d49da9a65cd3 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VirtualMachineTemplates_ListBySubscription_MinimumSet", + "operationId": "VirtualMachineTemplates_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Update_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..e5628d59c929 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Update_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "VirtualMachineTemplates_Update_MaximumSet", + "operationId": "VirtualMachineTemplates_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "g", + "properties": { + "tags": { + "key6634": "wwfhrg" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Update_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..b2b31acbe444 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualMachineTemplates_Update_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "VirtualMachineTemplates_Update_MinimumSet", + "operationId": "VirtualMachineTemplates_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "-", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..2f9bea0d4f22 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "title": "VirtualNetworks_CreateOrUpdate_MaximumSet", + "operationId": "VirtualNetworks_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "_", + "resource": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..19e0de45672e --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "VirtualNetworks_CreateOrUpdate_MinimumSet", + "operationId": "VirtualNetworks_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "-", + "resource": { + "extendedLocation": {}, + "location": "fky" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..800f8ca90845 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualNetworks_Delete_MaximumSet", + "operationId": "VirtualNetworks_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "virtualNetworkName": "." + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..224da31900a6 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualNetworks_Delete_MinimumSet", + "operationId": "VirtualNetworks_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "1" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..aaf6e2a31161 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "VirtualNetworks_Get_MaximumSet", + "operationId": "VirtualNetworks_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "2" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..5ca1b434b8d7 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualNetworks_Get_MinimumSet", + "operationId": "VirtualNetworks_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "-" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..b2c4a8d7b727 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "VirtualNetworks_ListByResourceGroup_MaximumSet", + "operationId": "VirtualNetworks_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..a4aa344196c0 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VirtualNetworks_ListByResourceGroup_MinimumSet", + "operationId": "VirtualNetworks_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..a196e4d38860 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "VirtualNetworks_ListBySubscription_MaximumSet", + "operationId": "VirtualNetworks_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..92556f56363b --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VirtualNetworks_ListBySubscription_MinimumSet", + "operationId": "VirtualNetworks_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Update_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..fdc685c5710d --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Update_MaximumSet_Gen.json @@ -0,0 +1,52 @@ +{ + "title": "VirtualNetworks_Update_MaximumSet", + "operationId": "VirtualNetworks_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "S", + "properties": { + "tags": { + "key9516": "oxduo" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Update_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..8ea701da7b35 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VirtualNetworks_Update_MinimumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "VirtualNetworks_Update_MinimumSet", + "operationId": "VirtualNetworks_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "-", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8651dc85a156 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_Get_MaximumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_Get", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "properties": { + "resourceUid": "mikbntobifeiouinvsalnu", + "publicKey": "hijhfxcdjuzidfjjztoh", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default", + "name": "rxvpcegqc", + "type": "ixqhymswessvylnqgti", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..94920ce51700 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_Get_MinimumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_Get", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json new file mode 100644 index 000000000000..8e2d4776e0d8 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "resourceUid": "mikbntobifeiouinvsalnu", + "publicKey": "hijhfxcdjuzidfjjztoh", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default", + "name": "rxvpcegqc", + "type": "ixqhymswessvylnqgti", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json new file mode 100644 index 000000000000..cb06143e83ce --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2023-10-07", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb3f5c2817a4 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "VmmServers_CreateOrUpdate_MaximumSet", + "operationId": "VmmServers_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "-", + "resource": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi", + "password": "gaecsnkjr" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4 + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..713b3b0a9670 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "VmmServers_CreateOrUpdate_MinimumSet", + "operationId": "VmmServers_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "w", + "resource": { + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..cbfacb829d81 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VmmServers_Delete_MaximumSet", + "operationId": "VmmServers_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "vmmServerName": "." + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..35fef81e6cd5 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VmmServers_Delete_MinimumSet", + "operationId": "VmmServers_Delete", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "8" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..cf34a571f852 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Get_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "VmmServers_Get_MaximumSet", + "operationId": "VmmServers_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "." + }, + "responses": { + "200": { + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..e824ad8ddf26 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VmmServers_Get_MinimumSet", + "operationId": "VmmServers_Get", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "D" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..cf469f65ae64 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "VmmServers_ListByResourceGroup_MaximumSet", + "operationId": "VmmServers_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..fca767a96354 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VmmServers_ListByResourceGroup_MinimumSet", + "operationId": "VmmServers_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..aa5e07d5c9e8 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "VmmServers_ListBySubscription_MaximumSet", + "operationId": "VmmServers_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..109cb8b8d48a --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VmmServers_ListBySubscription_MinimumSet", + "operationId": "VmmServers_ListBySubscription", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Update_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb5afd132f00 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Update_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "VmmServers_Update_MaximumSet", + "operationId": "VmmServers_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "Y", + "properties": { + "tags": { + "key7187": "oktnfvklfchnquelzzdagtpwfskzc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Update_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..b5d077a0f7a5 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/examples/VmmServers_Update_MinimumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "VmmServers_Update_MinimumSet", + "operationId": "VmmServers_Update", + "parameters": { + "api-version": "2023-10-07", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "_", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} 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 c08d6332e368..bc3f2a2f3c66 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 @@ -1,18 +1,23 @@ { "swagger": "2.0", "info": { - "title": "SCVMM", + "title": "ScVmm", + "version": "2023-10-07", "description": "The Microsoft.ScVmm Rest API spec.", - "version": "2023-10-07" + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] }, - "host": "management.azure.com", "schemes": [ "https" ], - "consumes": [ + "host": "management.azure.com", + "produces": [ "application/json" ], - "produces": [ + "consumes": [ "application/json" ], "security": [ @@ -25,385 +30,500 @@ "securityDefinitions": { "azure_auth": { "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", "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": "VmmServers" + }, + { + "name": "Clouds" + }, + { + "name": "VirtualNetworks" + }, + { + "name": "VirtualMachineTemplates" + }, + { + "name": "AvailabilitySets" + }, + { + "name": "InventoryItems" + }, + { + "name": "VirtualMachineInstances" + }, + { + "name": "VmInstanceHybridIdentityMetadatas" + }, + { + "name": "GuestAgents" + } + ], "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}": { + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances": { "get": { + "operationId": "VirtualMachineInstances_List", "tags": [ - "VmmServers" + "VirtualMachineInstances" ], - "operationId": "VmmServers_Get", - "summary": "Gets a VMMServer.", - "description": "Implements VMMServer GET method.", - "x-ms-examples": { - "GetVMMServer": { - "$ref": "./examples/GetVMMServer.json" - } - }, + "summary": "Implements List virtual machine instances.", + "description": "Lists all of the virtual machine instances within the specified parent resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceListResult" + } }, - { - "in": "path", - "name": "vmmServerName", - "required": true, - "type": "string", - "description": "Name of the VMMServer.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineInstances_List_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_List_MaximumSet_Gen.json" }, + "VirtualMachineInstances_List_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_List_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default": { + "get": { + "operationId": "VirtualMachineInstances_Get", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Gets a virtual machine.", + "description": "Retrieves information about a virtual machine instance.", + "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" } ], "responses": { "200": { - "description": "Retrieves the VmmServers resource.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VMMServer" + "$ref": "#/definitions/VirtualMachineInstance" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "VirtualMachineInstances_Get_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_Get_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_Get_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_Get_MinimumSet_Gen.json" + } } }, "put": { + "operationId": "VirtualMachineInstances_CreateOrUpdate", "tags": [ - "VmmServers" + "VirtualMachineInstances" ], - "operationId": "VmmServers_CreateOrUpdate", - "description": "Onboards the SCVMM fabric as an Azure VmmServer resource.", - "summary": "Implements VmmServers PUT method.", - "x-ms-examples": { - "CreateVMMServer": { - "$ref": "./examples/CreateVMMServer.json" - } - }, + "summary": "Implements virtual machine PUT method.", + "description": "The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { - "in": "path", - "name": "vmmServerName", + "name": "resource", + "in": "body", + "description": "Resource create parameters.", "required": true, - "type": "string", - "description": "Name of the VMMServer.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualMachineInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "201": { + "description": "Resource 'VirtualMachineInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + }, + "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": { + "VirtualMachineInstances_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json" }, + "VirtualMachineInstances_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualMachineInstances_Update", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Updates a virtual machine.", + "description": "The operation to update a virtual machine instance.", + "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "name": "body", - "description": "Request payload.", + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "properties", "in": "body", + "description": "The resource properties to be updated.", "required": true, "schema": { - "$ref": "#/definitions/VMMServer" + "$ref": "#/definitions/VirtualMachineInstanceUpdate" } } ], "responses": { "200": { - "description": "Creates or Updates the VmmServers resource.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VMMServer" + "$ref": "#/definitions/VirtualMachineInstance" } }, - "201": { - "description": "Creates or Updates the VmmServers resource.", - "schema": { - "$ref": "#/definitions/VMMServer" + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineInstances_Update_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_Update_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_Update_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_Update_MinimumSet_Gen.json" + } + }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" - } + }, + "x-ms-long-running-operation": true }, "delete": { + "operationId": "VirtualMachineInstances_Delete", "tags": [ - "VmmServers" + "VirtualMachineInstances" ], - "operationId": "VmmServers_Delete", - "description": "Removes the SCVMM fabric from Azure.", - "summary": "Implements VmmServers DELETE method.", - "x-ms-examples": { - "DeleteVMMServer": { - "$ref": "./examples/DeleteVMMServer.json" - } - }, + "summary": "Deletes an virtual machine.", + "description": "The operation to delete a virtual machine instance.", "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" }, { - "in": "path", - "name": "vmmServerName", - "required": true, - "type": "string", - "description": "Name of the VMMServer.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/QueryForceDelete" }, { + "name": "deleteFromHost", "in": "query", - "name": "force", - "description": "Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too.", + "description": "Whether to disable the VM from azure and also delete it from Vmm.", "required": false, "type": "string", "enum": [ - "false", - "true" + "true", + "false" ], "x-ms-enum": { + "name": "DeleteFromHost", "modelAsString": true, - "name": "Force" + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable delete from host." + }, + { + "name": "false", + "value": "false", + "description": "Disable delete from host." + } + ] } } ], "responses": { "202": { - "description": "Accepted", + "description": "Resource deletion accepted.", "headers": { "Location": { - "type": "string" + "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": "No Content" + "description": "Resource does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineInstances_Delete_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_Delete_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_Delete_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_Delete_MinimumSet_Gen.json" + } + }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" - } - }, - "patch": { + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/createCheckpoint": { + "post": { + "operationId": "VirtualMachineInstances_CreateCheckpoint", "tags": [ - "VmmServers" + "VirtualMachineInstances" ], - "operationId": "VmmServers_Update", - "summary": "Implements VmmServers PATCH method.", - "description": "Updates the VmmServers resource.", - "x-ms-examples": { - "UpdateVMMServer": { - "$ref": "./examples/UpdateVMMServer.json" - } - }, + "summary": "Implements the operation to creates a checkpoint in a virtual machine instance.", + "description": "Creates a checkpoint in virtual machine instance.", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "in": "path", - "name": "vmmServerName", - "required": true, - "type": "string", - "description": "Name of the VMMServer.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "body", - "description": "VmmServers patch payload.", "in": "body", + "description": "The content of the action request", "required": true, "schema": { - "$ref": "#/definitions/ResourcePatch" + "$ref": "#/definitions/VirtualMachineCreateCheckpoint" } } ], "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/VMMServer" - } - }, "202": { - "description": "Accepted", + "description": "Resource operation accepted.", "headers": { "Location": { - "type": "string" + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineInstances_CreateCheckpoint_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_CreateCheckpoint_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json" + } + }, "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } + "final-state-via": "location" + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers": { - "get": { + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/deleteCheckpoint": { + "post": { + "operationId": "VirtualMachineInstances_DeleteCheckpoint", "tags": [ - "VmmServers" + "VirtualMachineInstances" ], - "operationId": "VmmServers_ListByResourceGroup", - "summary": "Implements GET VmmServers in a resource group.", - "description": "List of VmmServers in a resource group.", - "x-ms-examples": { - "ListVmmServersByResourceGroup": { - "$ref": "./examples/ListVMMServersByResourceGroup.json" - } - }, + "summary": "Implements the operation to delete a checkpoint in a virtual machine instance.", + "description": "Deletes a checkpoint in virtual machine instance.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineDeleteCheckpoint" + } } ], "responses": { - "200": { - "description": "Lists all VmmServers under the resource group.", - "schema": { - "$ref": "#/definitions/VMMServerListResult" + "202": { + "description": "Resource operation 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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } + "x-ms-examples": { + "VirtualMachineInstances_DeleteCheckpoint_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_DeleteCheckpoint_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/vmmServers": { + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents": { "get": { + "operationId": "GuestAgents_ListByVirtualMachineInstance", "tags": [ - "VmmServers" + "GuestAgents" ], - "operationId": "VmmServers_ListBySubscription", - "summary": "Implements GET VmmServers in a subscription.", - "description": "List of VmmServers in a subscription.", - "x-ms-examples": { - "ListVmmServersBySubscription": { - "$ref": "./examples/ListVMMServersBySubscription.json" - } - }, + "summary": "Implements GET GuestAgent in a vm.", + "description": "Returns the list of GuestAgent of the given vm.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" } ], "responses": { "200": { - "description": "Lists all VmmServers under the subscription.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VMMServerListResult" + "$ref": "#/definitions/GuestAgentListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ScVmm/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "description": "Returns list of all operations.", "x-ms-examples": { - "ListOperations": { - "$ref": "./examples/ListOperations.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Describe the result of a successful operation.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" - } + "GuestAgents_ListByVirtualMachineInstance_MaximumSet": { + "$ref": "./examples/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } + "GuestAgents_ListByVirtualMachineInstance_MinimumSet": { + "$ref": "./examples/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json" } }, "x-ms-pageable": { @@ -411,1024 +531,752 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/clouds/{cloudResourceName}": { + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default": { "get": { + "operationId": "GuestAgents_Get", "tags": [ - "Clouds" + "GuestAgents" ], - "operationId": "Clouds_Get", - "summary": "Gets a Cloud.", - "description": "Implements Cloud GET method.", - "x-ms-examples": { - "GetCloud": { - "$ref": "./examples/GetCloud.json" - } - }, + "summary": "Gets GuestAgent.", + "description": "Implements GuestAgent GET method.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "in": "path", - "name": "cloudResourceName", - "required": true, - "type": "string", - "description": "Name of the Cloud.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" } ], "responses": { "200": { - "description": "Retrieves the Clouds resource.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/Cloud" + "$ref": "#/definitions/GuestAgent" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "GuestAgents_Get_MaximumSet": { + "$ref": "./examples/GuestAgents_Get_MaximumSet_Gen.json" + }, + "GuestAgents_Get_MinimumSet": { + "$ref": "./examples/GuestAgents_Get_MinimumSet_Gen.json" + } } }, "put": { + "operationId": "GuestAgents_Create", "tags": [ - "Clouds" + "GuestAgents" ], - "operationId": "Clouds_CreateOrUpdate", - "description": "Onboards the ScVmm fabric cloud as an Azure cloud resource.", - "summary": "Implements Clouds PUT method.", - "x-ms-examples": { - "CreateCloud": { - "$ref": "./examples/CreateCloud.json" - } - }, + "summary": "Implements GuestAgent PUT method.", + "description": "Create Or Update GuestAgent.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "in": "path", - "name": "cloudResourceName", - "required": true, - "type": "string", - "description": "Name of the Cloud.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { - "name": "body", - "description": "Request payload.", + "name": "resource", "in": "body", + "description": "Resource create parameters.", "required": true, "schema": { - "$ref": "#/definitions/Cloud" + "$ref": "#/definitions/GuestAgent" } } ], "responses": { "200": { - "description": "Creates or Updates the Clouds resource.", + "description": "Resource 'GuestAgent' update operation succeeded", "schema": { - "$ref": "#/definitions/Cloud" + "$ref": "#/definitions/GuestAgent" } }, "201": { - "description": "Creates or Updates the Clouds resource.", + "description": "Resource 'GuestAgent' create operation succeeded", "schema": { - "$ref": "#/definitions/Cloud" + "$ref": "#/definitions/GuestAgent" + }, + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "GuestAgents_Create_MaximumSet": { + "$ref": "./examples/GuestAgents_Create_MaximumSet_Gen.json" + }, + "GuestAgents_Create_MinimumSet": { + "$ref": "./examples/GuestAgents_Create_MinimumSet_Gen.json" + } + }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" - } + }, + "x-ms-long-running-operation": true }, "delete": { + "operationId": "GuestAgents_Delete", "tags": [ - "Clouds" + "GuestAgents" ], - "operationId": "Clouds_Delete", - "description": "Deregisters the ScVmm fabric cloud from Azure.", - "summary": "Implements Cloud resource DELETE method.", - "x-ms-examples": { - "DeleteCloud": { - "$ref": "./examples/DeleteCloud.json" - } - }, + "summary": "Deletes a GuestAgent resource.", + "description": "Implements GuestAgent DELETE method.", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "in": "path", - "name": "cloudResourceName", - "required": true, - "type": "string", - "description": "Name of the Cloud.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "force", - "description": "Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too.", - "required": false, - "type": "string", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "Force" - } + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" } ], "responses": { - "202": { - "description": "Accepted", - "headers": { - "Location": { - "type": "string" - } - } + "200": { + "description": "Resource deleted successfully." }, "204": { - "description": "No Content" + "description": "Resource does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "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": { + "GuestAgents_Delete_MaximumSet": { + "$ref": "./examples/GuestAgents_Delete_MaximumSet_Gen.json" + }, + "GuestAgents_Delete_MinimumSet": { + "$ref": "./examples/GuestAgents_Delete_MinimumSet_Gen.json" + } } - }, - "patch": { + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata": { + "get": { + "operationId": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance", "tags": [ - "Clouds" + "VmInstanceHybridIdentityMetadatas" ], - "operationId": "Clouds_Update", - "summary": "Implements the Clouds PATCH method.", - "description": "Updates the Clouds resource.", - "x-ms-examples": { - "UpdateCloud": { - "$ref": "./examples/UpdateCloud.json" - } - }, + "summary": "Implements GET HybridIdentityMetadata in a vm.", + "description": "Returns the list of HybridIdentityMetadata of the given VM.", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "in": "path", - "name": "cloudResourceName", - "required": true, - "type": "string", - "description": "Name of the Cloud.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 - }, - { - "name": "body", - "description": "Clouds patch payload.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ResourcePatch" - } + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" } ], "responses": { "200": { - "description": "Successful.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/Cloud" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "type": "string" - } + "$ref": "#/definitions/VmInstanceHybridIdentityMetadataListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "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": { + "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet": { + "$ref": "./examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json" + }, + "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet": { + "$ref": "./examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/clouds": { + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default": { "get": { + "operationId": "VmInstanceHybridIdentityMetadatas_Get", "tags": [ - "Clouds" + "VmInstanceHybridIdentityMetadatas" ], - "operationId": "Clouds_ListByResourceGroup", - "summary": "Implements GET Clouds in a resource group.", - "description": "List of Clouds in a resource group.", - "x-ms-examples": { - "ListCloudsByResourceGroup": { - "$ref": "./examples/ListCloudsByResourceGroup.json" - } - }, + "summary": "Gets HybridIdentityMetadata.", + "description": "Implements HybridIdentityMetadata GET method.", "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": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" } ], "responses": { "200": { - "description": "Lists all Clouds under the resource group.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/CloudListResult" + "$ref": "#/definitions/VmInstanceHybridIdentityMetadata" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-examples": { + "VmInstanceHybridIdentityMetadatas_Get_MaximumSet": { + "$ref": "./examples/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json" + }, + "VmInstanceHybridIdentityMetadatas_Get_MinimumSet": { + "$ref": "./examples/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json" + } } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/clouds": { - "get": { + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/restart": { + "post": { + "operationId": "VirtualMachineInstances_Restart", "tags": [ - "Clouds" + "VirtualMachineInstances" ], - "operationId": "Clouds_ListBySubscription", - "summary": "Implements GET Clouds in a subscription.", - "description": "List of Clouds in a subscription.", - "x-ms-examples": { - "ListCloudsBySubscription": { - "$ref": "./examples/ListCloudsBySubscription.json" - } - }, + "summary": "Implements the operation to restart a virtual machine.", + "description": "The operation to restart a virtual machine instance.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" } ], "responses": { - "200": { - "description": "Lists all Clouds under the subscription.", - "schema": { - "$ref": "#/definitions/CloudListResult" + "202": { + "description": "Resource operation 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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualNetworks/{virtualNetworkName}": { - "get": { - "tags": [ - "VirtualNetworks" - ], - "operationId": "VirtualNetworks_Get", - "summary": "Gets a VirtualNetwork.", - "description": "Implements VirtualNetwork GET method.", "x-ms-examples": { - "GetVirtualNetwork": { - "$ref": "./examples/GetVirtualNetwork.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "in": "path", - "name": "virtualNetworkName", - "required": true, - "type": "string", - "description": "Name of the VirtualNetwork.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Retrieves the VirtualNetworks resource.", - "schema": { - "$ref": "#/definitions/VirtualNetwork" - } + "VirtualMachineInstances_Restart_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_Restart_MaximumSet_Gen.json" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } + "VirtualMachineInstances_Restart_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_Restart_MinimumSet_Gen.json" } - } - }, - "put": { + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/restoreCheckpoint": { + "post": { + "operationId": "VirtualMachineInstances_RestoreCheckpoint", "tags": [ - "VirtualNetworks" + "VirtualMachineInstances" ], - "operationId": "VirtualNetworks_CreateOrUpdate", - "description": "Onboards the ScVmm virtual network as an Azure virtual network resource.", - "summary": "Implements VirtualNetworks PUT method.", - "x-ms-examples": { - "CreateVirtualNetwork": { - "$ref": "./examples/CreateVirtualNetwork.json" - } - }, + "summary": "Implements the operation to restores to a checkpoint in a virtual machine instance.", + "description": "Restores to a checkpoint in virtual machine instance.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "in": "path", - "name": "virtualNetworkName", - "required": true, - "type": "string", - "description": "Name of the VirtualNetwork.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "body", - "description": "Request payload.", "in": "body", + "description": "The content of the action request", "required": true, "schema": { - "$ref": "#/definitions/VirtualNetwork" + "$ref": "#/definitions/VirtualMachineRestoreCheckpoint" } } ], "responses": { - "200": { - "description": "Creates or Updates the VirtualNetworks resource.", - "schema": { - "$ref": "#/definitions/VirtualNetwork" - } - }, - "201": { - "description": "Creates or Updates the VirtualNetworks resource.", - "schema": { - "$ref": "#/definitions/VirtualNetwork" + "202": { + "description": "Resource operation 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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "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": [ - "VirtualNetworks" - ], - "operationId": "VirtualNetworks_Delete", - "description": "Deregisters the ScVmm virtual network from Azure.", - "summary": "Implements VirtualNetwork DELETE method.", "x-ms-examples": { - "DeleteVirtualNetwork": { - "$ref": "./examples/DeleteVirtualNetwork.json" + "VirtualMachineInstances_RestoreCheckpoint_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_RestoreCheckpoint_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json" } }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/start": { + "post": { + "operationId": "VirtualMachineInstances_Start", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Implements the operation to start a virtual machine.", + "description": "The operation to start a virtual machine instance.", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "in": "path", - "name": "virtualNetworkName", - "required": true, - "type": "string", - "description": "Name of the VirtualNetwork.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "force", - "description": "Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too.", - "required": false, - "type": "string", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "Force" - } + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" } ], "responses": { "202": { - "description": "Accepted", + "description": "Resource operation accepted.", "headers": { "Location": { - "type": "string" + "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": "No Content" - }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "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": [ - "VirtualNetworks" - ], - "operationId": "VirtualNetworks_Update", - "summary": "Implements the VirtualNetworks PATCH method.", - "description": "Updates the VirtualNetworks resource.", "x-ms-examples": { - "UpdateVirtualNetwork": { - "$ref": "./examples/UpdateVirtualNetwork.json" + "VirtualMachineInstances_Start_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_Start_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_Start_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_Start_MinimumSet_Gen.json" } }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop": { + "post": { + "operationId": "VirtualMachineInstances_Stop", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Implements the operation to stop a virtual machine.", + "description": "The operation to power off (stop) a virtual machine instance.", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "in": "path", - "name": "virtualNetworkName", - "required": true, - "type": "string", - "description": "Name of the VirtualNetwork.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "body", - "description": "VirtualNetworks patch payload.", "in": "body", + "description": "The content of the action request", "required": true, "schema": { - "$ref": "#/definitions/ResourcePatch" + "$ref": "#/definitions/StopVirtualMachineOptions" } } ], "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/VirtualNetwork" - } - }, "202": { - "description": "Accepted", + "description": "Resource operation accepted.", "headers": { "Location": { - "type": "string" + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineInstances_Stop_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_Stop_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_Stop_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_Stop_MinimumSet_Gen.json" + } + }, "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } + "final-state-via": "location" + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualNetworks": { + "/providers/Microsoft.ScVmm/operations": { "get": { + "operationId": "Operations_List", "tags": [ - "VirtualNetworks" + "Operations" ], - "operationId": "VirtualNetworks_ListByResourceGroup", - "summary": "Implements GET VirtualNetworks in a resource group.", - "description": "List of VirtualNetworks in a resource group.", - "x-ms-examples": { - "ListVirtualNetworksByResourceGroup": { - "$ref": "./examples/ListVirtualNetworksByResourceGroup.json" - } - }, + "description": "List the operations for the provider", "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": "Lists all VirtualNetworks under the resource group.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VirtualNetworkListResult" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "Operations_List_MaximumSet": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/virtualNetworks": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/availabilitySets": { "get": { + "operationId": "AvailabilitySets_ListBySubscription", "tags": [ - "VirtualNetworks" + "AvailabilitySets" ], - "operationId": "VirtualNetworks_ListBySubscription", - "summary": "Implements GET VirtualNetworks in a subscription.", - "description": "List of VirtualNetworks in a subscription.", - "x-ms-examples": { - "ListVirtualNetworksBySubscription": { - "$ref": "./examples/ListVirtualNetworksBySubscription.json" - } - }, - "parameters": [ + "summary": "Implements GET AvailabilitySets in a subscription.", + "description": "List of AvailabilitySets in a subscription.", + "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "Lists all VirtualNetworks under the subscription.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VirtualNetworkListResult" + "$ref": "#/definitions/AvailabilitySetListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "AvailabilitySets_ListBySubscription_MaximumSet": { + "$ref": "./examples/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json" + }, + "AvailabilitySets_ListBySubscription_MinimumSet": { + "$ref": "./examples/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates/{virtualMachineTemplateName}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/clouds": { "get": { + "operationId": "Clouds_ListBySubscription", "tags": [ - "VirtualMachineTemplates" + "Clouds" ], - "operationId": "VirtualMachineTemplates_Get", - "summary": "Gets a VirtualMachineTemplate.", - "description": "Implements VirtualMachineTemplate GET method.", - "x-ms-examples": { - "GetVirtualMachineTemplate": { - "$ref": "./examples/GetVirtualMachineTemplate.json" - } - }, + "summary": "Implements GET Clouds in a subscription.", + "description": "List of Clouds in a subscription.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "in": "path", - "name": "virtualMachineTemplateName", - "required": true, - "type": "string", - "description": "Name of the VirtualMachineTemplate.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "Retrieves the VirtualMachineTemplates resource.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VirtualMachineTemplate" + "$ref": "#/definitions/CloudListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Clouds_ListBySubscription_MaximumSet": { + "$ref": "./examples/Clouds_ListBySubscription_MaximumSet_Gen.json" + }, + "Clouds_ListBySubscription_MinimumSet": { + "$ref": "./examples/Clouds_ListBySubscription_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/virtualMachineTemplates": { + "get": { + "operationId": "VirtualMachineTemplates_ListBySubscription", "tags": [ "VirtualMachineTemplates" ], - "operationId": "VirtualMachineTemplates_CreateOrUpdate", - "description": "Onboards the ScVmm VM Template as an Azure VM Template resource.", - "summary": "Implements VirtualMachineTemplates PUT method.", - "x-ms-examples": { - "CreateVirtualMachineTemplate": { - "$ref": "./examples/CreateVirtualMachineTemplate.json" - } - }, + "summary": "Implements GET VirtualMachineTemplates in a subscription.", + "description": "List of VirtualMachineTemplates in a subscription.", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "in": "path", - "name": "virtualMachineTemplateName", - "required": true, - "type": "string", - "description": "Name of the VirtualMachineTemplate.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "name": "body", - "description": "Request payload.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineTemplate" - } + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "Creates or Updates the VirtualMachineTemplates resource.", - "schema": { - "$ref": "#/definitions/VirtualMachineTemplate" - } - }, - "201": { - "description": "Creates or Updates the VirtualMachineTemplates resource.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VirtualMachineTemplate" + "$ref": "#/definitions/VirtualMachineTemplateListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "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": [ - "VirtualMachineTemplates" - ], - "operationId": "VirtualMachineTemplates_Delete", - "description": "Deregisters the ScVmm VM Template from Azure.", - "summary": "Implements VirtualMachineTemplate DELETE method.", "x-ms-examples": { - "DeleteVirtualMachineTemplate": { - "$ref": "./examples/DeleteVirtualMachineTemplate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "in": "path", - "name": "virtualMachineTemplateName", - "required": true, - "type": "string", - "description": "Name of the VirtualMachineTemplate.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "query", - "name": "force", - "description": "Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too.", - "required": false, - "type": "string", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "Force" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "headers": { - "Location": { - "type": "string" - } - } - }, - "204": { - "description": "No Content" + "VirtualMachineTemplates_ListBySubscription_MaximumSet": { + "$ref": "./examples/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } + "VirtualMachineTemplates_ListBySubscription_MinimumSet": { + "$ref": "./examples/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/virtualNetworks": { + "get": { + "operationId": "VirtualNetworks_ListBySubscription", "tags": [ - "VirtualMachineTemplates" + "VirtualNetworks" ], - "operationId": "VirtualMachineTemplates_Update", - "summary": "Implements the VirtualMachineTemplate PATCH method.", - "description": "Updates the VirtualMachineTemplate resource.", - "x-ms-examples": { - "UpdateVirtualMachineTemplate": { - "$ref": "./examples/UpdateVirtualMachineTemplate.json" - } - }, + "summary": "Implements GET VirtualNetworks in a subscription.", + "description": "List of VirtualNetworks in a subscription.", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "in": "path", - "name": "virtualMachineTemplateName", - "required": true, - "type": "string", - "description": "Name of the VirtualMachineTemplate.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 - }, - { - "name": "body", - "description": "VirtualMachineTemplates patch details.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ResourcePatch" - } } ], "responses": { "200": { - "description": "Successful.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VirtualMachineTemplate" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "type": "string" - } + "$ref": "#/definitions/VirtualNetworkListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "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": { + "VirtualNetworks_ListBySubscription_MaximumSet": { + "$ref": "./examples/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json" + }, + "VirtualNetworks_ListBySubscription_MinimumSet": { + "$ref": "./examples/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/vmmServers": { "get": { + "operationId": "VmmServers_ListBySubscription", "tags": [ - "VirtualMachineTemplates" + "VmmServers" ], - "operationId": "VirtualMachineTemplates_ListByResourceGroup", - "summary": "Implements GET VirtualMachineTemplates in a resource group.", - "description": "List of VirtualMachineTemplates in a resource group.", - "x-ms-examples": { - "ListVirtualMachineTemplatesByResourceGroup": { - "$ref": "./examples/ListVirtualMachineTemplatesByResourceGroup.json" - } - }, + "summary": "Implements GET VmmServers in a subscription.", + "description": "List of VmmServers in a subscription.", "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": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "Lists all VirtualMachineTemplates under the resource group.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VirtualMachineTemplateListResult" + "$ref": "#/definitions/VmmServerListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "VmmServers_ListBySubscription_MaximumSet": { + "$ref": "./examples/VmmServers_ListBySubscription_MaximumSet_Gen.json" + }, + "VmmServers_ListBySubscription_MinimumSet": { + "$ref": "./examples/VmmServers_ListBySubscription_MinimumSet_Gen.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/virtualMachineTemplates": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/availabilitySets": { "get": { + "operationId": "AvailabilitySets_ListByResourceGroup", "tags": [ - "VirtualMachineTemplates" + "AvailabilitySets" ], - "operationId": "VirtualMachineTemplates_ListBySubscription", - "summary": "Implements GET VirtualMachineTemplates in a subscription.", - "description": "List of VirtualMachineTemplates in a subscription.", - "x-ms-examples": { - "ListVirtualMachineTemplatesBySubscription": { - "$ref": "./examples/ListVirtualMachineTemplatesBySubscription.json" - } - }, + "summary": "Implements GET AvailabilitySets in a resource group.", + "description": "List of AvailabilitySets in 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/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { - "description": "Lists all VirtualMachineTemplates under the subscription.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VirtualMachineTemplateListResult" + "$ref": "#/definitions/AvailabilitySetListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "AvailabilitySets_ListByResourceGroup_MaximumSet": { + "$ref": "./examples/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json" + }, + "AvailabilitySets_ListByResourceGroup_MinimumSet": { + "$ref": "./examples/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -1436,18 +1284,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/availabilitySets/{availabilitySetResourceName}": { "get": { + "operationId": "AvailabilitySets_Get", "tags": [ "AvailabilitySets" ], - "operationId": "AvailabilitySets_Get", "summary": "Gets an AvailabilitySet.", "description": "Implements AvailabilitySet GET method.", - "x-ms-examples": { - "GetAvailabilitySet": { - "$ref": "./examples/GetAvailabilitySet.json" - } - }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1455,47 +1301,50 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", "name": "availabilitySetResourceName", + "in": "path", + "description": "Name of the AvailabilitySet.", "required": true, "type": "string", - "description": "Name of the AvailabilitySet.", - "pattern": "[a-zA-Z0-9-_\\.]", "minLength": 1, - "maxLength": 54 - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" } ], "responses": { "200": { - "description": "Retrieves the AvailabilitySet resource.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AvailabilitySet" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "AvailabilitySets_Get_MaximumSet": { + "$ref": "./examples/AvailabilitySets_Get_MaximumSet_Gen.json" + }, + "AvailabilitySets_Get_MinimumSet": { + "$ref": "./examples/AvailabilitySets_Get_MinimumSet_Gen.json" + } } }, "put": { + "operationId": "AvailabilitySets_CreateOrUpdate", "tags": [ "AvailabilitySets" ], - "operationId": "AvailabilitySets_CreateOrUpdate", - "description": "Onboards the ScVmm availability set as an Azure resource.", "summary": "Implements AvailabilitySets PUT method.", - "x-ms-examples": { - "CreateAvailabilitySet": { - "$ref": "./examples/CreateAvailabilitySet.json" - } - }, + "description": "Onboards the ScVmm availability set as an Azure resource.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1503,22 +1352,19 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", "name": "availabilitySetResourceName", + "in": "path", + "description": "Name of the AvailabilitySet.", "required": true, "type": "string", - "description": "Name of the AvailabilitySet.", - "pattern": "[a-zA-Z0-9-_\\.]", "minLength": 1, - "maxLength": 54 + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "body", - "description": "Request payload.", + "name": "resource", "in": "body", + "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/AvailabilitySet" @@ -1527,48 +1373,59 @@ ], "responses": { "200": { - "description": "Creates or Updates the AvailabilitySets resource.", + "description": "Resource 'AvailabilitySet' update operation succeeded", "schema": { "$ref": "#/definitions/AvailabilitySet" } }, "201": { - "description": "Creates or Updates the AvailabilitySets resource.", + "description": "Resource 'AvailabilitySet' create operation succeeded", "schema": { "$ref": "#/definitions/AvailabilitySet" }, "headers": { "Azure-AsyncOperation": { - "description": "Tracking URL for long running operation.", - "type": "string" + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "AvailabilitySets_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json" + }, + "AvailabilitySets_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json" + } + }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" - } + }, + "x-ms-long-running-operation": true }, - "delete": { + "patch": { + "operationId": "AvailabilitySets_Update", "tags": [ "AvailabilitySets" ], - "operationId": "AvailabilitySets_Delete", - "description": "Deregisters the ScVmm availability set from Azure.", - "summary": "Implements AvailabilitySet DELETE method.", - "x-ms-examples": { - "DeleteAvailabilitySet": { - "$ref": "./examples/DeleteAvailabilitySet.json" - } - }, + "summary": "Implements the AvailabilitySets PATCH method.", + "description": "Updates the AvailabilitySets resource.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1576,75 +1433,74 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", "name": "availabilitySetResourceName", + "in": "path", + "description": "Name of the AvailabilitySet.", "required": true, "type": "string", - "description": "Name of the AvailabilitySet.", - "pattern": "[a-zA-Z0-9-_\\.]", "minLength": 1, - "maxLength": 54 - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" }, { - "in": "query", - "name": "force", - "description": "Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too.", - "required": false, - "type": "string", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "Force" + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySetTagsUpdate" } } ], "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + }, "202": { - "description": "Accepted", + "description": "Resource update request accepted.", "headers": { - "Azure-AsyncOperation": { - "description": "Tracking URL for long running operation.", - "type": "string" - }, "Location": { - "type": "string" + "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": "No Content" - }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "AvailabilitySets_Update_MaximumSet": { + "$ref": "./examples/AvailabilitySets_Update_MaximumSet_Gen.json" + }, + "AvailabilitySets_Update_MinimumSet": { + "$ref": "./examples/AvailabilitySets_Update_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, "x-ms-long-running-operation": true }, - "patch": { + "delete": { + "operationId": "AvailabilitySets_Delete", "tags": [ "AvailabilitySets" ], - "operationId": "AvailabilitySets_Update", - "summary": "Implements the AvailabilitySets PATCH method.", - "description": "Updates the AvailabilitySets resource.", - "x-ms-examples": { - "UpdateAvailabilitySet": { - "$ref": "./examples/UpdateAvailabilitySet.json" - } - }, + "summary": "Implements AvailabilitySet DELETE method.", + "description": "Deregisters the ScVmm availability set from Azure.", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, @@ -1652,156 +1508,174 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "path", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/QueryForceDelete" + }, + { "name": "availabilitySetResourceName", + "in": "path", + "description": "Name of the AvailabilitySet.", "required": true, "type": "string", - "description": "Name of the AvailabilitySet.", - "pattern": "[a-zA-Z0-9-_\\.]", "minLength": 1, - "maxLength": 54 - }, - { - "name": "body", - "description": "AvailabilitySets patch payload.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ResourcePatch" - } + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" } ], "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/AvailabilitySet" - } - }, "202": { - "description": "Accepted", + "description": "Resource deletion accepted.", "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, "Location": { - "type": "string" + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "AvailabilitySets_Delete_MaximumSet": { + "$ref": "./examples/AvailabilitySets_Delete_MaximumSet_Gen.json" + }, + "AvailabilitySets_Delete_MinimumSet": { + "$ref": "./examples/AvailabilitySets_Delete_MinimumSet_Gen.json" + } + }, "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } + "final-state-via": "location" + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/availabilitySets": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/clouds": { "get": { + "operationId": "Clouds_ListByResourceGroup", "tags": [ - "AvailabilitySets" + "Clouds" ], - "operationId": "AvailabilitySets_ListByResourceGroup", - "summary": "Implements GET AvailabilitySets in a resource group.", - "description": "List of AvailabilitySets in a resource group.", - "x-ms-examples": { - "ListAvailabilitySetsByResourceGroup": { - "$ref": "./examples/ListAvailabilitySetsByResourceGroup.json" - } - }, + "summary": "Implements GET Clouds in a resource group.", + "description": "List of Clouds in a resource group.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { - "description": "Lists all AvailabilitySets under the resource group.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/AvailabilitySetListResult" + "$ref": "#/definitions/CloudListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "Clouds_ListByResourceGroup_MaximumSet": { + "$ref": "./examples/Clouds_ListByResourceGroup_MaximumSet_Gen.json" + }, + "Clouds_ListByResourceGroup_MinimumSet": { + "$ref": "./examples/Clouds_ListByResourceGroup_MinimumSet_Gen.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/availabilitySets": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/clouds/{cloudResourceName}": { "get": { + "operationId": "Clouds_Get", "tags": [ - "AvailabilitySets" + "Clouds" ], - "operationId": "AvailabilitySets_ListBySubscription", - "summary": "Implements GET AvailabilitySets in a subscription.", - "description": "List of AvailabilitySets in a subscription.", - "x-ms-examples": { - "ListAvailabilitySetsBySubscription": { - "$ref": "./examples/ListAvailabilitySetsBySubscription.json" - } - }, + "summary": "Gets a Cloud.", + "description": "Implements Cloud GET method.", "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/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudResourceName", + "in": "path", + "description": "Name of the Cloud.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" } ], "responses": { "200": { - "description": "Lists all AvailabilitySets under the subscription.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/AvailabilitySetListResult" + "$ref": "#/definitions/Cloud" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-examples": { + "Clouds_Get_MaximumSet": { + "$ref": "./examples/Clouds_Get_MaximumSet_Gen.json" + }, + "Clouds_Get_MinimumSet": { + "$ref": "./examples/Clouds_Get_MinimumSet_Gen.json" + } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/{inventoryItemResourceName}": { + }, "put": { + "operationId": "Clouds_CreateOrUpdate", "tags": [ - "InventoryItems" - ], - "operationId": "InventoryItems_Create", - "summary": "Implements InventoryItem PUT method.", - "description": "Create Or Update InventoryItem.", - "x-ms-examples": { - "CreateInventoryItem": { - "$ref": "./examples/CreateInventoryItem.json" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" + "Clouds" ], + "summary": "Implements Clouds PUT method.", + "description": "Onboards the ScVmm fabric cloud as an Azure cloud resource.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1809,131 +1683,154 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { + "name": "cloudResourceName", "in": "path", - "name": "vmmServerName", + "description": "Name of the Cloud.", "required": true, "type": "string", - "description": "Name of the VMMServer.", - "pattern": "[a-zA-Z0-9-_\\.]", "minLength": 1, - "maxLength": 54 - }, - { - "in": "path", - "name": "inventoryItemResourceName", - "required": true, - "type": "string", - "description": "Name of the inventoryItem.", - "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" }, { + "name": "resource", "in": "body", - "name": "body", - "description": "Request payload.", + "description": "Resource create parameters.", + "required": true, "schema": { - "$ref": "#/definitions/InventoryItem" + "$ref": "#/definitions/Cloud" } } ], "responses": { "200": { - "description": "Success", + "description": "Resource 'Cloud' update operation succeeded", "schema": { - "$ref": "#/definitions/InventoryItem" + "$ref": "#/definitions/Cloud" } }, "201": { - "description": "Created", + "description": "Resource 'Cloud' create operation succeeded", "schema": { - "$ref": "#/definitions/InventoryItem" + "$ref": "#/definitions/Cloud" + }, + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } - }, - "get": { - "tags": [ - "InventoryItems" - ], - "operationId": "InventoryItems_Get", - "summary": "Implements GET InventoryItem method.", - "description": "Shows an inventory item.", + }, "x-ms-examples": { - "GetInventoryItem": { - "$ref": "./examples/GetInventoryItem.json" + "Clouds_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/Clouds_CreateOrUpdate_MaximumSet_Gen.json" + }, + "Clouds_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/Clouds_CreateOrUpdate_MinimumSet_Gen.json" } }, - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Clouds_Update", + "tags": [ + "Clouds" + ], + "summary": "Implements the Clouds PATCH method.", + "description": "Updates the Clouds resource.", + "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": "cloudResourceName", "in": "path", - "name": "vmmServerName", + "description": "Name of the Cloud.", "required": true, "type": "string", - "description": "Name of the VMMServer.", - "pattern": "[a-zA-Z0-9-_\\.]", "minLength": 1, - "maxLength": 54 + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" }, { - "in": "path", - "name": "inventoryItemResourceName", + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", "required": true, - "type": "string", - "description": "Name of the inventoryItem.", - "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "schema": { + "$ref": "#/definitions/CloudTagsUpdate" + } } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/InventoryItem" + "$ref": "#/definitions/Cloud" + } + }, + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } - }, - "delete": { - "tags": [ - "InventoryItems" - ], - "operationId": "InventoryItems_Delete", - "summary": "Implements inventoryItem DELETE method.", - "description": "Deletes an inventoryItem.", + }, "x-ms-examples": { - "DeleteInventoryItem": { - "$ref": "./examples/DeleteInventoryItem.json" + "Clouds_Update_MaximumSet": { + "$ref": "./examples/Clouds_Update_MaximumSet_Gen.json" + }, + "Clouds_Update_MinimumSet": { + "$ref": "./examples/Clouds_Update_MinimumSet_Gen.json" } }, - "produces": [ - "application/json" + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Clouds_Delete", + "tags": [ + "Clouds" ], + "summary": "Implements Cloud resource DELETE method.", + "description": "Deregisters the ScVmm fabric cloud from Azure.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, @@ -1941,1006 +1838,1315 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "vmmServerName", - "required": true, - "type": "string", - "description": "Name of the VMMServer.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 + "$ref": "#/parameters/QueryForceDelete" }, { + "name": "cloudResourceName", "in": "path", - "name": "inventoryItemResourceName", + "description": "Name of the Cloud.", "required": true, "type": "string", - "description": "Name of the inventoryItem.", - "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" } ], "responses": { - "200": { - "description": "Success" + "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": "No Content" + "description": "Resource does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } + }, + "x-ms-examples": { + "Clouds_Delete_MaximumSet": { + "$ref": "./examples/Clouds_Delete_MaximumSet_Gen.json" + }, + "Clouds_Delete_MinimumSet": { + "$ref": "./examples/Clouds_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates": { "get": { + "operationId": "VirtualMachineTemplates_ListByResourceGroup", "tags": [ - "InventoryItems" - ], - "operationId": "InventoryItems_ListByVMMServer", - "summary": "Implements GET for the list of Inventory Items in the VMMServer.", - "description": "Returns the list of inventoryItems in the given VMMServer.", - "x-ms-examples": { - "InventoryItemsListByVMMServer": { - "$ref": "./examples/ListInventoryItemsByVMMServer.json" - } - }, - "produces": [ - "application/json" + "VirtualMachineTemplates" ], + "summary": "Implements GET VirtualMachineTemplates in a resource group.", + "description": "List of VirtualMachineTemplates in 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" }, { - "in": "path", - "name": "vmmServerName", - "required": true, - "type": "string", - "description": "Name of the VMMServer.", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54 + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/InventoryItemsList" + "$ref": "#/definitions/VirtualMachineTemplateListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "VirtualMachineTemplates_ListByResourceGroup_MaximumSet": { + "$ref": "./examples/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json" + }, + "VirtualMachineTemplates_ListByResourceGroup_MinimumSet": { + "$ref": "./examples/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates/{virtualMachineTemplateName}": { "get": { + "operationId": "VirtualMachineTemplates_Get", "tags": [ - "VirtualMachineInstances" - ], - "operationId": "VirtualMachineInstances_Get", - "summary": "Gets a virtual machine.", - "description": "Retrieves information about a virtual machine instance.", - "x-ms-examples": { - "GetVirtualMachine": { - "$ref": "./examples/GetVirtualMachineInstance.json" - } - }, - "produces": [ - "application/json" + "VirtualMachineTemplates" ], + "summary": "Gets a VirtualMachineTemplate.", + "description": "Implements VirtualMachineTemplate GET method.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$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/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualMachineTemplateName", + "in": "path", + "description": "Name of the VirtualMachineTemplate.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VirtualMachineInstance" + "$ref": "#/definitions/VirtualMachineTemplate" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "VirtualMachineTemplates_Get_MaximumSet": { + "$ref": "./examples/VirtualMachineTemplates_Get_MaximumSet_Gen.json" + }, + "VirtualMachineTemplates_Get_MinimumSet": { + "$ref": "./examples/VirtualMachineTemplates_Get_MinimumSet_Gen.json" + } } }, "put": { + "operationId": "VirtualMachineTemplates_CreateOrUpdate", "tags": [ - "VirtualMachineInstances" - ], - "operationId": "VirtualMachineInstances_CreateOrUpdate", - "description": "The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.", - "summary": "Implements virtual machine PUT method.", - "x-ms-examples": { - "CreateVirtualMachine": { - "$ref": "./examples/CreateVirtualMachineInstance.json" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" + "VirtualMachineTemplates" ], + "summary": "Implements VirtualMachineTemplates PUT method.", + "description": "Onboards the ScVmm VM Template as an Azure VM Template resource.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$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": "virtualMachineTemplateName", + "in": "path", + "description": "Name of the VirtualMachineTemplate.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" }, { + "name": "resource", "in": "body", - "name": "body", - "description": "Request payload.", + "description": "Resource create parameters.", + "required": true, "schema": { - "$ref": "#/definitions/VirtualMachineInstance" + "$ref": "#/definitions/VirtualMachineTemplate" } } ], "responses": { "200": { - "description": "Success", + "description": "Resource 'VirtualMachineTemplate' update operation succeeded", "schema": { - "$ref": "#/definitions/VirtualMachineInstance" + "$ref": "#/definitions/VirtualMachineTemplate" } }, "201": { - "description": "Created", + "description": "Resource 'VirtualMachineTemplate' create operation succeeded", "schema": { - "$ref": "#/definitions/VirtualMachineInstance" + "$ref": "#/definitions/VirtualMachineTemplate" + }, + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineTemplates_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json" + }, + "VirtualMachineTemplates_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json" + } + }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" - } + }, + "x-ms-long-running-operation": true }, "patch": { + "operationId": "VirtualMachineTemplates_Update", "tags": [ - "VirtualMachineInstances" - ], - "operationId": "VirtualMachineInstances_Update", - "summary": "Updates a virtual machine.", - "description": "The operation to update a virtual machine instance.", - "x-ms-examples": { - "UpdateVirtualMachine": { - "$ref": "./examples/UpdateVirtualMachineInstance.json" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" + "VirtualMachineTemplates" ], + "summary": "Implements the VirtualMachineTemplate PATCH method.", + "description": "Updates the VirtualMachineTemplate resource.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$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": "virtualMachineTemplateName", + "in": "path", + "description": "Name of the VirtualMachineTemplate.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "properties", "in": "body", - "name": "body", - "description": "Resource properties to update.", + "description": "The resource properties to be updated.", + "required": true, "schema": { - "$ref": "#/definitions/VirtualMachineInstanceUpdate" + "$ref": "#/definitions/VirtualMachineTemplateTagsUpdate" } } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VirtualMachineInstance" + "$ref": "#/definitions/VirtualMachineTemplate" } }, "202": { - "description": "Accepted", + "description": "Resource update request accepted.", "headers": { "Location": { - "type": "string" + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineTemplates_Update_MaximumSet": { + "$ref": "./examples/VirtualMachineTemplates_Update_MaximumSet_Gen.json" + }, + "VirtualMachineTemplates_Update_MinimumSet": { + "$ref": "./examples/VirtualMachineTemplates_Update_MinimumSet_Gen.json" + } + }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" - } + }, + "x-ms-long-running-operation": true }, "delete": { + "operationId": "VirtualMachineTemplates_Delete", "tags": [ - "VirtualMachineInstances" - ], - "operationId": "VirtualMachineInstances_Delete", - "summary": "Deletes an virtual machine.", - "description": "The operation to delete a virtual machine instance.", - "x-ms-examples": { - "DeleteVirtualMachine": { - "$ref": "./examples/DeleteVirtualMachineInstance.json" - } - }, - "produces": [ - "application/json" + "VirtualMachineTemplates" ], + "summary": "Implements VirtualMachineTemplate DELETE method.", + "description": "Deregisters the ScVmm VM Template from Azure.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "force", - "description": "Whether force delete was specified.", - "required": false, - "type": "string", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "Force" - } + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "query", - "name": "deleteFromHost", - "description": "Whether to disable the VM from azure and also delete it from VMM.", - "required": false, + "$ref": "#/parameters/QueryForceDelete" + }, + { + "name": "virtualMachineTemplateName", + "in": "path", + "description": "Name of the VirtualMachineTemplate.", + "required": true, "type": "string", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "DeleteFromHost" - } + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" } ], "responses": { "202": { - "description": "Accepted", + "description": "Resource deletion accepted.", "headers": { "Location": { - "type": "string" + "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": "No Content" + "description": "Resource does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineTemplates_Delete_MaximumSet": { + "$ref": "./examples/VirtualMachineTemplates_Delete_MaximumSet_Gen.json" + }, + "VirtualMachineTemplates_Delete_MinimumSet": { + "$ref": "./examples/VirtualMachineTemplates_Delete_MinimumSet_Gen.json" + } + }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" - } + }, + "x-ms-long-running-operation": true } }, - "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualNetworks": { "get": { + "operationId": "VirtualNetworks_ListByResourceGroup", "tags": [ - "VirtualMachineInstances" - ], - "operationId": "VirtualMachineInstances_List", - "summary": "Implements List virtual machine instances.", - "description": "Lists all of the virtual machine instances within the specified parent resource.", - "x-ms-examples": { - "ListVirtualMachines": { - "$ref": "./examples/ListVirtualMachineInstances.json" - } - }, - "produces": [ - "application/json" + "VirtualNetworks" ], + "summary": "Implements GET VirtualNetworks in a resource group.", + "description": "List of VirtualNetworks in a resource group.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$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": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VirtualMachineInstanceListResult" + "$ref": "#/definitions/VirtualNetworkListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "VirtualNetworks_ListByResourceGroup_MaximumSet": { + "$ref": "./examples/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json" + }, + "VirtualNetworks_ListByResourceGroup_MinimumSet": { + "$ref": "./examples/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualNetworks/{virtualNetworkName}": { + "get": { + "operationId": "VirtualNetworks_Get", "tags": [ - "VirtualMachineInstances" - ], - "operationId": "VirtualMachineInstances_Stop", - "description": "The operation to power off (stop) a virtual machine instance.", - "summary": "Implements the operation to stop a virtual machine.", - "x-ms-examples": { - "StopVirtualMachine": { - "$ref": "./examples/StopVirtualMachineInstance.json" - } - }, - "consumes": [ - "application/json" + "VirtualNetworks" ], + "summary": "Gets a VirtualNetwork.", + "description": "Implements VirtualNetwork GET method.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "body", - "name": "body", - "description": "Virtualmachine stop action payload.", - "schema": { - "$ref": "#/definitions/StopVirtualMachineOptions" - } + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualNetworkName", + "in": "path", + "description": "Name of the VirtualNetwork.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" } ], "responses": { - "202": { - "description": "Accepted", - "headers": { - "Location": { - "type": "string" - } + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true - } - }, - "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/start": { - "post": { - "tags": [ - "VirtualMachineInstances" - ], - "operationId": "VirtualMachineInstances_Start", - "description": "The operation to start a virtual machine instance.", - "summary": "Implements the operation to start a virtual machine.", "x-ms-examples": { - "StartVirtualMachine": { - "$ref": "./examples/StartVirtualMachineInstance.json" + "VirtualNetworks_Get_MaximumSet": { + "$ref": "./examples/VirtualNetworks_Get_MaximumSet_Gen.json" + }, + "VirtualNetworks_Get_MinimumSet": { + "$ref": "./examples/VirtualNetworks_Get_MinimumSet_Gen.json" } - }, + } + }, + "put": { + "operationId": "VirtualNetworks_CreateOrUpdate", + "tags": [ + "VirtualNetworks" + ], + "summary": "Implements VirtualNetworks PUT method.", + "description": "Onboards the ScVmm virtual network as an Azure virtual network resource.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$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/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualNetworkName", + "in": "path", + "description": "Name of the VirtualNetwork.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } } ], "responses": { - "202": { - "description": "Accepted", + "200": { + "description": "Resource 'VirtualNetwork' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "201": { + "description": "Resource 'VirtualNetwork' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + }, "headers": { - "Location": { - "type": "string" + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true - } - }, - "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/restart": { - "post": { - "tags": [ - "VirtualMachineInstances" - ], - "operationId": "VirtualMachineInstances_Restart", - "description": "The operation to restart a virtual machine instance.", - "summary": "Implements the operation to restart a virtual machine.", "x-ms-examples": { - "RestartVirtualMachine": { - "$ref": "./examples/RestartVirtualMachineInstance.json" + "VirtualNetworks_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json" + }, + "VirtualNetworks_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json" } }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualNetworks_Update", + "tags": [ + "VirtualNetworks" + ], + "summary": "Implements the VirtualNetworks PATCH method.", + "description": "Updates the VirtualNetworks resource.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$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/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualNetworkName", + "in": "path", + "description": "Name of the VirtualNetwork.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkTagsUpdate" + } } ], "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, "202": { - "description": "Accepted", + "description": "Resource update request accepted.", "headers": { "Location": { - "type": "string" + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true - } - }, - "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default": { - "get": { - "tags": [ - "VmInstanceHybridIdentityMetadata" - ], - "operationId": "VirtualMachineInstanceHybridIdentityMetadata_Get", - "summary": "Gets HybridIdentityMetadata.", - "description": "Implements HybridIdentityMetadata GET method.", "x-ms-examples": { - "GetHybridIdentityMetadata": { - "$ref": "./examples/GetVmInstanceHybridIdentityMetadata.json" + "VirtualNetworks_Update_MaximumSet": { + "$ref": "./examples/VirtualNetworks_Update_MaximumSet_Gen.json" + }, + "VirtualNetworks_Update_MinimumSet": { + "$ref": "./examples/VirtualNetworks_Update_MinimumSet_Gen.json" } }, - "produces": [ - "application/json" + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualNetworks_Delete", + "tags": [ + "VirtualNetworks" ], + "summary": "Implements VirtualNetwork DELETE method.", + "description": "Deregisters the ScVmm virtual network from Azure.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$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": "#/parameters/QueryForceDelete" + }, + { + "name": "virtualNetworkName", + "in": "path", + "description": "Name of the VirtualNetwork.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/VmInstanceHybridIdentityMetadata" + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } + }, + "x-ms-examples": { + "VirtualNetworks_Delete_MaximumSet": { + "$ref": "./examples/VirtualNetworks_Delete_MaximumSet_Gen.json" + }, + "VirtualNetworks_Delete_MinimumSet": { + "$ref": "./examples/VirtualNetworks_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true } }, - "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers": { "get": { + "operationId": "VmmServers_ListByResourceGroup", "tags": [ - "VmInstanceHybridIdentityMetadata" - ], - "operationId": "VirtualMachineInstanceHybridIdentityMetadata_List", - "summary": "Implements GET HybridIdentityMetadata in a vm.", - "description": "Returns the list of HybridIdentityMetadata of the given vm.", - "x-ms-examples": { - "HybridIdentityMetadataListByVm": { - "$ref": "./examples/HybridIdentityMetadata_ListByVmInstance.json" - } - }, - "produces": [ - "application/json" + "VmmServers" ], + "summary": "Implements GET VmmServers in a resource group.", + "description": "List of VmmServers in a resource group.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$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": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VmInstanceHybridIdentityMetadataList" + "$ref": "#/definitions/VmmServerListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "VmmServers_ListByResourceGroup_MaximumSet": { + "$ref": "./examples/VmmServers_ListByResourceGroup_MaximumSet_Gen.json" + }, + "VmmServers_ListByResourceGroup_MinimumSet": { + "$ref": "./examples/VmmServers_ListByResourceGroup_MinimumSet_Gen.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/createCheckpoint": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}": { + "get": { + "operationId": "VmmServers_Get", "tags": [ - "VirtualMachineInstances" - ], - "operationId": "VirtualMachineInstances_CreateCheckpoint", - "description": "Creates a checkpoint in virtual machine instance.", - "summary": "Implements the operation to creates a checkpoint in a virtual machine instance.", - "x-ms-examples": { - "CreateCheckpointVirtualMachine": { - "$ref": "./examples/CreateCheckpointVirtualMachineInstance.json" - } - }, - "consumes": [ - "application/json" + "VmmServers" ], + "summary": "Gets a VMMServer.", + "description": "Implements VmmServer GET method.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "body", - "name": "body", - "description": "Virtualmachine create checkpoint action payload.", - "schema": { - "$ref": "#/definitions/VirtualMachineCreateCheckpoint" - } + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" } ], "responses": { - "202": { - "description": "Accepted", - "headers": { - "Location": { - "type": "string" - } + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmmServer" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true - } - }, - "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/deleteCheckpoint": { - "post": { - "tags": [ - "VirtualMachineInstances" - ], - "operationId": "VirtualMachineInstances_DeleteCheckpoint", - "description": "Deletes a checkpoint in virtual machine instance.", - "summary": "Implements the operation to delete a checkpoint in a virtual machine instance.", "x-ms-examples": { - "DeleteCheckpointVirtualMachine": { - "$ref": "./examples/DeleteCheckpointVirtualMachineInstance.json" + "VmmServers_Get_MaximumSet": { + "$ref": "./examples/VmmServers_Get_MaximumSet_Gen.json" + }, + "VmmServers_Get_MinimumSet": { + "$ref": "./examples/VmmServers_Get_MinimumSet_Gen.json" } - }, - "consumes": [ - "application/json" + } + }, + "put": { + "operationId": "VmmServers_CreateOrUpdate", + "tags": [ + "VmmServers" ], + "summary": "Implements VmmServers PUT method.", + "description": "Onboards the SCVmm fabric as an Azure VmmServer resource.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$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": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" }, { + "name": "resource", "in": "body", - "name": "body", - "description": "Virtualmachine delete checkpoint action payload.", + "description": "Resource create parameters.", + "required": true, "schema": { - "$ref": "#/definitions/VirtualMachineDeleteCheckpoint" + "$ref": "#/definitions/VmmServer" } } ], "responses": { - "202": { - "description": "Accepted", + "200": { + "description": "Resource 'VmmServer' update operation succeeded", + "schema": { + "$ref": "#/definitions/VmmServer" + } + }, + "201": { + "description": "Resource 'VmmServer' create operation succeeded", + "schema": { + "$ref": "#/definitions/VmmServer" + }, "headers": { - "Location": { - "type": "string" + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true - } - }, - "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/restoreCheckpoint": { - "post": { - "tags": [ - "VirtualMachineInstances" - ], - "operationId": "VirtualMachineInstances_RestoreCheckpoint", - "description": "Restores to a checkpoint in virtual machine instance.", - "summary": "Implements the operation to restores to a checkpoint in a virtual machine instance.", "x-ms-examples": { - "RestoreCheckpointVirtualMachine": { - "$ref": "./examples/RestoreCheckpointVirtualMachineInstance.json" + "VmmServers_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json" + }, + "VmmServers_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/VmmServers_CreateOrUpdate_MinimumSet_Gen.json" } }, - "consumes": [ - "application/json" + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VmmServers_Update", + "tags": [ + "VmmServers" ], + "summary": "Implements VmmServers PATCH method.", + "description": "Updates the VmmServers resource.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$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": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" }, { + "name": "properties", "in": "body", - "name": "body", - "description": "Virtualmachine restore checkpoint action payload.", + "description": "The resource properties to be updated.", + "required": true, "schema": { - "$ref": "#/definitions/VirtualMachineRestoreCheckpoint" + "$ref": "#/definitions/VmmServerTagsUpdate" } } ], "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmmServer" + } + }, "202": { - "description": "Accepted", + "description": "Resource update request accepted.", "headers": { "Location": { - "type": "string" + "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": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true - } - }, - "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default": { - "put": { - "tags": [ - "VMInstanceGuestAgents" - ], - "operationId": "VMInstanceGuestAgents_Create", - "description": "Create Or Update GuestAgent.", - "summary": "Implements GuestAgent PUT method.", "x-ms-examples": { - "CreateGuestAgent": { - "$ref": "./examples/CreateVMInstanceGuestAgent.json" + "VmmServers_Update_MaximumSet": { + "$ref": "./examples/VmmServers_Update_MaximumSet_Gen.json" + }, + "VmmServers_Update_MinimumSet": { + "$ref": "./examples/VmmServers_Update_MinimumSet_Gen.json" } }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VmmServers_Delete", + "tags": [ + "VmmServers" ], + "summary": "Implements VmmServers DELETE method.", + "description": "Removes the SCVmm fabric from Azure.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "body", - "name": "body", - "description": "Request payload.", - "schema": { - "$ref": "#/definitions/GuestAgent" - } + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/QueryForceDelete" + }, + { + "name": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GuestAgent" + "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." + } } }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/GuestAgent" - } + "204": { + "description": "Resource does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "VmmServers_Delete_MaximumSet": { + "$ref": "./examples/VmmServers_Delete_MaximumSet_Gen.json" + }, + "VmmServers_Delete_MinimumSet": { + "$ref": "./examples/VmmServers_Delete_MinimumSet_Gen.json" + } + }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" - } - }, + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems": { "get": { + "operationId": "InventoryItems_ListByVmmServer", "tags": [ - "VMInstanceGuestAgents" - ], - "operationId": "VMInstanceGuestAgents_Get", - "summary": "Gets GuestAgent.", - "description": "Implements GuestAgent GET method.", - "x-ms-examples": { - "GetGuestAgent": { - "$ref": "./examples/GetVMInstanceGuestAgent.json" - } - }, - "produces": [ - "application/json" + "InventoryItems" ], + "summary": "Implements GET for the list of Inventory Items in the VMMServer.", + "description": "Returns the list of inventoryItems in the given VmmServer.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$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": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/GuestAgent" + "$ref": "#/definitions/InventoryItemListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } - }, - "delete": { - "tags": [ - "VMInstanceGuestAgents" - ], - "operationId": "VMInstanceGuestAgents_Delete", - "summary": "Deletes an GuestAgent.", - "description": "Implements GuestAgent DELETE method.", - "x-ms-examples": { - "DeleteGuestAgent": { - "$ref": "./examples/DeleteVMInstanceGuestAgent.json" - } }, - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/resourceUriParameter" + "x-ms-examples": { + "InventoryItems_ListByVmmServer_MaximumSet": { + "$ref": "./examples/InventoryItems_ListByVmmServer_MaximumSet_Gen.json" }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "InventoryItems_ListByVmmServer_MinimumSet": { + "$ref": "./examples/InventoryItems_ListByVmmServer_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/{inventoryItemResourceName}": { + "get": { + "operationId": "InventoryItems_Get", + "tags": [ + "InventoryItems" + ], + "summary": "Implements GET InventoryItem method.", + "description": "Shows an inventory item.", + "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": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "inventoryItemResourceName", + "in": "path", + "description": "Name of the inventoryItem.", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { - "description": "Success" - }, - "204": { - "description": "No Content" + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InventoryItem" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "InventoryItems_Get_MaximumSet": { + "$ref": "./examples/InventoryItems_Get_MaximumSet_Gen.json" + }, + "InventoryItems_Get_MinimumSet": { + "$ref": "./examples/InventoryItems_Get_MinimumSet_Gen.json" + } } - } - }, - "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents": { - "get": { + }, + "put": { + "operationId": "InventoryItems_Create", "tags": [ - "VMInstanceGuestAgents" + "InventoryItems" ], - "operationId": "VMInstanceGuestAgents_List", - "summary": "Implements GET GuestAgent in a vm.", - "description": "Returns the list of GuestAgent of the given vm.", - "x-ms-examples": { - "GuestAgentListByVm": { - "$ref": "./examples/VMInstanceGuestAgent_ListByVm.json" + "summary": "Implements InventoryItem PUT method.", + "description": "Create Or Update InventoryItem.", + "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": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "inventoryItemResourceName", + "in": "path", + "description": "Name of the inventoryItem.", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/InventoryItem" + } + } + ], + "responses": { + "200": { + "description": "Resource 'InventoryItem' update operation succeeded", + "schema": { + "$ref": "#/definitions/InventoryItem" + } + }, + "201": { + "description": "Resource 'InventoryItem' create operation succeeded", + "schema": { + "$ref": "#/definitions/InventoryItem" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, - "produces": [ - "application/json" + "x-ms-examples": { + "InventoryItems_Create_MaximumSet": { + "$ref": "./examples/InventoryItems_Create_MaximumSet_Gen.json" + }, + "InventoryItems_Create_MinimumSet": { + "$ref": "./examples/InventoryItems_Create_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "InventoryItems_Delete", + "tags": [ + "InventoryItems" ], + "summary": "Implements inventoryItem DELETE method.", + "description": "Deletes an inventoryItem.", "parameters": [ { - "$ref": "#/parameters/resourceUriParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$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": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "inventoryItemResourceName", + "in": "path", + "description": "Name of the inventoryItem.", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GuestAgentList" - } + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-examples": { + "InventoryItems_Delete_MaximumSet": { + "$ref": "./examples/InventoryItems_Delete_MaximumSet_Gen.json" + }, + "InventoryItems_Delete_MinimumSet": { + "$ref": "./examples/InventoryItems_Delete_MinimumSet_Gen.json" + } } } } }, "definitions": { - "VMMServerProperties": { - "description": "Defines the resource properties.", - "required": [ - "fqdn" + "AllocationMethod": { + "type": "string", + "description": "Network address allocation method.", + "enum": [ + "Dynamic", + "Static" ], - "type": "object", - "properties": { - "credentials": { - "description": "Credentials to connect to VMMServer.", - "$ref": "#/definitions/VMMCredential" - }, - "fqdn": { - "type": "string", - "description": "Fqdn is the hostname/ip of the vmmServer.", - "minLength": 1 - }, - "port": { - "type": "integer", - "format": "int32", - "description": "Port is the port on which the vmmServer is listening.", - "maximum": 65535, - "minimum": 1 - }, - "connectionStatus": { - "type": "string", - "description": "Gets the connection status to the vmmServer.", - "readOnly": true - }, - "errorMessage": { - "type": "string", - "description": "Gets any error message if connection to vmmServer is having any issue.", - "readOnly": true - }, - "uuid": { - "type": "string", - "description": "Unique ID of vmmServer.", - "readOnly": true - }, - "version": { - "type": "string", - "description": "Version is the version of the vmmSever.", - "readOnly": true - }, - "provisioningState": { - "$ref": "#/definitions/ResourceProvisioningState", - "description": "Provisioning state of the resource.", - "readOnly": true - } - } - }, - "ExtendedLocation": { - "type": "object", - "description": "The extended location.", - "properties": { - "type": { - "type": "string", - "description": "The extended location type." - }, - "name": { - "type": "string", - "description": "The extended location name." - } + "x-ms-enum": { + "name": "AllocationMethod", + "modelAsString": true, + "values": [ + { + "name": "Dynamic", + "value": "Dynamic", + "description": "Dynamically allocated address." + }, + { + "name": "Static", + "value": "Static", + "description": "Statically allocated address." + } + ] } }, - "VMMServer": { + "AvailabilitySet": { "type": "object", - "x-ms-azure-resource": true, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource", - "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'" - } - ], + "description": "The AvailabilitySets resource definition.", "properties": { "properties": { + "$ref": "#/definitions/AvailabilitySetProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, - "description": "Resource properties.", - "$ref": "#/definitions/VMMServerProperties" + "x-ms-mutability": [ + "read", + "create" + ] }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -2948,47 +3154,71 @@ } }, "required": [ - "properties", "extendedLocation" ], - "description": "The VmmServers resource definition." + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AvailabilitySetListItem": { + "type": "object", + "description": "Availability Set model", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Gets the ARM Id of the microsoft.scvmm/availabilitySets resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/availabilitySets" + } + ] + } + }, + "name": { + "type": "string", + "description": "Gets or sets the name of the availability set." + } + } }, - "VMMServerListResult": { + "AvailabilitySetListResult": { "type": "object", - "description": "List of VmmServers.", + "description": "The response of a AvailabilitySet list operation.", "properties": { "value": { "type": "array", - "description": "List of VmmServers.", + "description": "The AvailabilitySet items on this page", "items": { - "$ref": "#/definitions/VMMServer" + "$ref": "#/definitions/AvailabilitySet" } }, "nextLink": { - "description": "Url to follow for getting next page of resources.", "type": "string", "format": "uri", + "description": "The link to the next page of items", "readOnly": true } - } + }, + "required": [ + "value" + ] }, - "CloudProperties": { - "description": "Defines the resource properties.", + "AvailabilitySetProperties": { "type": "object", + "description": "Defines the resource properties.", "properties": { - "inventoryItemId": { - "description": "Gets or sets the inventory Item ID for the resource.", - "type": "string" - }, - "uuid": { + "availabilitySetName": { "type": "string", - "description": "Unique ID of the cloud.", + "description": "Name of the availability set.", "minLength": 1 }, "vmmServerId": { "type": "string", - "description": "ARM Id of the vmmServer resource in which this resource resides.", "format": "arm-id", + "description": "ARM Id of the vmmServer resource in which this resource resides.", "x-ms-arm-id-details": { "allowedResources": [ { @@ -2997,24 +3227,6 @@ ] } }, - "cloudName": { - "type": "string", - "description": "Name of the cloud in VMMServer.", - "readOnly": true - }, - "cloudCapacity": { - "$ref": "#/definitions/CloudCapacity", - "description": "Capacity of the cloud.", - "readOnly": true - }, - "storageQoSPolicies": { - "description": "List of QoS policies available for the cloud.", - "type": "array", - "items": { - "$ref": "#/definitions/StorageQoSPolicy" - }, - "readOnly": true - }, "provisioningState": { "$ref": "#/definitions/ResourceProvisioningState", "description": "Provisioning state of the resource.", @@ -3022,20 +3234,55 @@ } } }, - "Cloud": { + "AvailabilitySetTagsUpdate": { "type": "object", - "x-ms-azure-resource": true, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource", - "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'" + "description": "The type used for updating tags in AvailabilitySet resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } } - ], + } + }, + "Checkpoint": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "parentCheckpointID": { + "type": "string", + "description": "Gets ID of parent of the checkpoint.", + "x-ms-client-name": "parentCheckpointId" + }, + "checkpointID": { + "type": "string", + "description": "Gets ID of the checkpoint.", + "x-ms-client-name": "checkpointId" + }, + "name": { + "type": "string", + "description": "Gets name of the checkpoint." + }, + "description": { + "type": "string", + "description": "Gets description of the checkpoint." + } + } + }, + "Cloud": { + "type": "object", + "description": "The Clouds resource definition.", "properties": { "properties": { + "$ref": "#/definitions/CloudProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, - "description": "Resource properties.", - "$ref": "#/definitions/CloudProperties" + "x-ms-mutability": [ + "read", + "create" + ] }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", @@ -3043,47 +3290,87 @@ } }, "required": [ - "properties", "extendedLocation" ], - "description": "The Clouds resource definition." + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudCapacity": { + "type": "object", + "description": "Cloud Capacity model", + "properties": { + "cpuCount": { + "type": "integer", + "format": "int64", + "description": "CPUCount specifies the maximum number of CPUs that can be allocated in the cloud.", + "readOnly": true + }, + "memoryMB": { + "type": "integer", + "format": "int64", + "description": "MemoryMB specifies a memory usage limit in megabytes.", + "readOnly": true + }, + "vmCount": { + "type": "integer", + "format": "int64", + "description": "VMCount gives the max number of VMs that can be deployed in the cloud.", + "readOnly": true + } + } + }, + "CloudInventoryItem": { + "type": "object", + "description": "The Cloud inventory item.", + "allOf": [ + { + "$ref": "#/definitions/InventoryItemProperties" + } + ], + "x-ms-discriminator-value": "Cloud" }, "CloudListResult": { "type": "object", - "description": "List of Clouds.", + "description": "The response of a Cloud list operation.", "properties": { "value": { "type": "array", - "description": "List of Clouds.", + "description": "The Cloud items on this page", "items": { "$ref": "#/definitions/Cloud" } }, "nextLink": { "type": "string", - "description": "Url to follow for getting next page of resources.", "format": "uri", + "description": "The link to the next page of items", "readOnly": true } - } + }, + "required": [ + "value" + ] }, - "VirtualNetworkProperties": { - "description": "Defines the resource properties.", + "CloudProperties": { "type": "object", + "description": "Defines the resource properties.", "properties": { "inventoryItemId": { - "description": "Gets or sets the inventory Item ID for the resource.", - "type": "string" + "type": "string", + "description": "Gets or sets the inventory Item ID for the resource." }, "uuid": { "type": "string", - "description": "Unique ID of the virtual network.", - "minLength": 1 + "description": "Unique ID of the cloud.", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "vmmServerId": { "type": "string", - "description": "ARM Id of the vmmServer resource in which this resource resides.", "format": "arm-id", + "description": "ARM Id of the vmmServer resource in which this resource resides.", "x-ms-arm-id-details": { "allowedResources": [ { @@ -3092,11 +3379,25 @@ ] } }, - "networkName": { + "cloudName": { "type": "string", - "description": "Name of the virtual network in vmmServer.", + "description": "Name of the cloud in VmmServer.", + "readOnly": true + }, + "cloudCapacity": { + "$ref": "#/definitions/CloudCapacity", + "description": "Capacity of the cloud.", "readOnly": true }, + "storageQoSPolicies": { + "type": "array", + "description": "List of QoS policies available for the cloud.", + "items": { + "$ref": "#/definitions/StorageQosPolicy" + }, + "readOnly": true, + "x-ms-client-name": "storageQosPolicies" + }, "provisioningState": { "$ref": "#/definitions/ResourceProvisioningState", "description": "Provisioning state of the resource.", @@ -3104,265 +3405,160 @@ } } }, - "VirtualNetwork": { + "CloudTagsUpdate": { "type": "object", - "x-ms-azure-resource": true, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource", - "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'" - } - ], + "description": "The type used for updating tags in Cloud resources.", "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Resource properties.", - "$ref": "#/definitions/VirtualNetworkProperties" - }, - "extendedLocation": { - "$ref": "#/definitions/ExtendedLocation", - "description": "The extended location." + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } } - }, - "required": [ - "properties", - "extendedLocation" + } + }, + "CreateDiffDisk": { + "type": "string", + "description": "Create diff disk.", + "enum": [ + "true", + "false" ], - "description": "The VirtualNetworks resource definition." + "x-ms-enum": { + "name": "CreateDiffDisk", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable create diff disk." + }, + { + "name": "false", + "value": "false", + "description": "Disable create diff disk." + } + ] + } }, - "VirtualNetworkListResult": { - "type": "object", - "description": "List of VirtualNetworks.", - "properties": { - "value": { - "type": "array", - "description": "List of VirtualNetworks.", - "items": { - "$ref": "#/definitions/VirtualNetwork" + "DynamicMemoryEnabled": { + "type": "string", + "description": "Dynamic memory enabled.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "DynamicMemoryEnabled", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable dynamic memory." + }, + { + "name": "false", + "value": "false", + "description": "Disable dynamic memory." } - }, - "nextLink": { - "type": "string", - "description": "Url to follow for getting next page of resources.", - "format": "uri", - "readOnly": true - } + ] } }, - "AvailabilitySetProperties": { - "description": "Defines the resource properties.", + "ExtendedLocation": { "type": "object", + "description": "The extended location.", "properties": { - "availabilitySetName": { + "type": { "type": "string", - "description": "Name of the availability set.", - "minLength": 1 + "description": "The extended location type." }, - "vmmServerId": { + "name": { "type": "string", - "description": "ARM Id of the vmmServer resource in which this resource resides.", "format": "arm-id", + "description": "The extended location name.", "x-ms-arm-id-details": { "allowedResources": [ { - "type": "Microsoft.ScVmm/vmmServers" + "type": "Microsoft.ExtendedLocation/customLocations" } ] } - }, - "provisioningState": { - "$ref": "#/definitions/ResourceProvisioningState", - "description": "Provisioning state of the resource.", - "readOnly": true } } }, - "AvailabilitySet": { + "GuestAgent": { "type": "object", - "x-ms-azure-resource": true, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource", - "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'" - } - ], + "description": "Defines the GuestAgent.", "properties": { "properties": { + "$ref": "#/definitions/GuestAgentProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, - "description": "Resource properties.", - "$ref": "#/definitions/AvailabilitySetProperties" - }, - "extendedLocation": { - "$ref": "#/definitions/ExtendedLocation", - "description": "The extended location." + "x-ms-mutability": [ + "read", + "create" + ] } }, - "required": [ - "properties", - "extendedLocation" - ], - "description": "The AvailabilitySets resource definition." + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] }, - "AvailabilitySetListResult": { + "GuestAgentListResult": { "type": "object", - "description": "List of AvailabilitySets.", + "description": "The response of a GuestAgent list operation.", "properties": { "value": { "type": "array", - "description": "List of AvailabilitySets.", + "description": "The GuestAgent items on this page", "items": { - "$ref": "#/definitions/AvailabilitySet" + "$ref": "#/definitions/GuestAgent" } }, "nextLink": { "type": "string", - "description": "Url to follow for getting next page of resources.", "format": "uri", + "description": "The link to the next page of items", "readOnly": true } - } - }, - "AvailabilitySetList": { - "description": "Availability Sets in vm.", - "type": "array", - "items": { - "description": "Availability Set model", - "type": "object", - "properties": { - "id": { - "description": "Gets the ARM Id of the microsoft.scvmm/availabilitySets resource.", - "type": "string", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ScVmm/availabilitySets" - } - ] - } - }, - "name": { - "description": "Gets or sets the name of the availability set.", - "type": "string" - } - } - } + }, + "required": [ + "value" + ] }, - "InfrastructureProfile": { + "GuestAgentProperties": { "type": "object", + "description": "Defines the resource properties.", "properties": { - "inventoryItemId": { - "description": "Gets or sets the inventory Item ID for the resource.", - "type": "string" - }, - "vmmServerId": { + "uuid": { "type": "string", - "description": "ARM Id of the vmmServer resource in which this resource resides.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ScVmm/vmmServers" - } - ] - } + "description": "Gets a unique identifier for this resource.", + "readOnly": true }, - "cloudId": { - "type": "string", - "description": "ARM Id of the cloud resource to use for deploying the vm.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ScVmm/clouds" - } - ] - } + "credentials": { + "$ref": "#/definitions/GuestCredential", + "description": "Username / Password Credentials to provision guest agent." }, - "templateId": { - "type": "string", - "description": "ARM Id of the template resource to use for deploying the vm.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ScVmm/virtualMachineTemplates" - } - ] - } + "httpProxyConfig": { + "$ref": "#/definitions/HttpProxyConfiguration", + "description": "HTTP Proxy configuration for the VM." }, - "vmName": { - "type": "string", - "description": "VMName is the name of VM on the SCVMM server.", - "minLength": 1 + "provisioningAction": { + "$ref": "#/definitions/ProvisioningAction", + "description": "Gets or sets the guest agent provisioning action." }, - "uuid": { + "status": { "type": "string", - "description": "Unique ID of the virtual machine." - }, - "lastRestoredVMCheckpoint": { - "description": "Last restored checkpoint in the vm.", - "$ref": "#/definitions/Checkpoint", + "description": "Gets the guest agent status.", "readOnly": true }, - "checkpoints": { - "description": "Checkpoints in the vm.", - "type": "array", - "items": { - "description": "Checkpoint properties", - "$ref": "#/definitions/Checkpoint", - "readOnly": true - }, - "x-ms-identifiers": [ - "checkpointID" - ] - }, - "checkpointType": { - "type": "string", - "description": "Type of checkpoint supported for the vm." - }, - "generation": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the generation for the vm." - }, - "biosGuid": { - "type": "string", - "description": "Gets or sets the bios guid for the vm." - } - }, - "description": "Specifies the vmmServer infrastructure specific settings for the virtual machine instance." - }, - "VirtualMachineInstanceProperties": { - "description": "Defines the resource properties.", - "type": "object", - "properties": { - "availabilitySets": { - "$ref": "#/definitions/AvailabilitySetList" - }, - "osProfile": { - "description": "OS properties.", - "$ref": "#/definitions/OsProfileForVMInstance" - }, - "hardwareProfile": { - "description": "Hardware properties.", - "$ref": "#/definitions/HardwareProfile" - }, - "networkProfile": { - "description": "Network properties.", - "$ref": "#/definitions/NetworkProfile" - }, - "storageProfile": { - "description": "Storage properties.", - "$ref": "#/definitions/StorageProfile" - }, - "infrastructureProfile": { - "$ref": "#/definitions/InfrastructureProfile", - "description": "Gets the infrastructure profile." - }, - "powerState": { - "description": "Gets the power state of the virtual machine.", + "customResourceName": { "type": "string", + "description": "Gets the name of the corresponding resource in Kubernetes.", "readOnly": true }, "provisioningState": { @@ -3372,57 +3568,33 @@ } } }, - "OsType": { - "description": "Defines the different types of VM guest operating systems.", - "enum": [ - "Windows", - "Linux", - "Other" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "OsType" - }, - "type": "string", - "readOnly": true - }, - "OsProfileForVMInstance": { - "description": "Defines the resource properties.", + "GuestCredential": { "type": "object", + "description": "Username / Password Credentials to connect to guest.", "properties": { - "adminPassword": { - "description": "Admin password of the virtual machine.", + "username": { "type": "string", + "description": "Gets or sets username to connect with the guest." + }, + "password": { + "type": "string", + "format": "password", + "description": "Gets or sets the password to connect with the guest.", "x-ms-mutability": [ - "create", - "update" + "update", + "create" ], "x-ms-secret": true - }, - "computerName": { - "description": "Gets or sets computer name.", - "type": "string" - }, - "osType": { - "description": "Gets the type of the os.", - "$ref": "#/definitions/OsType", - "readOnly": true - }, - "osSku": { - "description": "Gets os sku.", - "type": "string", - "readOnly": true - }, - "osVersion": { - "description": "Gets os version.", - "type": "string", - "readOnly": true } - } + }, + "required": [ + "username", + "password" + ] }, "HardwareProfile": { - "description": "Defines the resource properties.", "type": "object", + "description": "Defines the resource properties.", "properties": { "memoryMB": { "type": "integer", @@ -3431,32 +3603,16 @@ }, "cpuCount": { "type": "integer", - "description": "Gets or sets the number of vCPUs for the vm.", - "format": "int32" + "format": "int32", + "description": "Gets or sets the number of vCPUs for the vm." }, "limitCpuForMigration": { - "type": "string", - "description": "Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs.", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "LimitCpuForMigration" - } + "$ref": "#/definitions/LimitCpuForMigration", + "description": "Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs." }, "dynamicMemoryEnabled": { - "type": "string", - "description": "Gets or sets a value indicating whether to enable dynamic memory or not.", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "DynamicMemoryEnabled" - } + "$ref": "#/definitions/DynamicMemoryEnabled", + "description": "Gets or sets a value indicating whether to enable dynamic memory or not." }, "dynamicMemoryMaxMB": { "type": "integer", @@ -3469,23 +3625,15 @@ "description": "Gets or sets the min dynamic memory for the vm." }, "isHighlyAvailable": { + "$ref": "#/definitions/IsHighlyAvailable", "description": "Gets highly available property.", - "type": "string", - "readOnly": true, - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "IsHighlyAvailable" - } + "readOnly": true } } }, "HardwareProfileUpdate": { - "description": "Defines the resource properties.", "type": "object", + "description": "Defines the resource update properties.", "properties": { "memoryMB": { "type": "integer", @@ -3494,32 +3642,16 @@ }, "cpuCount": { "type": "integer", - "description": "Gets or sets the number of vCPUs for the vm.", - "format": "int32" + "format": "int32", + "description": "Gets or sets the number of vCPUs for the vm." }, "limitCpuForMigration": { - "type": "string", - "description": "Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs.", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "LimitCpuForMigration" - } + "$ref": "#/definitions/LimitCpuForMigration", + "description": "Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs." }, "dynamicMemoryEnabled": { - "type": "string", - "description": "Gets or sets a value indicating whether to enable dynamic memory or not.", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "DynamicMemoryEnabled" - } + "$ref": "#/definitions/DynamicMemoryEnabled", + "description": "Gets or sets a value indicating whether to enable dynamic memory or not." }, "dynamicMemoryMaxMB": { "type": "integer", @@ -3533,495 +3665,1045 @@ } } }, - "Checkpoint": { - "description": "Defines the resource properties.", + "HttpProxyConfiguration": { + "type": "object", + "description": "HTTP Proxy configuration for the VM.", + "properties": { + "httpsProxy": { + "type": "string", + "description": "Gets or sets httpsProxy url." + } + } + }, + "InfrastructureProfile": { + "type": "object", + "description": "Specifies the vmmServer infrastructure specific settings for the virtual machine instance.", + "properties": { + "inventoryItemId": { + "type": "string", + "description": "Gets or sets the inventory Item ID for the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmmServerId": { + "type": "string", + "format": "arm-id", + "description": "ARM Id of the vmmServer resource in which this resource resides.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/vmmServers" + } + ] + } + }, + "cloudId": { + "type": "string", + "format": "arm-id", + "description": "ARM Id of the cloud resource to use for deploying the vm.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/clouds" + } + ] + } + }, + "templateId": { + "type": "string", + "format": "arm-id", + "description": "ARM Id of the template resource to use for deploying the vm.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/virtualMachineTemplates" + } + ] + } + }, + "vmName": { + "type": "string", + "description": "VMName is the name of VM on the SCVmm server.", + "minLength": 1, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "uuid": { + "type": "string", + "description": "Unique ID of the virtual machine.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "lastRestoredVMCheckpoint": { + "$ref": "#/definitions/Checkpoint", + "description": "Last restored checkpoint in the vm.", + "readOnly": true, + "x-ms-client-name": "lastRestoredVmCheckpoint" + }, + "checkpoints": { + "type": "array", + "description": "Checkpoints in the vm.", + "items": { + "$ref": "#/definitions/Checkpoint" + }, + "readOnly": true, + "x-ms-identifiers": [ + "checkpointID" + ] + }, + "checkpointType": { + "type": "string", + "description": "Type of checkpoint supported for the vm.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "generation": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the generation for the vm.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the bios guid for the vm.", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "InfrastructureProfileUpdate": { + "type": "object", + "description": "Specifies the vmmServer infrastructure specific update settings for the virtual machine instance.", + "properties": { + "checkpointType": { + "type": "string", + "description": "Type of checkpoint supported for the vm.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "InventoryItem": { + "type": "object", + "description": "Defines the inventory item.", + "properties": { + "properties": { + "$ref": "#/definitions/InventoryItemProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "kind": { + "type": "string", + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "InventoryItemDetails": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "inventoryItemId": { + "type": "string", + "description": "Gets or sets the inventory Item ID for the resource." + }, + "inventoryItemName": { + "type": "string", + "description": "Gets or sets the Managed Object name in Vmm for the resource." + } + } + }, + "InventoryItemListResult": { + "type": "object", + "description": "The response of a InventoryItem list operation.", + "properties": { + "value": { + "type": "array", + "description": "The InventoryItem items on this page", + "items": { + "$ref": "#/definitions/InventoryItem" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "InventoryItemProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "inventoryType": { + "$ref": "#/definitions/InventoryType", + "description": "They inventory type." + }, + "managedResourceId": { + "type": "string", + "description": "Gets the tracked resource id corresponding to the inventory resource.", + "readOnly": true + }, + "uuid": { + "type": "string", + "description": "Gets the UUID (which is assigned by Vmm) for the inventory item.", + "readOnly": true + }, + "inventoryItemName": { + "type": "string", + "description": "Gets the Managed Object name in Vmm for the inventory item.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ResourceProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "discriminator": "inventoryType", + "required": [ + "inventoryType" + ] + }, + "InventoryType": { + "type": "string", + "description": "The inventory type", + "enum": [ + "Cloud", + "VirtualNetwork", + "VirtualMachine", + "VirtualMachineTemplate" + ], + "x-ms-enum": { + "name": "InventoryType", + "modelAsString": true, + "values": [ + { + "name": "Cloud", + "value": "Cloud", + "description": "Cloud inventory type" + }, + { + "name": "VirtualNetwork", + "value": "VirtualNetwork", + "description": "VirtualNetwork inventory type" + }, + { + "name": "VirtualMachine", + "value": "VirtualMachine", + "description": "VirtualMachine inventory type" + }, + { + "name": "VirtualMachineTemplate", + "value": "VirtualMachineTemplate", + "description": "VirtualMachineTemplate inventory type" + } + ] + } + }, + "IsCustomizable": { + "type": "string", + "description": "Customizable.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "IsCustomizable", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable customizable." + }, + { + "name": "false", + "value": "false", + "description": "Disable customizable." + } + ] + } + }, + "IsHighlyAvailable": { + "type": "string", + "description": "Highly available.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "IsHighlyAvailable", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable highly available." + }, + { + "name": "false", + "value": "false", + "description": "Disable highly available." + } + ] + } + }, + "LimitCpuForMigration": { + "type": "string", + "description": "Limit CPU for migration.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "LimitCpuForMigration", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable limit CPU for migration." + }, + { + "name": "false", + "value": "false", + "description": "Disable limit CPU for migration." + } + ] + } + }, + "NetworkInterface": { + "type": "object", + "description": "Network Interface model", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the network interface." + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set.", + "readOnly": true + }, + "ipv4Addresses": { + "type": "array", + "description": "Gets the nic ipv4 addresses.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ipv6Addresses": { + "type": "array", + "description": "Gets the nic ipv6 addresses.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "macAddress": { + "type": "string", + "description": "Gets or sets the nic MAC address." + }, + "virtualNetworkId": { + "type": "string", + "format": "arm-id", + "description": "Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/virtualNetwork" + } + ] + } + }, + "networkName": { + "type": "string", + "description": "Gets the name of the virtual network in vmmServer that the nic is connected to.", + "readOnly": true + }, + "ipv4AddressType": { + "$ref": "#/definitions/AllocationMethod", + "description": "Gets or sets the ipv4 address type." + }, + "ipv6AddressType": { + "$ref": "#/definitions/AllocationMethod", + "description": "Gets or sets the ipv6 address type." + }, + "macAddressType": { + "$ref": "#/definitions/AllocationMethod", + "description": "Gets or sets the mac address type." + }, + "nicId": { + "type": "string", + "description": "Gets or sets the nic id." + } + } + }, + "NetworkInterfaceUpdate": { + "type": "object", + "description": "Network Interface Update model", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the network interface." + }, + "macAddress": { + "type": "string", + "description": "Gets or sets the nic MAC address." + }, + "virtualNetworkId": { + "type": "string", + "format": "arm-id", + "description": "Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/virtualNetwork" + } + ] + } + }, + "ipv4AddressType": { + "$ref": "#/definitions/AllocationMethod", + "description": "Gets or sets the ipv4 address type." + }, + "ipv6AddressType": { + "$ref": "#/definitions/AllocationMethod", + "description": "Gets or sets the ipv6 address type." + }, + "macAddressType": { + "$ref": "#/definitions/AllocationMethod", + "description": "Gets or sets the mac address type." + }, + "nicId": { + "type": "string", + "description": "Gets or sets the nic id." + } + } + }, + "NetworkProfile": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "Gets or sets the list of network interfaces associated with the virtual machine.", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "x-ms-identifiers": [ + "name", + "nicId" + ] + } + } + }, + "NetworkProfileUpdate": { + "type": "object", + "description": "Defines the resource update properties.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "Gets or sets the list of network interfaces associated with the virtual machine.", + "items": { + "$ref": "#/definitions/NetworkInterfaceUpdate" + }, + "x-ms-identifiers": [ + "name", + "nicId" + ] + } + } + }, + "OsProfileForVmInstance": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "adminPassword": { + "type": "string", + "format": "password", + "description": "Admin password of the virtual machine.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "computerName": { + "type": "string", + "description": "Gets or sets computer name." + }, + "osType": { + "$ref": "#/definitions/OsType", + "description": "Gets the type of the os.", + "readOnly": true + }, + "osSku": { + "type": "string", + "description": "Gets os sku.", + "readOnly": true + }, + "osVersion": { + "type": "string", + "description": "Gets os version.", + "readOnly": true + } + } + }, + "OsType": { + "type": "string", + "description": "Virtual machine operating system type.", + "enum": [ + "Windows", + "Linux", + "Other" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "Windows operating system." + }, + { + "name": "Linux", + "value": "Linux", + "description": "Linux operating system." + }, + { + "name": "Other", + "value": "Other", + "description": "Other operating system." + } + ] + } + }, + "ProvisioningAction": { + "type": "string", + "description": "Guest agent provisioning action.", + "enum": [ + "install", + "uninstall", + "repair" + ], + "x-ms-enum": { + "name": "ProvisioningAction", + "modelAsString": true, + "values": [ + { + "name": "install", + "value": "install", + "description": "Install guest agent." + }, + { + "name": "uninstall", + "value": "uninstall", + "description": "Uninstall guest agent." + }, + { + "name": "repair", + "value": "repair", + "description": "Repair guest agent." + } + ] + } + }, + "ResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of the resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted", + "Created" + ], + "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." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "The resource is provisioning." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource has been accepted." + }, + { + "name": "Created", + "value": "Created", + "description": "The resource was created." + } + ] + }, + "readOnly": true + }, + "StopVirtualMachineOptions": { "type": "object", + "description": "Defines the stop action properties.", "properties": { - "parentCheckpointID": { - "description": "Gets ID of parent of the checkpoint.", - "type": "string" - }, - "checkpointID": { - "description": "Gets ID of the checkpoint.", - "type": "string" - }, - "name": { - "description": "Gets name of the checkpoint.", - "type": "string" - }, - "description": { - "description": "Gets description of the checkpoint.", - "type": "string" + "skipShutdown": { + "type": "string", + "description": "Gets or sets a value indicating whether to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Defaults to false.", + "default": "false", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "SkipShutdown", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable skip shutdown." + }, + { + "name": "false", + "value": "false", + "description": "Disable skip shutdown." + } + ] + } } } }, - "NetworkProfileUpdate": { - "description": "Defines the resource properties.", + "StorageProfile": { "type": "object", + "description": "Defines the resource properties.", "properties": { - "networkInterfaces": { - "description": "Gets or sets the list of network interfaces associated with the virtual machine.", + "disks": { "type": "array", + "description": "Gets or sets the list of virtual disks associated with the virtual machine.", "items": { - "$ref": "#/definitions/NetworkInterfaceUpdate" + "$ref": "#/definitions/VirtualDisk" }, "x-ms-identifiers": [ - "name", - "nicId" + "diskId", + "name" ] } } }, - "NetworkProfile": { - "description": "Defines the resource properties.", + "StorageProfileUpdate": { "type": "object", + "description": "Defines the resource update properties.", "properties": { - "networkInterfaces": { - "description": "Gets or sets the list of network interfaces associated with the virtual machine.", + "disks": { "type": "array", + "description": "Gets or sets the list of virtual disks associated with the virtual machine.", "items": { - "$ref": "#/definitions/NetworkInterface" + "$ref": "#/definitions/VirtualDiskUpdate" }, "x-ms-identifiers": [ - "name", - "nicId" + "diskId", + "name" ] } } }, - "AllocationMethod": { - "description": "Allocation method.", - "enum": [ - "Dynamic", - "Static" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "AllocationMethod" - }, - "type": "string" - }, - "NetworkInterface": { - "description": "Network Interface model", + "StorageQosPolicy": { "type": "object", + "description": "The StorageQoSPolicy definition.", "properties": { "name": { - "description": "Gets or sets the name of the network interface.", - "type": "string" - }, - "displayName": { - "description": "Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set.", - "type": "string", - "readOnly": true - }, - "ipv4Addresses": { - "description": "Gets the nic ipv4 addresses.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "ipv6Addresses": { - "description": "Gets the nic ipv6 addresses.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "macAddress": { - "description": "Gets or sets the nic MAC address.", - "type": "string" - }, - "virtualNetworkId": { - "description": "Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic.", - "type": "string", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ScVmm/virtualNetwork" - } - ] - } - }, - "networkName": { - "description": "Gets the name of the virtual network in vmmServer that the nic is connected to.", "type": "string", - "readOnly": true - }, - "ipv4AddressType": { - "description": "Gets or sets the ipv4 address type.", - "$ref": "#/definitions/AllocationMethod" - }, - "ipv6AddressType": { - "description": "Gets or sets the ipv6 address type.", - "$ref": "#/definitions/AllocationMethod" - }, - "macAddressType": { - "description": "Gets or sets the mac address type.", - "$ref": "#/definitions/AllocationMethod" - }, - "nicId": { - "description": "Gets or sets the nic id.", - "type": "string" - } - } - }, - "NetworkInterfaceUpdate": { - "description": "Network Interface model", - "type": "object", - "properties": { - "name": { - "description": "Gets or sets the name of the network interface.", - "type": "string" - }, - "macAddress": { - "description": "Gets or sets the nic MAC address.", - "type": "string" + "description": "The name of the policy." }, - "virtualNetworkId": { - "description": "Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic.", + "id": { "type": "string", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ScVmm/virtualNetwork" - } - ] - } - }, - "ipv4AddressType": { - "description": "Gets or sets the ipv4 address type.", - "$ref": "#/definitions/AllocationMethod" + "description": "The ID of the QoS policy." }, - "ipv6AddressType": { - "description": "Gets or sets the ipv6 address type.", - "$ref": "#/definitions/AllocationMethod" - }, - "macAddressType": { - "description": "Gets or sets the mac address type.", - "$ref": "#/definitions/AllocationMethod" - }, - "nicId": { - "description": "Gets or sets the nic id.", - "type": "string" - } - } - }, - "CloudCapacity": { - "description": "Cloud Capacity model", - "type": "object", - "properties": { - "cpuCount": { + "iopsMaximum": { "type": "integer", "format": "int64", - "description": "CPUCount specifies the maximum number of CPUs that can be allocated in the cloud." + "description": "The maximum IO operations per second." }, - "memoryMB": { + "iopsMinimum": { "type": "integer", "format": "int64", - "description": "MemoryMB specifies a memory usage limit in megabytes." + "description": "The minimum IO operations per second." }, - "vmCount": { + "bandwidthLimit": { "type": "integer", "format": "int64", - "description": "VMCount gives the max number of VMs that can be deployed in the cloud." + "description": "The Bandwidth Limit for internet traffic." + }, + "policyId": { + "type": "string", + "description": "The underlying policy." } - }, - "readOnly": true + } }, - "StorageQoSPolicyDetails": { - "description": "The StorageQoSPolicyDetails definition.", + "StorageQosPolicyDetails": { "type": "object", + "description": "The StorageQoSPolicyDetails definition.", "properties": { "name": { - "description": "The name of the policy.", - "type": "string" + "type": "string", + "description": "The name of the policy." }, "id": { - "description": "The ID of the QoS policy.", - "type": "string" + "type": "string", + "description": "The ID of the QoS policy." } } }, "VirtualDisk": { - "description": "Virtual disk model", "type": "object", + "description": "Virtual disk model", "properties": { "name": { - "description": "Gets or sets the name of the disk.", - "type": "string" + "type": "string", + "description": "Gets or sets the name of the disk." }, "displayName": { - "description": "Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set.", "type": "string", + "description": "Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set.", "readOnly": true }, "diskId": { - "description": "Gets or sets the disk id.", - "type": "string" + "type": "string", + "description": "Gets or sets the disk id." }, "diskSizeGB": { + "type": "integer", "format": "int32", - "description": "Gets or sets the disk total size.", - "type": "integer" + "description": "Gets or sets the disk total size." }, "maxDiskSizeGB": { + "type": "integer", "format": "int32", "description": "Gets the max disk size.", - "type": "integer", "readOnly": true }, "bus": { + "type": "integer", "format": "int32", - "description": "Gets or sets the disk bus.", - "type": "integer" + "description": "Gets or sets the disk bus." }, "lun": { + "type": "integer", "format": "int32", - "description": "Gets or sets the disk lun.", - "type": "integer" + "description": "Gets or sets the disk lun." }, "busType": { - "description": "Gets or sets the disk bus type.", - "type": "string" + "type": "string", + "description": "Gets or sets the disk bus type." }, "vhdType": { - "description": "Gets or sets the disk vhd type.", - "type": "string" + "type": "string", + "description": "Gets or sets the disk vhd type." }, "volumeType": { - "description": "Gets the disk volume type.", "type": "string", + "description": "Gets the disk volume type.", "readOnly": true }, "vhdFormatType": { - "description": "Gets the disk vhd format type.", "type": "string", + "description": "Gets the disk vhd format type.", "readOnly": true }, "templateDiskId": { + "type": "string", "description": "Gets or sets the disk id in the template.", - "type": "string" + "x-ms-mutability": [ + "read", + "create" + ] }, "storageQoSPolicy": { + "$ref": "#/definitions/StorageQosPolicyDetails", "description": "The QoS policy for the disk.", - "$ref": "#/definitions/StorageQoSPolicyDetails" + "x-ms-client-name": "storageQosPolicy" }, "createDiffDisk": { - "type": "string", - "description": "Gets or sets a value indicating diff disk.", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "CreateDiffDisk" - } - } - } - }, - "VirtualDiskUpdate": { - "description": "Virtual disk model", - "type": "object", - "properties": { - "name": { - "description": "Gets or sets the name of the disk.", - "type": "string" - }, - "diskId": { - "description": "Gets or sets the disk id.", - "type": "string" - }, - "diskSizeGB": { - "format": "int32", - "description": "Gets or sets the disk total size.", - "type": "integer" - }, - "bus": { - "format": "int32", - "description": "Gets or sets the disk bus.", - "type": "integer" - }, - "lun": { - "format": "int32", - "description": "Gets or sets the disk lun.", - "type": "integer" - }, - "busType": { - "description": "Gets or sets the disk bus type.", - "type": "string" - }, - "vhdType": { - "description": "Gets or sets the disk vhd type.", - "type": "string" - }, - "storageQoSPolicy": { - "description": "The QoS policy for the disk.", - "$ref": "#/definitions/StorageQoSPolicyDetails" - } - } - }, - "StorageProfileUpdate": { - "description": "Defines the resource properties.", - "type": "object", - "properties": { - "disks": { - "description": "Gets or sets the list of virtual disks associated with the virtual machine.", - "type": "array", - "items": { - "$ref": "#/definitions/VirtualDiskUpdate" - }, - "x-ms-identifiers": [ - "name", - "diskId" - ] - } - } - }, - "StorageProfile": { - "description": "Defines the resource properties.", - "type": "object", - "properties": { - "disks": { - "description": "Gets or sets the list of virtual disks associated with the virtual machine.", - "type": "array", - "items": { - "$ref": "#/definitions/VirtualDisk" - }, - "x-ms-identifiers": [ - "name", - "diskId" - ] - } - } - }, - "StopVirtualMachineOptions": { - "description": "Defines the stop action properties.", - "type": "object", - "properties": { - "skipShutdown": { - "description": "Gets or sets a value indicating whether to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Defaults to false.", - "type": "string", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "SkipShutdown" - }, - "default": "false" + "$ref": "#/definitions/CreateDiffDisk", + "description": "Gets or sets a value indicating diff disk.", + "x-ms-mutability": [ + "read", + "create" + ] } } }, - "VirtualMachineCreateCheckpoint": { - "description": "Defines the create checkpoint action properties.", + "VirtualDiskUpdate": { "type": "object", + "description": "Virtual Disk Update model", "properties": { "name": { - "description": "Name of the checkpoint.", - "type": "string" + "type": "string", + "description": "Gets or sets the name of the disk." }, - "description": { - "description": "Description of the checkpoint.", - "type": "string" + "diskId": { + "type": "string", + "description": "Gets or sets the disk id." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the disk total size." + }, + "bus": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the disk bus." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the disk lun." + }, + "busType": { + "type": "string", + "description": "Gets or sets the disk bus type." + }, + "vhdType": { + "type": "string", + "description": "Gets or sets the disk vhd type." + }, + "storageQoSPolicy": { + "$ref": "#/definitions/StorageQosPolicyDetails", + "description": "The QoS policy for the disk.", + "x-ms-client-name": "storageQosPolicy" } } }, - "VirtualMachineDeleteCheckpoint": { - "description": "Defines the delete checkpoint action properties.", + "VirtualMachineCreateCheckpoint": { "type": "object", + "description": "Defines the create checkpoint action properties.", "properties": { - "id": { - "description": "ID of the checkpoint to be deleted.", - "type": "string" + "name": { + "type": "string", + "description": "Name of the checkpoint." + }, + "description": { + "type": "string", + "description": "Description of the checkpoint." } } }, - "VirtualMachineRestoreCheckpoint": { - "description": "Defines the restore checkpoint action properties.", + "VirtualMachineDeleteCheckpoint": { "type": "object", + "description": "Defines the delete checkpoint action properties.", "properties": { "id": { - "description": "ID of the checkpoint to be restored to.", - "type": "string" + "type": "string", + "description": "ID of the checkpoint to be deleted." } } }, "VirtualMachineInstance": { - "description": "Define the virtualMachineInstance.", - "required": [ - "properties", - "extendedLocation" - ], "type": "object", - "x-ms-azure-resource": true, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource", - "description": "The resource model definition for an Azure Resource Manager proxy resource. It will have everything other than location and tags." - } - ], + "description": "Define the virtualMachineInstance.", "properties": { "properties": { + "$ref": "#/definitions/VirtualMachineInstanceProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, - "description": "Resource properties.", - "$ref": "#/definitions/VirtualMachineInstanceProperties" + "x-ms-mutability": [ + "read", + "create" + ] }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", - "description": "Gets or sets the extended location." + "description": "Gets or sets the extended location.", + "x-ms-mutability": [ + "read", + "create" + ] } - } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] }, "VirtualMachineInstanceListResult": { "type": "object", - "description": "List of VirtualMachineInstances.", + "description": "The response of a VirtualMachineInstance list operation.", "properties": { "value": { "type": "array", - "description": "Array of VirtualMachineInstances.", + "description": "The VirtualMachineInstance items on this page", "items": { "$ref": "#/definitions/VirtualMachineInstance" } }, "nextLink": { "type": "string", - "description": "Url to follow for getting next page of resources.", "format": "uri", + "description": "The link to the next page of items", "readOnly": true } - } + }, + "required": [ + "value" + ] }, - "InfrastructureProfileUpdate": { + "VirtualMachineInstanceProperties": { "type": "object", + "description": "Defines the resource properties.", "properties": { - "checkpointType": { + "availabilitySets": { + "type": "array", + "description": "Availability Sets in vm.", + "items": { + "$ref": "#/definitions/AvailabilitySetListItem" + } + }, + "osProfile": { + "$ref": "#/definitions/OsProfileForVmInstance", + "description": "OS properties.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Hardware properties." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Network properties." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Storage properties." + }, + "infrastructureProfile": { + "$ref": "#/definitions/InfrastructureProfile", + "description": "Gets the infrastructure profile." + }, + "powerState": { "type": "string", - "description": "Type of checkpoint supported for the vm." + "description": "Gets the power state of the virtual machine.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ResourceProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true } - }, - "description": "Specifies the vmmServer infrastructure specific settings for the virtual machine instance for update." + } + }, + "VirtualMachineInstanceUpdate": { + "type": "object", + "description": "The type used for update operations of the VirtualMachineInstance.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineInstanceUpdateProperties", + "description": "The update properties of the VirtualMachineInstance.", + "x-ms-client-flatten": true + } + } }, "VirtualMachineInstanceUpdateProperties": { - "description": "Defines the resource properties.", "type": "object", + "description": "Virtual Machine Instance Properties Update model", "properties": { - "hardwareProfile": { - "$ref": "#/definitions/HardwareProfileUpdate" + "availabilitySets": { + "type": "array", + "description": "Availability Sets in vm.", + "items": { + "$ref": "#/definitions/AvailabilitySetListItem" + } }, - "storageProfile": { - "$ref": "#/definitions/StorageProfileUpdate" + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfileUpdate", + "description": "Hardware properties." }, "networkProfile": { - "$ref": "#/definitions/NetworkProfileUpdate" + "$ref": "#/definitions/NetworkProfileUpdate", + "description": "Network properties." }, - "availabilitySets": { - "$ref": "#/definitions/AvailabilitySetList" + "storageProfile": { + "$ref": "#/definitions/StorageProfileUpdate", + "description": "Storage properties." }, "infrastructureProfile": { "$ref": "#/definitions/InfrastructureProfileUpdate", @@ -4029,34 +4711,173 @@ } } }, - "VirtualMachineInstanceUpdate": { - "description": "Defines the virtualMachineInstanceUpdate.", + "VirtualMachineInventoryItem": { + "type": "object", + "description": "The Virtual machine inventory item.", + "properties": { + "osType": { + "$ref": "#/definitions/OsType", + "description": "Gets the type of the os.", + "readOnly": true + }, + "osName": { + "type": "string", + "description": "Gets os name.", + "readOnly": true + }, + "osVersion": { + "type": "string", + "description": "Gets os version.", + "readOnly": true + }, + "powerState": { + "type": "string", + "description": "Gets the power state of the virtual machine.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "Gets or sets the nic ip addresses.", + "items": { + "type": "string" + } + }, + "cloud": { + "$ref": "#/definitions/InventoryItemDetails", + "description": "Cloud inventory resource details where the VM is present." + }, + "biosGuid": { + "type": "string", + "description": "Gets the bios guid.", + "readOnly": true + }, + "managedMachineResourceId": { + "type": "string", + "format": "arm-id", + "description": "Gets the tracked resource id corresponding to the inventory resource.", + "readOnly": true, + "x-ms-arm-id-details": { + "allowedResources": [] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/InventoryItemProperties" + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "VirtualMachineRestoreCheckpoint": { + "type": "object", + "description": "Defines the restore checkpoint action properties.", + "properties": { + "id": { + "type": "string", + "description": "ID of the checkpoint to be restored to." + } + } + }, + "VirtualMachineTemplate": { "type": "object", + "description": "The VirtualMachineTemplates resource definition.", "properties": { "properties": { + "$ref": "#/definitions/VirtualMachineTemplateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, - "description": "Resource properties.", - "$ref": "#/definitions/VirtualMachineInstanceUpdateProperties" + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location." } - } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "VirtualMachineTemplateInventoryItem": { + "type": "object", + "description": "The Virtual machine template inventory item.", + "properties": { + "cpuCount": { + "type": "integer", + "format": "int32", + "description": "Gets the desired number of vCPUs for the vm.", + "readOnly": true + }, + "memoryMB": { + "type": "integer", + "format": "int32", + "description": "MemoryMB is the desired size of a virtual machine's memory, in MB.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OsType", + "description": "Gets the type of the os.", + "readOnly": true + }, + "osName": { + "type": "string", + "description": "Gets os name.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/InventoryItemProperties" + } + ], + "x-ms-discriminator-value": "VirtualMachineTemplate" + }, + "VirtualMachineTemplateListResult": { + "type": "object", + "description": "The response of a VirtualMachineTemplate list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachineTemplate items on this page", + "items": { + "$ref": "#/definitions/VirtualMachineTemplate" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] }, "VirtualMachineTemplateProperties": { - "description": "Defines the resource properties.", "type": "object", + "description": "Defines the resource properties.", "properties": { "inventoryItemId": { - "description": "Gets or sets the inventory Item ID for the resource.", - "type": "string" + "type": "string", + "description": "Gets or sets the inventory Item ID for the resource." }, "uuid": { "type": "string", "description": "Unique ID of the virtual machine template.", - "minLength": 1 + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "vmmServerId": { "type": "string", - "description": "ARM Id of the vmmServer resource in which this resource resides.", "format": "arm-id", + "description": "ARM Id of the vmmServer resource in which this resource resides.", "x-ms-arm-id-details": { "allowedResources": [ { @@ -4066,18 +4887,18 @@ } }, "osType": { - "description": "Gets the type of the os.", "$ref": "#/definitions/OsType", + "description": "Gets the type of the os.", "readOnly": true }, "osName": { - "description": "Gets os name.", "type": "string", + "description": "Gets os name.", "readOnly": true }, "computerName": { - "description": "Gets computer name.", "type": "string", + "description": "Gets computer name.", "readOnly": true }, "memoryMB": { @@ -4088,47 +4909,23 @@ }, "cpuCount": { "type": "integer", - "description": "Gets the desired number of vCPUs for the vm.", "format": "int32", + "description": "Gets the desired number of vCPUs for the vm.", "readOnly": true }, "limitCpuForMigration": { - "type": "string", + "$ref": "#/definitions/LimitCpuForMigration", "description": "Gets a value indicating whether to enable processor compatibility mode for live migration of VMs.", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "LimitCpuForMigration" - }, "readOnly": true }, "dynamicMemoryEnabled": { - "type": "string", + "$ref": "#/definitions/DynamicMemoryEnabled", "description": "Gets a value indicating whether to enable dynamic memory or not.", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "DynamicMemoryEnabled" - }, "readOnly": true }, "isCustomizable": { - "type": "string", + "$ref": "#/definitions/IsCustomizable", "description": "Gets a value indicating whether the vm template is customizable or not.", - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "IsCustomizable" - }, "readOnly": true }, "dynamicMemoryMaxMB": { @@ -4144,17 +4941,9 @@ "readOnly": true }, "isHighlyAvailable": { + "$ref": "#/definitions/IsHighlyAvailable", "description": "Gets highly available property.", - "type": "string", - "readOnly": true, - "enum": [ - "false", - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "IsHighlyAvailable" - } + "readOnly": true }, "generation": { "type": "integer", @@ -4163,28 +4952,28 @@ "readOnly": true }, "networkInterfaces": { - "description": "Gets the network interfaces of the template.", "type": "array", + "description": "Gets the network interfaces of the template.", "items": { "$ref": "#/definitions/NetworkInterface" }, + "readOnly": true, "x-ms-identifiers": [ "name", "nicId" - ], - "readOnly": true + ] }, "disks": { - "description": "Gets the disks of the template.", "type": "array", + "description": "Gets the disks of the template.", "items": { "$ref": "#/definitions/VirtualDisk" }, + "readOnly": true, "x-ms-identifiers": [ - "name", - "diskId" - ], - "readOnly": true + "diskId", + "name" + ] }, "provisioningState": { "$ref": "#/definitions/ResourceProvisioningState", @@ -4193,173 +4982,49 @@ } } }, - "VirtualMachineTemplate": { - "type": "object", - "x-ms-azure-resource": true, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource", - "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Resource properties.", - "$ref": "#/definitions/VirtualMachineTemplateProperties" - }, - "extendedLocation": { - "$ref": "#/definitions/ExtendedLocation", - "description": "The extended location." - } - }, - "required": [ - "properties", - "extendedLocation" - ], - "description": "The VirtualMachineTemplates resource definition." - }, - "VirtualMachineTemplateListResult": { + "VirtualMachineTemplateTagsUpdate": { "type": "object", - "description": "List of VirtualMachineTemplates.", + "description": "The type used for updating tags in VirtualMachineTemplate resources.", "properties": { - "value": { - "description": "List of VirtualMachineTemplates.", - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineTemplate" + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" } - }, - "nextLink": { - "type": "string", - "description": "Url to follow for getting next page of resources.", - "format": "uri", - "readOnly": true } } }, - "InventoryItemsList": { - "description": "List of InventoryItems.", - "type": "object", - "properties": { - "nextLink": { - "description": "Url to follow for getting next page of InventoryItems.", - "type": "string", - "format": "uri", - "readOnly": true - }, - "value": { - "description": "Array of InventoryItems", - "type": "array", - "items": { - "$ref": "#/definitions/InventoryItem" - } - } - }, - "required": [ - "value" - ] - }, - "InventoryItem": { - "description": "Defines the inventory item.", - "required": [ - "properties" - ], + "VirtualNetwork": { "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource", - "description": "The resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags." - } - ], + "description": "The VirtualNetworks resource definition.", "properties": { "properties": { + "$ref": "#/definitions/VirtualNetworkProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, - "description": "Resource properties.", - "$ref": "#/definitions/InventoryItemProperties" + "x-ms-mutability": [ + "read", + "create" + ] }, - "kind": { - "type": "string", - "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value." + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location." } }, - "x-ms-azure-resource": true - }, - "InventoryItemProperties": { - "description": "Defines the resource properties.", "required": [ - "inventoryType" - ], - "discriminator": "inventoryType", - "type": "object", - "properties": { - "inventoryType": { - "description": "They inventory type.", - "$ref": "#/definitions/InventoryType" - }, - "managedResourceId": { - "description": "Gets the tracked resource id corresponding to the inventory resource.", - "type": "string", - "readOnly": true - }, - "uuid": { - "description": "Gets the UUID (which is assigned by VMM) for the inventory item.", - "type": "string", - "readOnly": true - }, - "inventoryItemName": { - "description": "Gets the Managed Object name in VMM for the inventory item.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "$ref": "#/definitions/ResourceProvisioningState", - "description": "Provisioning state of the resource.", - "readOnly": true - } - } - }, - "InventoryType": { - "type": "string", - "description": "The inventory type.", - "enum": [ - "Cloud", - "VirtualNetwork", - "VirtualMachineTemplate", - "VirtualMachine" + "extendedLocation" ], - "x-ms-enum": { - "name": "InventoryType", - "modelAsString": true - } - }, - "InventoryItemDetails": { - "description": "Defines the resource properties.", - "type": "object", - "properties": { - "inventoryItemId": { - "description": "Gets or sets the inventory Item ID for the resource.", - "type": "string" - }, - "inventoryItemName": { - "description": "Gets or sets the Managed Object name in VMM for the resource.", - "type": "string" - } - } - }, - "CloudInventoryItem": { - "description": "The Cloud inventory item.", - "type": "object", "allOf": [ { - "$ref": "#/definitions/InventoryItemProperties" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } - ], - "x-ms-discriminator-value": "Cloud" + ] }, "VirtualNetworkInventoryItem": { - "description": "The Virtual network inventory item.", "type": "object", + "description": "The Virtual network inventory item.", "allOf": [ { "$ref": "#/definitions/InventoryItemProperties" @@ -4367,148 +5032,131 @@ ], "x-ms-discriminator-value": "VirtualNetwork" }, - "VirtualMachineTemplateInventoryItem": { - "description": "The Virtual machine template inventory item.", + "VirtualNetworkListResult": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/InventoryItemProperties" - } - ], + "description": "The response of a VirtualNetwork list operation.", "properties": { - "cpuCount": { - "type": "integer", - "description": "Gets the desired number of vCPUs for the vm.", - "format": "int32", - "readOnly": true - }, - "memoryMB": { - "type": "integer", - "format": "int32", - "description": "MemoryMB is the desired size of a virtual machine's memory, in MB.", - "readOnly": true - }, - "osType": { - "description": "Gets the type of the os.", - "$ref": "#/definitions/OsType", - "readOnly": true + "value": { + "type": "array", + "description": "The VirtualNetwork items on this page", + "items": { + "$ref": "#/definitions/VirtualNetwork" + } }, - "osName": { - "description": "Gets os name.", + "nextLink": { "type": "string", + "format": "uri", + "description": "The link to the next page of items", "readOnly": true } }, - "x-ms-discriminator-value": "VirtualMachineTemplate" + "required": [ + "value" + ] }, - "VirtualMachineInventoryItem": { - "description": "The Virtual machine inventory item.", + "VirtualNetworkProperties": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/InventoryItemProperties" - } - ], + "description": "Defines the resource properties.", "properties": { - "osType": { - "description": "Gets the type of the os.", - "$ref": "#/definitions/OsType", - "readOnly": true - }, - "osName": { - "description": "Gets os name.", + "inventoryItemId": { "type": "string", - "readOnly": true + "description": "Gets or sets the inventory Item ID for the resource." }, - "osVersion": { - "description": "Gets os version.", + "uuid": { "type": "string", - "readOnly": true + "description": "Unique ID of the virtual network.", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, - "powerState": { - "description": "Gets the power state of the virtual machine.", + "vmmServerId": { "type": "string", - "readOnly": true - }, - "ipAddresses": { - "description": "Gets or sets the nic ip addresses.", - "type": "array", - "items": { - "type": "string" + "format": "arm-id", + "description": "ARM Id of the vmmServer resource in which this resource resides.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/vmmServers" + } + ] } }, - "cloud": { - "description": "Cloud inventory resource details where the VM is present.", - "$ref": "#/definitions/InventoryItemDetails" - }, - "biosGuid": { - "description": "Gets the bios guid.", + "networkName": { "type": "string", + "description": "Name of the virtual network in vmmServer.", "readOnly": true }, - "managedMachineResourceId": { - "description": "Gets the tracked resource id corresponding to the inventory resource.", - "type": "string", - "format": "arm-id", + "provisioningState": { + "$ref": "#/definitions/ResourceProvisioningState", + "description": "Provisioning state of the resource.", "readOnly": true } - }, - "x-ms-discriminator-value": "VirtualMachine" + } }, - "VmInstanceHybridIdentityMetadataList": { - "description": "List of HybridIdentityMetadata.", + "VirtualNetworkTagsUpdate": { "type": "object", + "description": "The type used for updating tags in VirtualNetwork resources.", "properties": { - "nextLink": { - "description": "Url to follow for getting next page of HybridIdentityMetadata.", - "type": "string", - "format": "uri", - "readOnly": true - }, - "value": { - "description": "Array of HybridIdentityMetadata", - "type": "array", - "items": { - "$ref": "#/definitions/VmInstanceHybridIdentityMetadata" + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" } } - }, - "required": [ - "value" - ] + } }, "VmInstanceHybridIdentityMetadata": { - "description": "Defines the HybridIdentityMetadata.", - "required": [ - "properties" - ], "type": "object", + "description": "Defines the HybridIdentityMetadata.", + "properties": { + "properties": { + "$ref": "#/definitions/VmInstanceHybridIdentityMetadataProperties", + "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", - "description": "The resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags." + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } - ], + ] + }, + "VmInstanceHybridIdentityMetadataListResult": { + "type": "object", + "description": "The response of a VmInstanceHybridIdentityMetadata list operation.", "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Resource properties.", - "$ref": "#/definitions/VmInstanceHybridIdentityMetadataProperties" + "value": { + "type": "array", + "description": "The VmInstanceHybridIdentityMetadata items on this page", + "items": { + "$ref": "#/definitions/VmInstanceHybridIdentityMetadata" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true } }, - "x-ms-azure-resource": true + "required": [ + "value" + ] }, "VmInstanceHybridIdentityMetadataProperties": { - "description": "Describes the properties of Hybrid Identity Metadata for a Virtual Machine.", "type": "object", + "description": "Describes the properties of Hybrid Identity Metadata for a Virtual Machine.", "properties": { "resourceUid": { - "description": "The unique identifier for the resource.", - "type": "string" + "type": "string", + "description": "The unique identifier for the resource." }, "publicKey": { - "description": "Gets or sets the Public Key.", - "type": "string" + "type": "string", + "description": "Gets or sets the Public Key." }, "provisioningState": { "$ref": "#/definitions/ResourceProvisioningState", @@ -4517,156 +5165,113 @@ } } }, - "Identity": { + "VmmCredential": { "type": "object", - "required": [ - "type" - ], + "description": "Credentials to connect to VmmServer.", "properties": { - "principalId": { - "readOnly": true, - "type": "string", - "description": "The principal id of managed service identity." - }, - "tenantId": { - "readOnly": true, + "username": { "type": "string", - "description": "The tenant of managed service identity." + "description": "Username to use to connect to VmmServer." }, - "type": { + "password": { "type": "string", - "description": "The type of managed service identity.", - "enum": [ - "None", - "SystemAssigned" + "format": "password", + "description": "Password to use to connect to VmmServer.", + "x-ms-mutability": [ + "update", + "create" ], - "x-ms-enum": { - "name": "IdentityType", - "modelAsString": true - } + "x-ms-secret": true } - }, - "description": "Managed service identity." - }, - "ProvisioningAction": { - "description": "Defines the different types of operations for guest agent.", - "enum": [ - "install", - "uninstall", - "repair" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "ProvisioningAction" } }, - "GuestCredential": { - "description": "Username / Password Credentials to connect to guest.", + "VmmServer": { "type": "object", + "description": "The VmmServers resource definition.", "properties": { - "username": { - "description": "Gets or sets username to connect with the guest.", - "type": "string" - }, - "password": { - "description": "Gets or sets the password to connect with the guest.", - "type": "string", + "properties": { + "$ref": "#/definitions/VmmServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, "x-ms-mutability": [ - "create", - "update" - ], - "x-ms-secret": true + "read", + "create" + ] + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location." } }, "required": [ - "username", - "password" - ] - }, - "HttpProxyConfiguration": { - "description": "HTTP Proxy configuration for the VM.", - "type": "object", - "properties": { - "httpsProxy": { - "description": "Gets or sets httpsProxy url.", - "type": "string" + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } - } + ] }, - "GuestAgentList": { - "description": "List of GuestAgent.", + "VmmServerListResult": { "type": "object", + "description": "The response of a VmmServer list operation.", "properties": { - "nextLink": { - "description": "Url to follow for getting next page of GuestAgent.", - "type": "string", - "format": "uri", - "readOnly": true - }, "value": { - "description": "Array of GuestAgent", "type": "array", + "description": "The VmmServer items on this page", "items": { - "$ref": "#/definitions/GuestAgent" + "$ref": "#/definitions/VmmServer" } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true } }, "required": [ "value" ] }, - "GuestAgent": { - "description": "Defines the GuestAgent.", - "required": [ - "properties" - ], + "VmmServerProperties": { "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource", - "description": "The resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags." - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Resource properties.", - "$ref": "#/definitions/GuestAgentProperties" - } - }, - "x-ms-azure-resource": true - }, - "GuestAgentProperties": { "description": "Defines the resource properties.", - "type": "object", "properties": { - "uuid": { - "description": "Gets a unique identifier for this resource.", + "credentials": { + "$ref": "#/definitions/VmmCredential", + "description": "Credentials to connect to VmmServer." + }, + "fqdn": { "type": "string", - "readOnly": true + "description": "Fqdn is the hostname/ip of the vmmServer.", + "minLength": 1 }, - "credentials": { - "description": "Username / Password Credentials to provision guest agent.", - "$ref": "#/definitions/GuestCredential" + "port": { + "type": "integer", + "format": "int32", + "description": "Port is the port on which the vmmServer is listening.", + "minimum": 1, + "maximum": 65535 }, - "httpProxyConfig": { - "description": "HTTP Proxy configuration for the VM.", - "$ref": "#/definitions/HttpProxyConfiguration" + "connectionStatus": { + "type": "string", + "description": "Gets the connection status to the vmmServer.", + "readOnly": true }, - "provisioningAction": { - "description": "Gets or sets the guest agent provisioning action.", - "$ref": "#/definitions/ProvisioningAction", - "type": "string" + "errorMessage": { + "type": "string", + "description": "Gets any error message if connection to vmmServer is having any issue.", + "readOnly": true }, - "status": { - "description": "Gets the guest agent status.", + "uuid": { "type": "string", + "description": "Unique ID of vmmServer.", "readOnly": true }, - "customResourceName": { - "description": "Gets the name of the corresponding resource in Kubernetes.", + "version": { "type": "string", + "description": "Version is the version of the vmmSever.", "readOnly": true }, "provisioningState": { @@ -4674,100 +5279,61 @@ "description": "Provisioning state of the resource.", "readOnly": true } - } - }, - "StorageQoSPolicy": { - "description": "The StorageQoSPolicy definition.", - "type": "object", - "properties": { - "name": { - "description": "The name of the policy.", - "type": "string" - }, - "id": { - "description": "The ID of the QoS policy.", - "type": "string" - }, - "iopsMaximum": { - "description": "The maximum IO operations per second.", - "type": "integer", - "format": "int64" - }, - "iopsMinimum": { - "description": "The minimum IO operations per second.", - "type": "integer", - "format": "int64" - }, - "bandwidthLimit": { - "description": "The Bandwidth Limit for internet traffic.", - "type": "integer", - "format": "int64" - }, - "policyId": { - "description": "The underlying policy.", - "type": "string" - } - } + }, + "required": [ + "fqdn" + ] }, - "ResourcePatch": { + "VmmServerTagsUpdate": { "type": "object", + "description": "The type used for updating tags in VmmServer resources.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags." - } - }, - "description": "Object containing tags updates for patch operations." - }, - "ResourceProvisioningState": { - "type": "string", - "description": "The provisioning state of a resource.", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Provisioning", - "Updating", - "Deleting", - "Accepted", - "Created" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "VMMCredential": { - "description": "Credentials to connect to VMMServer.", - "type": "object", - "properties": { - "username": { - "description": "Username to use to connect to VMMServer.", - "type": "string" - }, - "password": { - "description": "Password to use to connect to VMMServer.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ], - "x-ms-secret": true + } } } } }, "parameters": { - "resourceUriParameter": { - "in": "path", + "Azure.ResourceManager.ResourceUriParameter": { "name": "resourceUri", - "description": "The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", - "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "QueryForceDelete": { + "name": "force", + "in": "query", + "description": "Forces the resource to be deleted.", + "required": false, + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "ForceDelete", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable force delete." + }, + { + "name": "false", + "value": "false", + "description": "Disable force delete." + } + ] + }, "x-ms-parameter-location": "method" } } From d6879071e4171fcfa4160ff9fd55887328dfc7e1 Mon Sep 17 00:00:00 2001 From: zdelacerda-microsoft <90284189+zdelacerda-microsoft@users.noreply.github.com> Date: Mon, 3 Jun 2024 21:33:16 -0400 Subject: [PATCH 25/49] Imagebuilder API Release 2024-02-01 (#28896) * Copy files from stable/2023-07-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-02-01 Updated the API version from stable/2023-07-01 to stable/2024-02-01. * Added tag for 2024-02-01 in readme file * copying over 2024-02-01 changes from ADO * Revert "copying over 2024-02-01 changes from ADO" This reverts commit aa54d741c45d0ad1636e2d28b3eb7f23be7e7884. * adding changes from ado * adding autorun as custom word * adding autorun to custom-words.txt * fixing UpdateImageTemplateVmProfile.json reference and additionalProperties error * fixing UpdateImageTemplateVmProfile.json reference and additionalProperties error * changing type from string back to object * changing type from string back to object * Revert "changing type from string back to object" This reverts commit b0b51226863d56d08b20e37b0a45829923e5883e. revert commit * Revert "fixing UpdateImageTemplateVmProfile.json reference and additionalProperties error" This reverts commit 0e52ddf7739adc6032ef6ed644baa2b4e90fd6bb. * referencing examples file * writing suppression for lintdiff * removing userassignedidentity * fixing bad version mismatch * fixing suppression * prettier changes * fixing where syntax * fixing where suppress 2 * where suppress 3 * where supress 4 * where suppress 5 * suppressing entire file --- custom-words.txt | 1 + .../2024-02-01/examples/CancelImageBuild.json | 17 + .../examples/CreateImageTemplateLinux.json | 147 ++ .../examples/CreateImageTemplateWindows.json | 372 +++ .../examples/CreateSourceImageTrigger.json | 48 + .../examples/DeleteImageTemplate.json | 16 + .../2024-02-01/examples/DeleteTrigger.json | 17 + .../2024-02-01/examples/GetImageTemplate.json | 55 + .../2024-02-01/examples/GetRunOutput.json | 22 + .../2024-02-01/examples/GetTrigger.json | 27 + .../examples/ListImageTemplates.json | 109 + .../examples/ListImageTemplatesByRg.json | 118 + .../2024-02-01/examples/ListRunOutputs.json | 35 + .../2024-02-01/examples/ListTriggers.json | 31 + .../2024-02-01/examples/OperationsList.json | 141 ++ .../2024-02-01/examples/RunImageTemplate.json | 17 + .../examples/UpdateImageTemplateTags.json | 68 + ...UpdateImageTemplateToRemoveIdentities.json | 62 + .../UpdateImageTemplateVmProfile.json | 73 + .../stable/2024-02-01/imagebuilder.json | 2095 +++++++++++++++++ .../imagebuilder/resource-manager/readme.md | 20 +- 21 files changed, 3490 insertions(+), 1 deletion(-) create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CancelImageBuild.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateImageTemplateLinux.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateImageTemplateWindows.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateSourceImageTrigger.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/DeleteImageTemplate.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/DeleteTrigger.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetImageTemplate.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetRunOutput.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetTrigger.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplates.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplatesByRg.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListRunOutputs.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListTriggers.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/OperationsList.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/RunImageTemplate.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateTags.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateToRemoveIdentities.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateVmProfile.json create mode 100644 specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json diff --git a/custom-words.txt b/custom-words.txt index 839757224072..9332326fade7 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -263,6 +263,7 @@ autoregressive autorenew autorenewable autorest +autorun autosave autoscale autoscaler diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CancelImageBuild.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CancelImageBuild.json new file mode 100644 index 000000000000..c3d1545c1222 --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CancelImageBuild.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "imageTemplateName": "myImageTemplate", + "api-version": "2024-02-01" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/locations/{location}/operations/{operation-id}?api-version=2024-02-01" + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateImageTemplateLinux.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateImageTemplateLinux.json new file mode 100644 index 000000000000..4f21034a7b5b --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateImageTemplateLinux.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-02-01", + "imageTemplateName": "myImageTemplate", + "parameters": { + "location": "westus", + "tags": { + "imagetemplate_tag1": "IT_T1", + "imagetemplate_tag2": "IT_T2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": {} + } + }, + "properties": { + "source": { + "type": "ManagedImage", + "imageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/images/source_image" + }, + "customize": [ + { + "type": "Shell", + "name": "Shell Customizer Example", + "scriptUri": "https://example.com/path/to/script.sh" + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "1_location", + "runOutputName": "image_it_pir_1", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1", + "artifactTags": { + "tagName": "value" + } + } + ], + "vmProfile": { + "vmSize": "Standard_D2s_v3", + "osDiskSizeGB": 64, + "vnetConfig": { + "subnetId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate", + "name": "myImageTemplate", + "location": "westus", + "type": "Microsoft.VirtualMachineImages/imageTemplates", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "source": { + "type": "ManagedImage", + "imageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/images/source_image" + }, + "customize": [ + { + "type": "Shell", + "name": "Shell Customizer Example", + "scriptUri": "https://example.com/path/to/script.sh" + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "1_location", + "runOutputName": "image_it_pir_1", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1", + "artifactTags": { + "tagName": "value" + } + } + ], + "vmProfile": { + "vmSize": "Standard_D2s_v3", + "osDiskSizeGB": 64, + "vnetConfig": { + "subnetId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate", + "name": "myImageTemplate", + "location": "westus", + "type": "Microsoft.VirtualMachineImages/imageTemplates", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "source": { + "type": "ManagedImage", + "imageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/images/source_image" + }, + "customize": [ + { + "type": "Shell", + "name": "Shell Customizer Example", + "scriptUri": "https://example.com/path/to/script.sh" + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "1_location", + "runOutputName": "image_it_pir_1", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1", + "artifactTags": { + "tagName": "value" + } + } + ], + "vmProfile": { + "vmSize": "Standard_D2s_v3", + "osDiskSizeGB": 64 + } + } + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateImageTemplateWindows.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateImageTemplateWindows.json new file mode 100644 index 000000000000..5c3a66276565 --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateImageTemplateWindows.json @@ -0,0 +1,372 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-02-01", + "imageTemplateName": "myImageTemplate", + "parameters": { + "location": "westus", + "tags": { + "imagetemplate_tag1": "IT_T1", + "imagetemplate_tag2": "IT_T2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": {} + } + }, + "properties": { + "source": { + "type": "ManagedImage", + "imageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/images/source_image" + }, + "customize": [ + { + "type": "PowerShell", + "name": "PowerShell (inline) Customizer Example", + "inline": [ + "Powershell command-1", + "Powershell command-2", + "Powershell command-3" + ] + }, + { + "type": "PowerShell", + "name": "PowerShell (inline) Customizer Elevated user Example", + "inline": [ + "Powershell command-1", + "Powershell command-2", + "Powershell command-3" + ], + "runElevated": true + }, + { + "type": "PowerShell", + "name": "PowerShell (inline) Customizer Elevated Local System user Example", + "inline": [ + "Powershell command-1", + "Powershell command-2", + "Powershell command-3" + ], + "runElevated": true, + "runAsSystem": true + }, + { + "type": "PowerShell", + "name": "PowerShell (script) Customizer Example", + "scriptUri": "https://example.com/path/to/script.ps1", + "validExitCodes": [ + 0, + 1 + ] + }, + { + "type": "PowerShell", + "name": "PowerShell (script) Customizer Elevated Local System user Example", + "scriptUri": "https://example.com/path/to/script.ps1", + "runElevated": true, + "validExitCodes": [ + 0, + 1 + ] + }, + { + "type": "PowerShell", + "name": "PowerShell (script) Customizer Elevated Local System user Example", + "scriptUri": "https://example.com/path/to/script.ps1", + "runElevated": true, + "runAsSystem": true, + "validExitCodes": [ + 0, + 1 + ] + }, + { + "type": "WindowsRestart", + "name": "Restart Customizer Example", + "restartCommand": "shutdown /f /r /t 0 /c \"packer restart\"", + "restartCheckCommand": "powershell -command \"& {Write-Output 'restarted.'}\"", + "restartTimeout": "10m" + }, + { + "type": "WindowsUpdate", + "name": "Windows Update Customizer Example", + "searchCriteria": "BrowseOnly=0 and IsInstalled=0", + "filters": [ + "$_.BrowseOnly" + ], + "updateLimit": 100 + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "1_location", + "runOutputName": "image_it_pir_1", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1", + "artifactTags": { + "tagName": "value" + } + } + ], + "vmProfile": { + "vmSize": "Standard_D2s_v3", + "osDiskSizeGB": 64, + "vnetConfig": { + "subnetId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate", + "name": "myImageTemplate", + "location": "westus", + "type": "Microsoft.VirtualMachineImages/imageTemplates", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "source": { + "type": "ManagedImage", + "imageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/images/source_image" + }, + "customize": [ + { + "type": "PowerShell", + "name": "PowerShell (inline) Customizer Example", + "inline": [ + "Powershell command-1", + "Powershell command-2", + "Powershell command-3" + ], + "runElevated": false, + "runAsSystem": false + }, + { + "type": "PowerShell", + "name": "PowerShell (inline) Customizer Elevated user Example", + "inline": [ + "Powershell command-1", + "Powershell command-2", + "Powershell command-3" + ], + "runElevated": true, + "runAsSystem": false + }, + { + "type": "PowerShell", + "name": "PowerShell (inline) Customizer Elevated Local System user Example", + "inline": [ + "Powershell command-1", + "Powershell command-2", + "Powershell command-3" + ], + "runElevated": true, + "runAsSystem": true + }, + { + "type": "PowerShell", + "name": "PowerShell (script) Customizer Example", + "scriptUri": "https://example.com/path/to/script.ps1", + "validExitCodes": [ + 0, + 1 + ], + "runElevated": false, + "runAsSystem": false + }, + { + "type": "PowerShell", + "name": "PowerShell (script) Customizer Elevated Local System user Example", + "scriptUri": "https://example.com/path/to/script.ps1", + "runElevated": true, + "runAsSystem": false, + "validExitCodes": [ + 0, + 1 + ] + }, + { + "type": "PowerShell", + "name": "PowerShell (script) Customizer Elevated Local System user Example", + "scriptUri": "https://example.com/path/to/script.ps1", + "runElevated": true, + "runAsSystem": true, + "validExitCodes": [ + 0, + 1 + ] + }, + { + "type": "WindowsRestart", + "name": "Restart Customizer Example", + "restartCommand": "shutdown /f /r /t 0 /c \"packer restart\"", + "restartCheckCommand": "powershell -command \"& {Write-Output 'restarted.'}\"", + "restartTimeout": "10m" + }, + { + "type": "WindowsUpdate", + "name": "Windows Update Customizer Example", + "searchCriteria": "BrowseOnly=0 and IsInstalled=0", + "filters": [ + "$_.BrowseOnly" + ], + "updateLimit": 100 + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "1_location", + "runOutputName": "image_it_pir_1", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1", + "artifactTags": { + "tagName": "value" + } + } + ], + "vmProfile": { + "vmSize": "Standard_D2s_v3", + "osDiskSizeGB": 64, + "vnetConfig": { + "subnetId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate", + "name": "myImageTemplate", + "location": "westus", + "type": "Microsoft.VirtualMachineImages/imageTemplates", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "source": { + "type": "ManagedImage", + "imageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/images/source_image" + }, + "customize": [ + { + "type": "PowerShell", + "name": "PowerShell (inline) Customizer Example", + "inline": [ + "Powershell command-1", + "Powershell command-2", + "Powershell command-3" + ], + "runElevated": false, + "runAsSystem": false + }, + { + "type": "PowerShell", + "name": "PowerShell (inline) Customizer Elevated user Example", + "inline": [ + "Powershell command-1", + "Powershell command-2", + "Powershell command-3" + ], + "runElevated": true, + "runAsSystem": false + }, + { + "type": "PowerShell", + "name": "PowerShell (inline) Customizer Elevated Local System user Example", + "inline": [ + "Powershell command-1", + "Powershell command-2", + "Powershell command-3" + ], + "runElevated": true, + "runAsSystem": true + }, + { + "type": "PowerShell", + "name": "PowerShell (script) Customizer Example", + "scriptUri": "https://example.com/path/to/script.ps1", + "validExitCodes": [ + 0, + 1 + ], + "runElevated": false, + "runAsSystem": false + }, + { + "type": "PowerShell", + "name": "PowerShell (script) Customizer Elevated Local System user Example", + "scriptUri": "https://example.com/path/to/script.ps1", + "runElevated": true, + "runAsSystem": false, + "validExitCodes": [ + 0, + 1 + ] + }, + { + "type": "PowerShell", + "name": "PowerShell (script) Customizer Elevated Local System user Example", + "scriptUri": "https://example.com/path/to/script.ps1", + "runElevated": true, + "runAsSystem": true, + "validExitCodes": [ + 0, + 1 + ] + }, + { + "type": "WindowsRestart", + "name": "Restart Customizer Example", + "restartCommand": "shutdown /f /r /t 0 /c \"packer restart\"", + "restartCheckCommand": "powershell -command \"& {Write-Output 'restarted.'}\"", + "restartTimeout": "10m" + }, + { + "type": "WindowsUpdate", + "name": "Windows Update Customizer Example", + "searchCriteria": "BrowseOnly=0 and IsInstalled=0", + "filters": [ + "$_.BrowseOnly" + ], + "updateLimit": 100 + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "1_location", + "runOutputName": "image_it_pir_1", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1", + "artifactTags": { + "tagName": "value" + } + } + ], + "vmProfile": { + "vmSize": "Standard_D2s_v3", + "osDiskSizeGB": 64 + } + } + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateSourceImageTrigger.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateSourceImageTrigger.json new file mode 100644 index 000000000000..c8a6cca99113 --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateSourceImageTrigger.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-02-01", + "imageTemplateName": "myImageTemplate", + "triggerName": "source", + "parameters": { + "properties": { + "kind": "SourceImage" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/triggers/source", + "name": "source", + "type": "Microsoft.VirtualMachineImages/imageTemplates/triggers", + "properties": { + "kind": "SourceImage", + "status": { + "code": "Healthy", + "message": "", + "time": "2024-02-21T17:32:28Z" + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/triggers/source", + "name": "source", + "type": "Microsoft.VirtualMachineImages/imageTemplates/triggers", + "properties": { + "kind": "SourceImage", + "status": { + "code": "Healthy", + "message": "", + "time": "2024-02-21T17:32:28Z" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/DeleteImageTemplate.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/DeleteImageTemplate.json new file mode 100644 index 000000000000..18660b6f66eb --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/DeleteImageTemplate.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "imageTemplateName": "myImageTemplate", + "api-version": "2024-02-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/locations/{location}/operations/{operation-id}?api-version=2024-02-01" + } + }, + "204": {} + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/DeleteTrigger.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/DeleteTrigger.json new file mode 100644 index 000000000000..4676df333185 --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/DeleteTrigger.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "imageTemplateName": "myImageTemplate", + "triggerName": "trigger1", + "api-version": "2024-02-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/locations/{location}/operations/{operation-id}?api-version=2024-02-01" + } + }, + "204": {} + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetImageTemplate.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetImageTemplate.json new file mode 100644 index 000000000000..cd596bf5c50b --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetImageTemplate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-02-01", + "imageTemplateName": "myImageTemplate" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate", + "name": "myImageTemplate", + "location": "westus", + "type": "Microsoft.VirtualMachineImages/imageTemplates", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "source": { + "type": "ManagedImage", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image" + }, + "customize": [ + { + "type": "Shell", + "name": "Shell Customizer Example", + "scriptUri": "https://example.com/path/to/script.sh" + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "1_location", + "runOutputName": "image_it_pir_1", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1", + "artifactTags": { + "tagName": "value" + } + } + ], + "vmProfile": { + "vmSize": "Standard_D2s_v3", + "osDiskSizeGB": 64 + } + } + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetRunOutput.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetRunOutput.json new file mode 100644 index 000000000000..d4f6d94fda1f --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetRunOutput.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "imageTemplateName": "myImageTemplate", + "runOutputName": "myManagedImageOutput", + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/runOutputs/myManagedImageOutput", + "name": "myManagedImageOutput", + "properties": { + "artifactId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/output_managed_image", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.VirtualMachineImages/imageTemplates/runOutputs" + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetTrigger.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetTrigger.json new file mode 100644 index 000000000000..37835a9672f0 --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetTrigger.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "imageTemplateName": "myImageTemplate", + "triggerName": "source", + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/triggers/source", + "name": "source", + "properties": { + "kind": "SourceImage", + "status": { + "code": "Healthy", + "message": "", + "time": "2024-02-21T17:32:28Z" + }, + "provisioningState": "Succeeded" + }, + "type": "Microsoft.VirtualMachineImages/imageTemplates/triggers" + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplates.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplates.json new file mode 100644 index 000000000000..0106d842b3e4 --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplates.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate", + "name": "myImageTemplate", + "location": "westus", + "type": "Microsoft.VirtualMachineImages/imageTemplates", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "source": { + "type": "ManagedImage", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image" + }, + "customize": [ + { + "type": "Shell", + "name": "Shell customization example", + "scriptUri": "https://example.com/path/to/script.sh" + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "1_location", + "runOutputName": "image_it_pir_1", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1", + "artifactTags": { + "tagName": "value" + } + } + ], + "vmProfile": { + "vmSize": "Standard_D2s_v3", + "osDiskSizeGB": 64 + } + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myOtherResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/mySecondImageTemplate", + "name": "mySecondImageTemplate", + "location": "westus", + "type": "Microsoft.VirtualMachineImages/imageTemplates", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "source": { + "type": "PlatformImage", + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "18.04.201902121", + "planInfo": { + "planName": "example_plan_name", + "planProduct": "example_plan_product", + "planPublisher": "example_plan_publisher" + } + }, + "customize": [ + { + "type": "Shell", + "name": "Shell customization example", + "scriptUri": "https://example.com/path/to/script.sh" + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "eastus", + "runOutputName": "eus", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/mySecondImage-eus", + "artifactTags": { + "stage": "development" + } + } + ], + "vmProfile": { + "vmSize": "Standard_D8s_v3", + "osDiskSizeGB": 32 + } + } + } + ], + "nextLink": "/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/imageTemplates?api-version=2024-02-01&skip-token=2" + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplatesByRg.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplatesByRg.json new file mode 100644 index 000000000000..f165f531d8a6 --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplatesByRg.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate", + "name": "myImageTemplate", + "location": "westus", + "type": "Microsoft.VirtualMachineImages/imageTemplates", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "source": { + "type": "ManagedImage", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image" + }, + "customize": [ + { + "type": "Shell", + "name": "Shell customization example", + "scriptUri": "https://example.com/path/to/script.sh" + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "1_location", + "runOutputName": "image_it_pir_1", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1", + "artifactTags": { + "tagName": "value" + } + } + ], + "vmProfile": { + "vmSize": "Standard_D2s_v3", + "osDiskSizeGB": 64 + } + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myOtherImageTemplate", + "name": "myOtherImageTemplate", + "location": "eastus", + "type": "Microsoft.VirtualMachineImages/imageTemplates", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "source": { + "type": "PlatformImage", + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "18.04.201902121", + "planInfo": { + "planName": "example_plan_name", + "planProduct": "example_plan_product", + "planPublisher": "example_plan_publisher" + } + }, + "customize": [ + { + "type": "Shell", + "name": "Shell customization example", + "scriptUri": "https://example.com/path/to/script.sh" + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "centralus", + "runOutputName": "singleImage", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/baseimage-cus" + }, + { + "type": "SharedImage", + "galleryImageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/gallery/baseimages/images/baseimage", + "replicationRegions": [ + "eastus", + "westus" + ], + "runOutputName": "gallery", + "excludeFromLatest": true, + "storageAccountType": "Standard_LRS" + } + ], + "vmProfile": { + "vmSize": "Standard_D8s_v3", + "osDiskSizeGB": 64 + } + } + } + ], + "nextLink": "/subscriptions/{subscription-id}/resourceGroup/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates?api-version=2024-02-01&skip-token=2" + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListRunOutputs.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListRunOutputs.json new file mode 100644 index 000000000000..2ff268030720 --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListRunOutputs.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "imageTemplateName": "myImageTemplate", + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/runOutputs/myManagedImageOutput", + "name": "myManagedImageOutput", + "properties": { + "artifactId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/output_managed_image", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.VirtualMachineImages/imageTemplates/runOutputs" + }, + { + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/runOutputs/mySharedImageOutput", + "name": "mySharedImageOutput", + "properties": { + "artifactId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/galleries/Gallery1/images/SharedImageOutput/imageversions/1.2.3", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.VirtualMachineImages/imageTemplates/runOutputs" + } + ], + "nextLink": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/runOutputs?api-version=2024-02-01&$skipToken=3" + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListTriggers.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListTriggers.json new file mode 100644 index 000000000000..c65acb471cac --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListTriggers.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "imageTemplateName": "myImageTemplate", + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/triggers/source", + "name": "source", + "properties": { + "kind": "SourceImage", + "status": { + "code": "Healthy", + "message": "", + "time": "2024-02-21T17:32:28Z" + }, + "provisioningState": "Succeeded" + }, + "type": "Microsoft.VirtualMachineImages/imageTemplates/triggers" + } + ], + "nextLink": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/triggers?api-version=2024-02-01&$skipToken=3" + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/OperationsList.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/OperationsList.json new file mode 100644 index 000000000000..42565906913d --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/OperationsList.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.VirtualMachineImages/register/action", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "Register Virtual Machine Image Builder RP", + "description": "Register Virtual Machine Image Builder RP" + }, + "isDataAction": false + }, + { + "name": "Microsoft.VirtualMachineImages/unregister/action", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "Unregister Virtual Machine Image Builder RP", + "description": "Unregister Virtual Machine Image Builder RP" + }, + "isDataAction": false + }, + { + "name": "Microsoft.VirtualMachineImages/imageTemplates/read", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "Get a VM image template instance resource", + "resource": "VM Image template", + "description": "Get a VM image template instance resource" + }, + "isDataAction": false + }, + { + "name": "Microsoft.VirtualMachineImages/imageTemplates/write", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "Create or update a VM image template instance resource", + "resource": "VM Image template", + "description": "Create or update a VM image template instance resource" + }, + "isDataAction": false + }, + { + "name": "Microsoft.VirtualMachineImages/imageTemplates/delete", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "Delete a VM image template instance resource", + "resource": "VM Image template", + "description": "Delete a VM image template instance resource" + }, + "isDataAction": false + }, + { + "name": "Microsoft.VirtualMachineImages/imageTemplates/run/action", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "Execute a VM image template to produce its outputs", + "resource": "VM Image template", + "description": "Execute a VM image template to produce its outputs" + }, + "isDataAction": false + }, + { + "name": "Microsoft.VirtualMachineImages/imageTemplates/runOutputs/read", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "Get a VM image template run output resource", + "resource": "VM Image template run output", + "description": "Get a VM image template run output resource" + }, + "isDataAction": false + }, + { + "name": "Microsoft.VirtualMachineImages/operations/read", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "List available Virtual Machine Image Builder Operations", + "resource": "Operation", + "description": "List available Virtual Machine Image Builder Operations" + }, + "isDataAction": false + }, + { + "name": "Microsoft.VirtualMachineImages/locations/operations/read", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "Get the status of an asynchronous operation", + "resource": "Asynchronous Operation", + "description": "Get the status of an asynchronous operation" + }, + "isDataAction": false + }, + { + "name": "Microsoft.VirtualMachineImages/imageTemplates/cancel/action", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "Cancel a running image build", + "resource": "VM Image template", + "description": "Cancel a running image build" + }, + "isDataAction": false + }, + { + "name": "Microsoft.VirtualMachineImages/imageTemplates/triggers/write", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "Create or update a trigger for a VM image template resource", + "resource": "Trigger", + "description": "Create or update a trigger for a VM image template resource" + }, + "isDataAction": false + }, + { + "name": "Microsoft.VirtualMachineImages/imageTemplates/triggers/read", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "Get a trigger for a VM image template resource", + "resource": "Trigger", + "description": "Get a trigger for a VM image template resource" + }, + "isDataAction": false + }, + { + "name": "Microsoft.VirtualMachineImages/imageTemplates/triggers/delete", + "display": { + "provider": "Virtual Machine Image Builder", + "operation": "Delete a trigger for a VM image template resource", + "resource": "Trigger", + "description": "Delete a trigger for a VM image template resource" + }, + "isDataAction": false + } + ] + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/RunImageTemplate.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/RunImageTemplate.json new file mode 100644 index 000000000000..ca726db45be6 --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/RunImageTemplate.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "imageTemplateName": "myImageTemplate", + "api-version": "2024-02-01" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/locations/{location}/operations/{operation-id}?api-version=2024-02-01" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateTags.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateTags.json new file mode 100644 index 000000000000..cff81c6039a4 --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "imageTemplateName": "myImageTemplate", + "api-version": "2024-02-01", + "parameters": { + "tags": { + "new-tag": "new-value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate", + "name": "myImageTemplate", + "location": "westus", + "type": "Microsoft.VirtualMachineImages/imageTemplates", + "tags": { + "new-tag": "new-value" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "source": { + "type": "ManagedImage", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image" + }, + "customize": [ + { + "type": "Shell", + "name": "Shell customization example", + "scriptUri": "https://example.com/path/to/script.sh" + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "1_location", + "runOutputName": "image_it_pir_1", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1", + "artifactTags": { + "tagName": "value" + } + } + ], + "vmProfile": { + "vmSize": "Standard_D2s_v3", + "osDiskSizeGB": 64 + } + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/locations/{location}/operations/{operation-id}?api-version=2024-02-01" + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateToRemoveIdentities.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateToRemoveIdentities.json new file mode 100644 index 000000000000..d07a57de59a5 --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateToRemoveIdentities.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "imageTemplateName": "myImageTemplate", + "api-version": "2024-02-01", + "parameters": { + "identity": { + "type": "None" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate", + "name": "myImageTemplate", + "location": "westus", + "type": "Microsoft.VirtualMachineImages/imageTemplates", + "identity": { + "type": "None" + }, + "tags": { + "new-tag": "new-value" + }, + "properties": { + "source": { + "type": "ManagedImage", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image" + }, + "customize": [ + { + "type": "Shell", + "name": "Shell customization example", + "scriptUri": "https://example.com/path/to/script.sh" + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "1_location", + "runOutputName": "image_it_pir_1", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1", + "artifactTags": { + "tagName": "value" + } + } + ], + "vmProfile": { + "vmSize": "Standard_D2s_v3", + "osDiskSizeGB": 64 + } + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/locations/{location}/operations/{operation-id}?api-version=2024-02-01" + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateVmProfile.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateVmProfile.json new file mode 100644 index 000000000000..3cd282115eca --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateVmProfile.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "imageTemplateName": "myImageTemplate", + "api-version": "2024-02-01", + "parameters": { + "properties": { + "vmProfile": { + "osDiskSizeGB": 127, + "vmSize": "{updated_vmsize}", + "vnetConfig": { + "containerInstanceSubnetId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnetname", + "subnetId": "{updated_aci_subnet}" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate", + "name": "myImageTemplate", + "location": "westus", + "type": "Microsoft.VirtualMachineImages/imageTemplates", + "identity": { + "type": "None" + }, + "tags": { + "tag": "tag-value" + }, + "properties": { + "source": { + "type": "ManagedImage", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image" + }, + "customize": [ + { + "type": "Shell", + "name": "Shell customization example", + "scriptUri": "https://example.com/path/to/script.sh" + } + ], + "distribute": [ + { + "type": "ManagedImage", + "location": "1_location", + "runOutputName": "image_it_pir_1", + "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1", + "artifactTags": { + "tagName": "value" + } + } + ], + "vmProfile": { + "osDiskSizeGB": 127, + "vmSize": "{updated_vmsize}", + "vnetConfig": { + "containerInstanceSubnetId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnetname", + "subnetId": "{updated_aci_subnet}}" + } + } + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/locations/{location}/operations/{operation-id}?api-version=2024-02-01" + } + } + } +} diff --git a/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json new file mode 100644 index 000000000000..6c390d119b52 --- /dev/null +++ b/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json @@ -0,0 +1,2095 @@ +{ + "swagger": "2.0", + "info": { + "title": "VirtualMachineImageTemplate", + "description": "Virtual Machine Image Template", + "version": "2024-02-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.VirtualMachineImages/imageTemplates": { + "get": { + "tags": [ + "VirtualMachineImageTemplate" + ], + "operationId": "VirtualMachineImageTemplates_List", + "description": "Gets information about the VM image templates associated with the subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageTemplateListResult" + } + }, + "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": { + "List images by subscription.": { + "$ref": "./examples/ListImageTemplates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates": { + "get": { + "tags": [ + "VirtualMachineImageTemplate" + ], + "operationId": "VirtualMachineImageTemplates_ListByResourceGroup", + "description": "Gets information about the VM image templates associated with the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageTemplateListResult" + } + }, + "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": { + "List images by resource group": { + "$ref": "./examples/ListImageTemplatesByRg.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}": { + "put": { + "tags": [ + "VirtualMachineImageTemplate" + ], + "operationId": "VirtualMachineImageTemplates_CreateOrUpdate", + "description": "Create or update a virtual machine image template", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageTemplate" + }, + "description": "Parameters supplied to the CreateImageTemplate operation" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ImageTemplateNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageTemplate" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ImageTemplate" + } + }, + "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": { + "Create an Image Template for Linux.": { + "$ref": "./examples/CreateImageTemplateLinux.json" + }, + "Create an Image Template for Windows.": { + "$ref": "./examples/CreateImageTemplateWindows.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineImageTemplate" + ], + "operationId": "VirtualMachineImageTemplates_Update", + "description": "Update the tags for this Virtual Machine Image Template", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageTemplateUpdateParameters" + }, + "description": "Additional parameters for Image Template update." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ImageTemplateNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageTemplate" + } + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "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": { + "Update the tags for an Image Template.": { + "$ref": "./examples/UpdateImageTemplateTags.json" + }, + "Remove identities for an Image Template.": { + "$ref": "./examples/UpdateImageTemplateToRemoveIdentities.json" + }, + "Update parameters for vm profile.": { + "$ref": "./examples/UpdateImageTemplateVmProfile.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineImageTemplate" + ], + "operationId": "VirtualMachineImageTemplates_Get", + "description": "Get information about a virtual machine image template", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ImageTemplateNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageTemplate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve an Image Template.": { + "$ref": "./examples/GetImageTemplate.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineImageTemplate" + ], + "operationId": "VirtualMachineImageTemplates_Delete", + "description": "Delete a virtual machine image template", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ImageTemplateNameParameter" + } + ], + "responses": { + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- VM image template does not exist in the subscription." + }, + "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" + }, + "x-ms-examples": { + "Delete an Image Template.": { + "$ref": "./examples/DeleteImageTemplate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/run": { + "post": { + "tags": [ + "VirtualMachineImageTemplate" + ], + "operationId": "VirtualMachineImageTemplates_Run", + "description": "Create artifacts from a existing image template", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ImageTemplateNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "204": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "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": { + "Create image(s) from existing imageTemplate.": { + "$ref": "./examples/RunImageTemplate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/cancel": { + "post": { + "tags": [ + "VirtualMachineImageTemplate" + ], + "operationId": "VirtualMachineImageTemplates_Cancel", + "description": "Cancel the long running image build based on the image template", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ImageTemplateNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "204": { + "description": "The long running image build has been canceled." + }, + "202": { + "description": "The request is accepted." + }, + "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": { + "Cancel the image build based on the imageTemplate.": { + "$ref": "./examples/CancelImageBuild.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs": { + "get": { + "tags": [ + "VirtualMachineImageTemplate" + ], + "operationId": "VirtualMachineImageTemplates_ListRunOutputs", + "description": "List all run outputs for the specified Image Template resource", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ImageTemplateNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunOutputCollection" + } + }, + "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": { + "Retrieve a list of all outputs created by the last run of an Image Template": { + "$ref": "./examples/ListRunOutputs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs/{runOutputName}": { + "get": { + "tags": [ + "VirtualMachineImageTemplate" + ], + "operationId": "VirtualMachineImageTemplates_GetRunOutput", + "description": "Get the specified run output for the specified image template resource", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ImageTemplateNameParameter" + }, + { + "$ref": "#/parameters/RunOutputNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunOutput" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve single runOutput": { + "$ref": "./examples/GetRunOutput.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers": { + "get": { + "tags": [ + "Triggers" + ], + "operationId": "Triggers_ListByImageTemplate", + "description": "List all triggers for the specified Image Template resource", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ImageTemplateNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TriggerCollection" + } + }, + "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": { + "List triggers by image template": { + "$ref": "./examples/ListTriggers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}": { + "get": { + "tags": [ + "Triggers" + ], + "operationId": "Triggers_Get", + "description": "Get the specified trigger for the specified image template resource", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ImageTemplateNameParameter" + }, + { + "$ref": "#/parameters/TriggerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a trigger resource": { + "$ref": "./examples/GetTrigger.json" + } + } + }, + "put": { + "tags": [ + "Triggers" + ], + "operationId": "Triggers_CreateOrUpdate", + "description": "Create or update a trigger for the specified virtual machine image template", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Trigger" + }, + "description": "Parameters supplied to the CreateTrigger operation" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ImageTemplateNameParameter" + }, + { + "$ref": "#/parameters/TriggerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "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": { + "Create or update a source image type trigger": { + "$ref": "./examples/CreateSourceImageTrigger.json" + } + } + }, + "delete": { + "tags": [ + "Triggers" + ], + "operationId": "Triggers_Delete", + "description": "Delete a trigger for the specified virtual machine image template", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ImageTemplateNameParameter" + }, + { + "$ref": "#/parameters/TriggerNameParameter" + } + ], + "responses": { + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- trigger by the name doesn't 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": "location" + }, + "x-ms-examples": { + "Delete a trigger resource": { + "$ref": "./examples/DeleteTrigger.json" + } + } + } + }, + "/providers/Microsoft.VirtualMachineImages/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists available operations for the Microsoft.VirtualMachineImages provider", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "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": { + "Retrieve operations list": { + "$ref": "./examples/OperationsList.json" + } + } + } + } + }, + "definitions": { + "ImageTemplateListResult": { + "description": "The result of List image templates operation", + "type": "object", + "properties": { + "value": { + "description": "An array of image templates", + "type": "array", + "items": { + "$ref": "#/definitions/ImageTemplate" + } + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + } + }, + "ImageTemplateSource": { + "type": "object", + "description": "Describes a virtual machine image source for building, customizing and distributing", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Specifies the type of source image you want to start with." + } + }, + "required": [ + "type" + ] + }, + "ImageTemplatePlatformImageSource": { + "type": "object", + "description": "Describes an image source from [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages).", + "x-ms-discriminator-value": "PlatformImage", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateSource" + } + ], + "properties": { + "publisher": { + "type": "string", + "description": "Image Publisher in [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages)." + }, + "offer": { + "type": "string", + "description": "Image offer from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages)." + }, + "sku": { + "type": "string", + "description": "Image sku from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages)." + }, + "version": { + "type": "string", + "description": "Image version from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages). If 'latest' is specified here, the version is evaluated when the image build takes place, not when the template is submitted." + }, + "exactVersion": { + "type": "string", + "description": "Image version from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages). This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'.", + "readOnly": true + }, + "planInfo": { + "$ref": "#/definitions/PlatformImagePurchasePlan", + "description": "Optional configuration of purchase plan for platform image." + } + } + }, + "ImageTemplateManagedImageSource": { + "type": "object", + "description": "Describes an image source that is a managed image in customer subscription. This image must reside in the same subscription and region as the Image Builder template.", + "x-ms-discriminator-value": "ManagedImage", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateSource" + } + ], + "properties": { + "imageId": { + "type": "string", + "description": "ARM resource id of the managed image in customer subscription" + } + }, + "required": [ + "imageId" + ] + }, + "ImageTemplateSharedImageVersionSource": { + "type": "object", + "description": "Describes an image source that is an image version in an Azure Compute Gallery or a Direct Shared Gallery.", + "x-ms-discriminator-value": "SharedImageVersion", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateSource" + } + ], + "properties": { + "imageVersionId": { + "type": "string", + "description": "ARM resource id of the image version. When image version name is 'latest', the version is evaluated when the image build takes place." + }, + "exactVersion": { + "type": "string", + "description": "Exact ARM resource id of the image version. This readonly field differs from the image version Id in 'imageVersionId' only if the version name specified in 'imageVersionId' field is 'latest'.", + "readOnly": true + } + }, + "required": [ + "imageVersionId" + ] + }, + "ImageTemplateInVMValidator": { + "type": "object", + "description": "Describes a unit of in-VM validation of image", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "The type of validation you want to use on the Image. For example, \"Shell\" can be shell validation" + }, + "name": { + "type": "string", + "description": "Friendly Name to provide context on what this validation step does" + } + }, + "required": [ + "type" + ] + }, + "ImageTemplateShellValidator": { + "type": "object", + "description": "Runs the specified shell script during the validation phase (Linux). Corresponds to Packer shell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.", + "x-ms-discriminator-value": "Shell", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateInVMValidator" + } + ], + "properties": { + "scriptUri": { + "type": "string", + "description": "URI of the shell script to be run for validation. It can be a github link, Azure Storage URI, etc" + }, + "sha256Checksum": { + "type": "string", + "default": "", + "description": "SHA256 checksum of the shell script provided in the scriptUri field" + }, + "inline": { + "type": "array", + "description": "Array of shell commands to execute", + "items": { + "type": "string" + } + } + } + }, + "ImageTemplatePowerShellValidator": { + "type": "object", + "description": "Runs the specified PowerShell script during the validation phase (Windows). Corresponds to Packer powershell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.", + "x-ms-discriminator-value": "PowerShell", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateInVMValidator" + } + ], + "properties": { + "scriptUri": { + "type": "string", + "description": "URI of the PowerShell script to be run for validation. It can be a github link, Azure Storage URI, etc" + }, + "sha256Checksum": { + "type": "string", + "default": "", + "description": "SHA256 checksum of the power shell script provided in the scriptUri field above" + }, + "inline": { + "type": "array", + "description": "Array of PowerShell commands to execute", + "items": { + "type": "string" + } + }, + "runElevated": { + "type": "boolean", + "default": false, + "description": "If specified, the PowerShell script will be run with elevated privileges" + }, + "runAsSystem": { + "type": "boolean", + "default": false, + "description": "If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true." + }, + "validExitCodes": { + "type": "array", + "description": "Valid exit codes for the PowerShell script. [Default: 0]", + "items": { + "type": "integer", + "format": "int32" + } + } + } + }, + "ImageTemplateFileValidator": { + "type": "object", + "description": "Uploads files required for validation to VMs (Linux, Windows). Corresponds to Packer file provisioner", + "x-ms-discriminator-value": "File", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateInVMValidator" + } + ], + "properties": { + "sourceUri": { + "type": "string", + "description": "The URI of the file to be uploaded to the VM for validation. It can be a github link, Azure Storage URI (authorized or SAS), etc" + }, + "sha256Checksum": { + "type": "string", + "default": "", + "description": "SHA256 checksum of the file provided in the sourceUri field above" + }, + "destination": { + "type": "string", + "description": "The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM" + } + } + }, + "ImageTemplateCustomizer": { + "type": "object", + "description": "Describes a unit of image customization", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "The type of customization tool you want to use on the Image. For example, \"Shell\" can be shell customizer" + }, + "name": { + "type": "string", + "description": "Friendly Name to provide context on what this customization step does" + } + }, + "required": [ + "type" + ] + }, + "ImageTemplateShellCustomizer": { + "type": "object", + "description": "Runs a shell script during the customization phase (Linux). Corresponds to Packer shell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.", + "x-ms-discriminator-value": "Shell", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateCustomizer" + } + ], + "properties": { + "scriptUri": { + "type": "string", + "description": "URI of the shell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc" + }, + "sha256Checksum": { + "type": "string", + "default": "", + "description": "SHA256 checksum of the shell script provided in the scriptUri field" + }, + "inline": { + "type": "array", + "description": "Array of shell commands to execute", + "items": { + "type": "string" + } + } + } + }, + "ImageTemplateRestartCustomizer": { + "type": "object", + "description": "Reboots a VM and waits for it to come back online (Windows). Corresponds to Packer windows-restart provisioner", + "x-ms-discriminator-value": "WindowsRestart", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateCustomizer" + } + ], + "properties": { + "restartCommand": { + "type": "string", + "description": "Command to execute the restart [Default: 'shutdown /r /f /t 0 /c \"packer restart\"']" + }, + "restartCheckCommand": { + "type": "string", + "description": "Command to check if restart succeeded [Default: '']" + }, + "restartTimeout": { + "type": "string", + "description": "Restart timeout specified as a string of magnitude and unit, e.g. '5m' (5 minutes) or '2h' (2 hours) [Default: '5m']" + } + } + }, + "ImageTemplateWindowsUpdateCustomizer": { + "type": "object", + "description": "Installs Windows Updates. Corresponds to Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)", + "x-ms-discriminator-value": "WindowsUpdate", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateCustomizer" + } + ], + "properties": { + "searchCriteria": { + "type": "string", + "description": "Criteria to search updates. Omit or specify empty string to use the default (search all). Refer to above link for examples and detailed description of this field." + }, + "filters": { + "type": "array", + "description": "Array of filters to select updates to apply. Omit or specify empty array to use the default (no filter). Refer to above link for examples and detailed description of this field.", + "items": { + "type": "string" + } + }, + "updateLimit": { + "type": "integer", + "format": "int32", + "minimum": 0, + "default": 0, + "description": "Maximum number of updates to apply at a time. Omit or specify 0 to use the default (1000)" + } + } + }, + "ImageTemplatePowerShellCustomizer": { + "type": "object", + "description": "Runs the specified PowerShell on the VM (Windows). Corresponds to Packer powershell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.", + "x-ms-discriminator-value": "PowerShell", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateCustomizer" + } + ], + "properties": { + "scriptUri": { + "type": "string", + "description": "URI of the PowerShell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc" + }, + "sha256Checksum": { + "type": "string", + "default": "", + "description": "SHA256 checksum of the power shell script provided in the scriptUri field above" + }, + "inline": { + "type": "array", + "description": "Array of PowerShell commands to execute", + "items": { + "type": "string" + } + }, + "runElevated": { + "type": "boolean", + "default": false, + "description": "If specified, the PowerShell script will be run with elevated privileges" + }, + "runAsSystem": { + "type": "boolean", + "default": false, + "description": "If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true." + }, + "validExitCodes": { + "type": "array", + "description": "Valid exit codes for the PowerShell script. [Default: 0]", + "items": { + "type": "integer", + "format": "int32" + } + } + } + }, + "ImageTemplateFileCustomizer": { + "type": "object", + "description": "Uploads files to VMs (Linux, Windows). Corresponds to Packer file provisioner", + "x-ms-discriminator-value": "File", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateCustomizer" + } + ], + "properties": { + "sourceUri": { + "type": "string", + "description": "The URI of the file to be uploaded for customizing the VM. It can be a github link, SAS URI for Azure Storage, etc" + }, + "sha256Checksum": { + "type": "string", + "default": "", + "description": "SHA256 checksum of the file provided in the sourceUri field above" + }, + "destination": { + "type": "string", + "description": "The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM" + } + } + }, + "ImageTemplateDistributor": { + "type": "object", + "description": "Generic distribution object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Type of distribution." + }, + "runOutputName": { + "type": "string", + "description": "The name to be used for the associated RunOutput.", + "pattern": "^[A-Za-z0-9-_.]{1,64}$" + }, + "artifactTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags that will be applied to the artifact once it has been created/updated by the distributor." + } + }, + "required": [ + "type", + "runOutputName" + ] + }, + "ImageTemplateManagedImageDistributor": { + "x-ms-discriminator-value": "ManagedImage", + "description": "Distribute as a Managed Disk Image.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateDistributor" + } + ], + "properties": { + "imageId": { + "type": "string", + "description": "Resource Id of the Managed Disk Image" + }, + "location": { + "type": "string", + "description": "Azure location for the image, should match if image already exists" + } + }, + "required": [ + "imageId", + "location" + ] + }, + "ImageTemplateSharedImageDistributor": { + "x-ms-discriminator-value": "SharedImage", + "description": "Distribute via Azure Compute Gallery.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateDistributor" + } + ], + "properties": { + "galleryImageId": { + "type": "string", + "description": "Resource Id of the Azure Compute Gallery image" + }, + "replicationRegions": { + "description": "[Deprecated] A list of regions that the image will be replicated to. This list can be specified only if targetRegions is not specified. This field is deprecated - use targetRegions instead.", + "type": "array", + "items": { + "type": "string" + } + }, + "excludeFromLatest": { + "type": "boolean", + "default": false, + "description": "Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false)." + }, + "storageAccountType": { + "$ref": "#/definitions/SharedImageStorageAccountType", + "description": "[Deprecated] Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS). This field can be specified only if replicationRegions is specified. This field is deprecated - use targetRegions instead." + }, + "targetRegions": { + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + }, + "x-ms-identifiers": [], + "description": "The target regions where the distributed Image Version is going to be replicated to. This object supersedes replicationRegions and can be specified only if replicationRegions is not specified." + }, + "versioning": { + "$ref": "#/definitions/DistributeVersioner" + } + }, + "required": [ + "galleryImageId" + ] + }, + "TargetRegion": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the region." + }, + "replicaCount": { + "type": "integer", + "format": "int32", + "minimum": 1, + "default": 1, + "description": "The number of replicas of the Image Version to be created in this region. Omit to use the default (1)." + }, + "storageAccountType": { + "$ref": "#/definitions/SharedImageStorageAccountType", + "description": "Specifies the storage account type to be used to store the image in this region. Omit to use the default (Standard_LRS)." + } + }, + "required": [ + "name" + ], + "description": "Describes the target region information." + }, + "ImageTemplateVhdDistributor": { + "x-ms-discriminator-value": "VHD", + "description": "Distribute via VHD in a storage account.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageTemplateDistributor" + } + ], + "properties": { + "uri": { + "type": "string", + "description": "Optional Azure Storage URI for the distributed VHD blob. Omit to use the default (empty string) in which case VHD would be published to the storage account in the staging resource group." + } + } + }, + "PlatformImagePurchasePlan": { + "type": "object", + "description": "Purchase plan configuration for platform image.", + "properties": { + "planName": { + "type": "string", + "description": "Name of the purchase plan." + }, + "planProduct": { + "type": "string", + "description": "Product of the purchase plan." + }, + "planPublisher": { + "type": "string", + "description": "Publisher of the purchase plan." + } + }, + "required": [ + "planName", + "planProduct", + "planPublisher" + ] + }, + "VirtualNetworkConfig": { + "type": "object", + "description": "Virtual Network configuration.", + "properties": { + "subnetId": { + "type": "string", + "description": "Resource id of a pre-existing subnet on which the build VM and validation VM will be deployed" + }, + "containerInstanceSubnetId": { + "type": "string", + "description": "Resource id of a pre-existing subnet on which Azure Container Instance will be deployed for Isolated Builds. This field may be specified only if `subnetId` is also specified and must be on the same Virtual Network as the subnet specified in `subnetId`." + }, + "proxyVmSize": { + "type": "string", + "default": "", + "description": "Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. This must not be specified if `containerInstanceSubnetId` is specified because no proxy virtual machine is deployed in that case. Omit or specify empty string to use the default (Standard_A1_v2)." + } + } + }, + "ImageTemplateVmProfile": { + "type": "object", + "description": "Describes the virtual machines used to build and validate images", + "properties": { + "vmSize": { + "type": "string", + "default": "", + "description": "Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images)." + }, + "osDiskSizeGB": { + "type": "integer", + "format": "int32", + "minimum": 0, + "default": 0, + "description": "Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size." + }, + "userAssignedIdentities": { + "type": "array", + "description": "Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template.", + "items": { + "type": "string" + } + }, + "vnetConfig": { + "$ref": "#/definitions/VirtualNetworkConfig", + "description": "Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used." + } + } + }, + "SharedImageStorageAccountType": { + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "SharedImageStorageAccountType", + "modelAsString": true + }, + "description": "Specifies the storage account type to be used to store the Azure Compute Gallery image version in." + }, + "ProvisioningState": { + "type": "string", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + }, + "description": "Provisioning state of the resource" + }, + "onBuildError": { + "type": "string", + "enum": [ + "cleanup", + "abort" + ], + "x-ms-enum": { + "name": "onBuildError", + "modelAsString": true + }, + "description": "Error handling behavior upon build failure" + }, + "ProvisioningError": { + "type": "object", + "description": "Describes the error happened when create or update an image template", + "properties": { + "provisioningErrorCode": { + "type": "string", + "enum": [ + "BadSourceType", + "BadPIRSource", + "BadManagedImageSource", + "BadSharedImageVersionSource", + "BadCustomizerType", + "UnsupportedCustomizerType", + "NoCustomizerScript", + "BadValidatorType", + "UnsupportedValidatorType", + "NoValidatorScript", + "BadDistributeType", + "BadSharedImageDistribute", + "BadStagingResourceGroup", + "ServerError", + "Other" + ], + "x-ms-enum": { + "name": "ProvisioningErrorCode", + "modelAsString": true + }, + "description": "Error code of the provisioning failure" + }, + "message": { + "type": "string", + "description": "Verbose error message about the provisioning failure" + } + } + }, + "ImageTemplateLastRunStatus": { + "type": "object", + "description": "Describes the latest status of running an image template", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "Start time of the last run (UTC)" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "End time of the last run (UTC)" + }, + "runState": { + "type": "string", + "enum": [ + "Running", + "Canceling", + "Succeeded", + "PartiallySucceeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "RunState", + "modelAsString": false + }, + "description": "State of the last run" + }, + "runSubState": { + "type": "string", + "enum": [ + "Queued", + "Building", + "Customizing", + "Optimizing", + "Validating", + "Distributing" + ], + "x-ms-enum": { + "name": "RunSubState", + "modelAsString": false + }, + "description": "Sub-state of the last run" + }, + "message": { + "type": "string", + "description": "Verbose information about the last run state" + } + } + }, + "ImageTemplateAutoRun": { + "type": "object", + "description": "Indicates if the image template needs to be built on create/update", + "properties": { + "state": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "AutoRunState", + "modelAsString": false, + "values": [ + { + "value": "Enabled", + "description": "Autorun is enabled", + "name": "AutoRunEnabled" + }, + { + "value": "Disabled", + "description": "Autorun is disabled", + "name": "AutoRunDisabled" + } + ] + }, + "description": "Enabling this field will trigger an automatic build on image template creation or update." + } + } + }, + "ImageTemplateProperties": { + "type": "object", + "description": "Describes the properties of an image template", + "properties": { + "source": { + "$ref": "#/definitions/ImageTemplateSource", + "description": "Specifies the properties used to describe the source image." + }, + "customize": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTemplateCustomizer" + }, + "x-ms-identifiers": [], + "description": "Specifies the properties used to describe the customization steps of the image, like Image source etc" + }, + "optimize": { + "type": "object", + "description": "Specifies optimization to be performed on image.", + "properties": { + "vmBoot": { + "type": "object", + "description": "Optimization is applied on the image for a faster VM boot.", + "properties": { + "state": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "VMBootOptimizationState", + "modelAsString": false + }, + "description": "Enabling this field will improve VM boot time by optimizing the final customized image output." + } + } + } + } + }, + "validate": { + "type": "object", + "description": "Configuration options and list of validations to be performed on the resulting image.", + "properties": { + "continueDistributeOnFailure": { + "type": "boolean", + "default": false, + "description": "If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.]" + }, + "sourceValidationOnly": { + "type": "boolean", + "default": false, + "description": "If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image." + }, + "inVMValidations": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTemplateInVMValidator" + }, + "x-ms-identifiers": [], + "description": "List of validations to be performed." + } + } + }, + "distribute": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTemplateDistributor" + }, + "x-ms-identifiers": [], + "description": "The distribution targets where the image output needs to go to." + }, + "errorHandling": { + "type": "object", + "description": "Error handling options upon a build failure", + "properties": { + "onCustomizerError": { + "$ref": "#/definitions/onBuildError", + "default": "cleanup", + "description": "If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved." + }, + "onValidationError": { + "$ref": "#/definitions/onBuildError", + "default": "cleanup", + "description": "If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved." + } + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource", + "readOnly": true + }, + "provisioningError": { + "$ref": "#/definitions/ProvisioningError", + "description": "Provisioning error, if any", + "readOnly": true + }, + "lastRunStatus": { + "$ref": "#/definitions/ImageTemplateLastRunStatus", + "description": "State of 'run' that is currently executing or was last executed.", + "readOnly": true + }, + "buildTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 960, + "default": 0, + "description": "Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours)." + }, + "vmProfile": { + "$ref": "#/definitions/ImageTemplateVmProfile", + "description": "Describes how virtual machine is set up to build images" + }, + "stagingResourceGroup": { + "type": "string", + "description": "The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain." + }, + "exactStagingResourceGroup": { + "type": "string", + "description": "The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty.", + "readOnly": true + }, + "autoRun": { + "$ref": "#/definitions/ImageTemplateAutoRun", + "description": "Indicates whether or not to automatically run the image template build on template creation or update." + }, + "managedResourceTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags that will be applied to the resource group and/or resources created by the service." + } + }, + "required": [ + "source", + "distribute" + ] + }, + "ImageTemplateIdentity": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identity used for the image template. The type 'None' will remove any identities from the image template.", + "enum": [ + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentities" + } + }, + "description": "Identity for the image template." + }, + "UserAssignedIdentities": { + "title": "User-Assigned Identities", + "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + }, + "UserAssignedIdentity": { + "type": "object", + "description": "User assigned identity properties", + "properties": { + "principalId": { + "description": "The principal ID of the assigned identity.", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client ID of the assigned identity.", + "type": "string", + "readOnly": true + } + } + }, + "RunOutputProperties": { + "type": "object", + "description": "Describes the properties of a run output", + "properties": { + "artifactId": { + "type": "string", + "description": "The resource id of the artifact." + }, + "artifactUri": { + "type": "string", + "description": "The location URI of the artifact." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource", + "readOnly": true + } + } + }, + "ImageTemplate": { + "type": "object", + "description": "Image template is an ARM resource managed by Microsoft.VirtualMachineImages provider", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageTemplateProperties", + "description": "The properties of the image template" + }, + "identity": { + "$ref": "#/definitions/ImageTemplateIdentity", + "description": "The identity of the image template, if configured." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "identity" + ] + }, + "ImageTemplateUpdateParameters": { + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/ImageTemplateIdentity", + "description": "The identity of the image template, if configured." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The user-specified tags associated with the image template." + }, + "properties": { + "type": "object", + "description": "Parameters for updating an image template.", + "properties": { + "distribute": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTemplateDistributor" + }, + "x-ms-identifiers": [], + "description": "The distribution targets where the image output needs to go to." + }, + "vmProfile": { + "$ref": "#/definitions/ImageTemplateVmProfile", + "description": "Describes how virtual machine is set up to build images" + } + } + } + }, + "description": "Parameters for updating an image template." + }, + "RunOutput": { + "type": "object", + "description": "Represents an output that was created by running an image template.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RunOutputProperties", + "x-ms-client-flatten": true, + "description": "The properties of the run output" + } + } + }, + "RunOutputCollection": { + "type": "object", + "description": "The result of List run outputs operation", + "properties": { + "value": { + "description": "An array of run outputs", + "type": "array", + "items": { + "$ref": "#/definitions/RunOutput" + } + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + } + }, + "TriggerStatus": { + "type": "object", + "description": "Describes the status of a trigger", + "properties": { + "code": { + "type": "string", + "description": "The status code.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages.", + "readOnly": true + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status.", + "readOnly": true + } + } + }, + "TriggerProperties": { + "type": "object", + "description": "Describes the properties of a trigger", + "discriminator": "kind", + "properties": { + "kind": { + "type": "string", + "description": "The kind of trigger.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "status": { + "$ref": "#/definitions/TriggerStatus", + "description": "Trigger status", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource", + "readOnly": true + } + }, + "required": [ + "kind" + ] + }, + "SourceImageTriggerProperties": { + "type": "object", + "description": "Properties of SourceImage kind of trigger", + "x-ms-discriminator-value": "SourceImage", + "allOf": [ + { + "$ref": "#/definitions/TriggerProperties" + } + ], + "properties": {} + }, + "Trigger": { + "type": "object", + "description": "Represents a trigger that can invoke an image template build.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TriggerProperties", + "x-ms-client-flatten": true, + "description": "The properties of a trigger" + } + } + }, + "TriggerCollection": { + "type": "object", + "description": "The result of List triggers operation", + "properties": { + "value": { + "description": "An array of triggers", + "type": "array", + "items": { + "$ref": "#/definitions/Trigger" + } + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "required": [ + "value" + ] + }, + "Operation": { + "title": "A REST API operation", + "type": "object", + "properties": { + "name": { + "title": "The operation name.", + "description": "This is of the format {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "type": "object", + "title": "The object that describes the operation.", + "properties": { + "provider": { + "title": "Friendly name of the resource provider.", + "type": "string" + }, + "operation": { + "title": "The operation type.", + "description": "For example: read, write, delete, or listKeys/action", + "type": "string" + }, + "resource": { + "title": "The resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "title": "The friendly name of the operation", + "type": "string" + } + } + }, + "origin": { + "title": "The intended executor of the operation.", + "type": "string" + }, + "properties": { + "title": "Properties of the operation.", + "type": "object" + }, + "isDataAction": { + "title": "The flag that indicates whether the operation applies to data plane.", + "type": "boolean" + } + } + }, + "OperationListResult": { + "type": "object", + "title": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [], + "title": "The list of operations supported by the resource provider." + }, + "nextLink": { + "type": "string", + "title": "The URL to get the next set of operation list results if there are any." + } + } + }, + "DistributeVersioner": { + "type": "object", + "discriminator": "scheme", + "properties": { + "scheme": { + "type": "string", + "description": "Version numbering scheme to be used." + } + }, + "description": "Describes how to generate new x.y.z version number for distribution.", + "required": [ + "scheme" + ] + }, + "DistributeVersionerLatest": { + "type": "object", + "x-ms-discriminator-value": "Latest", + "allOf": [ + { + "$ref": "#/definitions/DistributeVersioner" + } + ], + "properties": { + "major": { + "type": "integer", + "format": "int32", + "minimum": -1, + "default": -1, + "description": "Major version for the generated version number. Determine what is \"latest\" based on versions with this value as the major version. -1 is equivalent to leaving it unset." + } + }, + "description": "Generates version number that will be latest based on existing version numbers." + }, + "DistributeVersionerSource": { + "type": "object", + "x-ms-discriminator-value": "Source", + "allOf": [ + { + "$ref": "#/definitions/DistributeVersioner" + } + ], + "description": "Generates version number based on version number of source image" + } + }, + "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." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ImageTemplateNameParameter": { + "name": "imageTemplateName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image Template", + "pattern": "^[A-Za-z0-9-_.]{1,64}$", + "x-ms-parameter-location": "method" + }, + "RunOutputNameParameter": { + "name": "runOutputName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the run output", + "pattern": "^[A-Za-z0-9-_.]{1,64}$", + "x-ms-parameter-location": "method" + }, + "TriggerNameParameter": { + "name": "triggerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the trigger", + "pattern": "^[A-Za-z0-9-_.]{1,64}$", + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "Location of the service.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/imagebuilder/resource-manager/readme.md b/specification/imagebuilder/resource-manager/readme.md index 4c6ec887d75b..5006127c7dd6 100644 --- a/specification/imagebuilder/resource-manager/readme.md +++ b/specification/imagebuilder/resource-manager/readme.md @@ -28,11 +28,20 @@ These are the global settings for the Virtual Machine Image Builder API. title: ImageBuilderClient description: Azure Virtual Machine Image Builder Client openapi-type: arm -tag: package-2023-07 +tag: package-2024-02 azure-arm: true ``` +### Tag: package-2024-02 + +These settings apply only when `--tag=package-2024-02` is specified on the command line. + +```yaml $(tag) == 'package-2024-02' +input-file: + - Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json +``` + ### Tag: package-2023-07 These settings apply only when `--tag=package-2023-07` is specified on the command line. @@ -133,3 +142,12 @@ See configuration in [readme.go.md](./readme.go.md) ## Java See configuration in [readme.java.md](./readme.java.md) + +## Suppression + +``` yaml +directive: + - suppress: AvoidAdditionalProperties + from: imagebuilder.json + reason: Needed value. Exception provided in API Design review meeting. Note - suppressing entire file due to bug with where field. Suppression targets are as follows, $.definitions.ImageTemplateDistributor.properties.artifactTags, $.definitions.ImageTemplateProperties.properties.managedResourceTags, $.definitions.UserAssignedIdentities, $.definitions.ImageTemplateUpdateParameters.properties.tags +``` \ No newline at end of file From b1a1498ba20e703a447812854f18a98dbb26257e Mon Sep 17 00:00:00 2001 From: raghumunukutla <55466801+raghumunukutla@users.noreply.github.com> Date: Mon, 3 Jun 2024 18:33:48 -0700 Subject: [PATCH 26/49] Update readme.md to show up documentation for preview version (#29165) --- specification/support/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/support/resource-manager/readme.md b/specification/support/resource-manager/readme.md index 926c0f0d8e74..f9502bd273df 100644 --- a/specification/support/resource-manager/readme.md +++ b/specification/support/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the Support API. ``` yaml openapi-type: arm -tag: package-2024-04 +tag: package-preview-2023-06 ``` From a5a01e06ffbbc0b0c945cb58fe769d19a4f93af4 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Tue, 4 Jun 2024 11:35:03 +0800 Subject: [PATCH 27/49] Update readme.python.md (#29309) * Update readme.python.md * Update readme.md --------- Co-authored-by: Yuchao Yan --- specification/oracle/resource-manager/readme.md | 2 +- specification/oracle/resource-manager/readme.python.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/oracle/resource-manager/readme.md b/specification/oracle/resource-manager/readme.md index 8bfeebef57a2..252906317796 100644 --- a/specification/oracle/resource-manager/readme.md +++ b/specification/oracle/resource-manager/readme.md @@ -56,7 +56,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-track2 + - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/oracle/resource-manager/readme.python.md b/specification/oracle/resource-manager/readme.python.md index dfa3b7379f7f..f27cb510005d 100644 --- a/specification/oracle/resource-manager/readme.python.md +++ b/specification/oracle/resource-manager/readme.python.md @@ -15,5 +15,5 @@ clear-output-folder: true ``` yaml $(python) no-namespace-folders: true -output-folder: $(python-sdks-folder)/Oracle/azure-mgmt-oracledatabase/azure/mgmt/oracledatabase +output-folder: $(python-sdks-folder)/oracledatabase/azure-mgmt-oracledatabase/azure/mgmt/oracledatabase ``` From ca620a2967fc0c81616f4de3eda6bcd626bce49f Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Tue, 4 Jun 2024 13:54:51 +0800 Subject: [PATCH 28/49] Update readme.md (#29313) --- specification/mysql/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/mysql/resource-manager/readme.md b/specification/mysql/resource-manager/readme.md index 42e2426e9ebb..077bc4c72085 100644 --- a/specification/mysql/resource-manager/readme.md +++ b/specification/mysql/resource-manager/readme.md @@ -464,7 +464,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-track2 + - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js From 67e8e173b7a52626d07b4bd4001abcb5bd413b34 Mon Sep 17 00:00:00 2001 From: Konrad Jamrozik Date: Mon, 3 Jun 2024 22:57:42 -0700 Subject: [PATCH 29/49] Add info about `SDK azure-sdk-for-*` checks and `SDK azure-powershell` to `ci-fix` doc; Clean up markdownlint rules and `ci-fix` doc. (#29311) --- .markdownlint.json | 27 --- .markdownlint.jsonc | 35 ++++ .vscode/settings.json | 7 +- documentation/ci-fix.md | 362 ++++++++++++++++++++++++---------------- 4 files changed, 262 insertions(+), 169 deletions(-) delete mode 100644 .markdownlint.json create mode 100644 .markdownlint.jsonc diff --git a/.markdownlint.json b/.markdownlint.json deleted file mode 100644 index f1fb7eb9fa4f..000000000000 --- a/.markdownlint.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "default": true, - "MD001": false, - "MD003": false, - "MD004": false, - "MD005": false, - "MD006": false, - "MD007": false, - "MD009": false, - "MD012": false, - "MD013": false, - "MD020": false, - "MD022": false, - "MD024": false, - "MD025": false, - "MD026": false, - "MD028": false, - "MD029": false, - "MD031": false, - "MD032": false, - "MD033": false, - "MD034": false, - "MD036": false, - "MD040": false, - "MD041": false, - "MD047": false -} diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc new file mode 100644 index 000000000000..98657b7eff01 --- /dev/null +++ b/.markdownlint.jsonc @@ -0,0 +1,35 @@ +{ + "default": true, + + // MD013 - Line length + // https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md + // + // "line_length" : 120: + // Allow lines of length 120 instead of the default 80. Keep in sync with guide lines .vscode/settings.json. + // + // "tables": false + // Do not include tables. Breaking a line in a table to meet the line length would add a line break in the table + // itself. We do not want that. + // + // "headings": false + // Do not include headings. One cannot break lines in headings, and we sometimes need long ones, e.g. for FAQs. + "MD013": { "line_length" : 120, "tables": false, "headings": false }, + + // MD025 - Multiple top-level headings in the same document + // https://github.com/DavidAnson/markdownlint/blob/main/doc/md025.md + // + // We sometimes prefer to have multiple top-level headings in the same document. + "MD025": false, + + // MD033 - No inline HTML + // https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md + // + // We allow inline HTML as sometimes we need
within table cells. + "MD033": false, + + // MD034 - Bare URL used + // https://github.com/DavidAnson/markdownlint/blob/main/doc/md034.md + // + // We allow bare URLs e.g. to link to GitHub issues. + "MD034": false +} diff --git a/.vscode/settings.json b/.vscode/settings.json index b6989cdf872c..ec907b484778 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -31,5 +31,10 @@ "[typespec]": { "editor.defaultFormatter": "typespec.typespec-vscode", "editor.formatOnSave": true - } + }, + "[markdown]": { + "editor.rulers": [ + { "column": 120, "color": "#ff0000c0" } + ] +}, } diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index 37939d0ee8ec..dc18577707eb 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -1,128 +1,164 @@ +# CI Fix Guide + +Short link: [aka.ms/ci-fix] + +This guide provides detailed troubleshooting instructions for the [automated validation tooling] checks running on +[Azure REST API specs PR]s submitted to this repo. + +If you need help with your specs PR, please first thoroughly read the [aka.ms/azsdk/pr-getting-help] document. + # Table of Contents -- [Table of Contents](#table-of-contents) - [CI Fix Guide](#ci-fix-guide) - - [Prerequisites](#prerequisites) - - [`Swagger SpellCheck`](#swagger-spellcheck) - - [`Swagger PrettierCheck`](#swagger-prettiercheck) - - [Prettier reference](#prettier-reference) - - [`Swagger ModelValidation`](#swagger-modelvalidation) - - [`Swagger SemanticValidation`](#swagger-semanticvalidation) +- [Table of Contents](#table-of-contents) +- [Prerequisites](#prerequisites) +- [Checks troubleshooting guides](#checks-troubleshooting-guides) + - [`CredScan`](#credscan) + - [`PoliCheck`](#policheck) + - [`SDK azure-powershell`](#sdk-azure-powershell) + - [`SDK azure-sdk-for-*` checks, like `SDK azure-sdk-for-go`](#sdk-azure-sdk-for--checks-like-sdk-azure-sdk-for-go) + - [`Swagger APIView`](#swagger-apiview) + - [If an expected APIView was not generated, follow the step below to troubleshoot.](#if-an-expected-apiview-was-not-generated-follow-the-step-below-to-troubleshoot) + - [Diagnosing APIView failure for SDK Language (not Swagger or TypeSpec)](#diagnosing-apiview-failure-for-sdk-language-not-swagger-or-typespec) + - [`Swagger ApiDocPreview`](#swagger-apidocpreview) + - [`Swagger Avocado`](#swagger-avocado) + - [Get help fixing Avocado validation failures](#get-help-fixing-avocado-validation-failures) + - [Run avocado locally](#run-avocado-locally) - [`Swagger BreakingChange` and `BreakingChange(Cross-Version)`](#swagger-breakingchange-and-breakingchangecross-version) - - [Adding label on PR automatically](#adding-label-on-pr-automatically) - [Run `oad` locally](#run-oad-locally) - [`Swagger LintDiff` and `Swagger Lint(RPaaS)`](#swagger-lintdiff-and-swagger-lintrpaas) - [`Swagger LintDiff` for TypeSpec: troubleshooting guides](#swagger-lintdiff-for-typespec-troubleshooting-guides) - - [`Record` causes `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition`](#recordunkown-causes-avoidadditionalproperties-and-propertiestypeobjectnodefinition) + - [`Record` causes `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition`](#recordunknown-causes-avoidadditionalproperties-and-propertiestypeobjectnodefinition) - [`RequestBodyMustExistForPutPatch`](#requestbodymustexistforputpatch) - [`PatchPropertiesCorrespondToPutProperties`](#patchpropertiescorrespondtoputproperties) - [`@singleton` causes `EvenSegmentedPathForPutOperation` and `XmsPageableForListCalls`](#singleton-causes-evensegmentedpathforputoperation-and-xmspageableforlistcalls) - [`AvoidAnonymousParameter`, `AvoidAnonymousTypes`, `IntegerTypeMustHaveFormat`](#avoidanonymousparameter-avoidanonymoustypes-integertypemusthaveformat) - [`AvoidAnonymousTypes` inside a 202 response](#avoidanonymoustypes-inside-a-202-response) - [`OAuth2Auth` causes `XmsEnumValidation`](#oauth2auth-causes-xmsenumvalidation) - - [`Swagger Avocado`](#swagger-avocado) - - [Get help fixing Avocado validation failures](#get-help-fixing-avocado-validation-failures) - - [Run avocado locally](#run-avocado-locally) - - [`Swagger ApiDocPreview`](#swagger-apidocpreview) + - [`Swagger ModelValidation`](#swagger-modelvalidation) + - [`Swagger PrettierCheck`](#swagger-prettiercheck) + - [Prettier reference](#prettier-reference) + - [`Swagger SemanticValidation`](#swagger-semanticvalidation) + - [`Swagger SpellCheck`](#swagger-spellcheck) - [`TypeSpec Validation`](#typespec-validation) - [Run `tsv` locally](#run-tsv-locally) - - [APIView Failures: troubleshooting guides](#apiview-failures-troubleshooting-guides) - - [Suppression Process](#suppression-process) - - [Checks not covered by this guide](#checks-not-covered-by-this-guide) - - [Obsolete checks](#obsolete-checks) + - [`license/cla`](#licensecla) +- [Suppression Process](#suppression-process) +- [Checks not covered by this guide](#checks-not-covered-by-this-guide) +- [Obsolete checks](#obsolete-checks) -# CI Fix Guide +# Prerequisites -Short link: https://aka.ms/azsdk/ci-fix +Most guides here require for you to have `npm` installed, which you can get by installing [Node.js](https://nodejs.org/en/download). -This page provides detailed instructions on how to diagnose, reproduce, fix and get help on various [automated validation tooling] failures on your [Azure REST API specs PR]. +# Checks troubleshooting guides -For more help, see [aka.ms/azsdk/pr-getting-help] and [aka.ms/azsdk/support]. +## `CredScan` -## Prerequisites +This check is owned by One Engineering System. See [1ES CredScan] for help. -Most guides here require for you to have `npm` installed, which you can get by installing [Node.js](https://nodejs.org/en/download). +## `PoliCheck` -## `Swagger SpellCheck` +This check is owned by One Engineering System. See [1ES PoliCheck] for help. -If you receive a spelling failure either fix the spelling to match or if there are words that need to be suppressed for your service then add the word to the override list in [cspell.json](https://github.com/Azure/azure-rest-api-specs/blob/main/cSpell.json). Either -add to your existing section or create a new section for your specific spec or service family if the work is more generally used in lots of files under your service. -``` - "overrides": [ - ... example of specific file override - { - "filename": "**/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json", - "words": [ - "saskey" - ] - } - ... example of specific service family override - { - "filename": "**/specification/cognitiveservices/**/*.json", - "words": [ - "flac", - "mpga" - ] - } -``` -Words are case-insensitive so use lower case for the word list. +## `SDK azure-powershell` -If you need more information on see [cspell configuration](https://cspell.org/configuration/). +> [!IMPORTANT] +> +> - This check is never blocking merging of a spec PR, even if it fails. +> - The `SDK azure-powershell` check is owned by the Shanghai division of the Azure SDK team, + not the core Redmond Azure SDK team. -*Note*: We are trying to move away from one shared dictionary file so try and avoid editing custom-words.txt in the root as it will likely go away in the future. +The owner of this check is Yeming Liu from the Shanghai division of the Azure SDK team. +Please reach out to him with with any questions or concerns. -## `Swagger PrettierCheck` +## `SDK azure-sdk-for-*` checks, like `SDK azure-sdk-for-go` -First, ensure you have fulfilled `Prerequisites` as explained above. +> [!IMPORTANT] +> +> - The `SDK azure-sdk-for-*` checks are owned by the Shanghai division of the Azure SDK team, + not the core Redmond Azure SDK team. +> - Only `SDK azure-sdk-for-go` check failure will block a specs PR, because this check serves as a canary for the + entire `SDK azure-sdk-for-*` group of checks. -To update all the spec files for a given service run the following: +If you have an issue or with any of checks listed in the first column of the table below: -``` -# To fix all the files in the repo run from the root of the repo -cd +| Check name | Owner | +|-----------------------------------|----------------| +| `SDK azure-sdk-for-go` | Ray Chen | +| `SDK azure-sdk-for-java` | Weidong Xu | +| `SDK azure-sdk-for-js` | Qiaoqiao Zhang | +| `SDK azure-sdk-for-net` | Wei Hu | +| `SDK azure-sdk-for-net-track2` | Wei Hu | +| `SDK azure-sdk-for-python` | Yuchao Yan | +| `SDK azure-sdk-for-python-track2` | Yuchao Yan | -# OPTIONAL STEP: To fix a particular service OpenAPI spec cd to that directory like -cd specification/contosowidgetmanager +Do the following: -# Install the dependencies to the local 'node_modules' folder. -npm install +1. Attempt to diagnose the issue yourself: + 1. Look at the affected PR's `checks` tab for the failing check. + 1. Click on the `View Azure DevOps build log for more details.` link from that tab and inspect the devOps logs. + For example, for `SDK azure-sdk-for-go` check look into the `SDK azure-sdk-fo-go` job, `SDK Automation` task logs. +1. If your investigation denotes this is likely a bug in the check itself and not your PR, reach out + to the owner of the check per the aforementioned table. -# Run 'prettier --check' to verify the problems can be reproduced locally -npx prettier --check **/*.json +## `Swagger APIView` -# Run 'prettier --write' to fix the problems. -npx prettier --write **/*.json -``` +Various APIViews are generated as part of the Azure REST API specs PR build. Among these are TypeSpec and Swagger as well as any other language that is being generated in the run. When everything is successful you should see a comment box similar to the picture below showing the APIViews generated for TypeSpec or Swagger, plus all other languages being generated. -Then please commit and push changes made by prettier. +![alt text](image-3.png) -### Prettier reference +### If an expected APIView was not generated, follow the step below to troubleshoot. -- [`prettier` npm package](https://www.npmjs.com/package/prettier). -- [Source: Swagger-Prettier-Check.ps1](https://github.com/Azure/azure-rest-api-specs/blob/main/eng/scripts/Swagger-Prettier-Check.ps1) -- [Pipeline: Swagger PrettierCheck](https://dev.azure.com/azure-sdk/public/_build?definitionId=6405) +- On the CI check click on `details` > `View Azure DevOps build log for more details` to view the devOps logs. +- Investigate the CI job for the languge with error. TypeSpec and Swagger APIViews are generated as part of the `AzureRestApiSpecsPipeline` stage in the `TypeSpecAPIView` and `SwaggerAPIView` jobs respectively, while APIViews for other SDK languges are generated in their respective language jobs in the `SDK Automation` stage. +- Ensure that all previous checks in the job are green before proceeding. -## `Swagger ModelValidation` +### Diagnosing APIView failure for SDK Language (not Swagger or TypeSpec) -To repro issues with `Swagger ModelValidation` locally: -``` -npm install -g oav -oav validate-example -``` -Please see [readme](https://github.com/Azure/oav/blob/bd04e228b4181c53769ed88e561dec5212e77253/README.md) for how to install or run tool in details. -Refer to [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/Semantic-and-Model-Violations-Reference.md) for detailed description of validations and how-to-fix guidance. -Refer to [Swagger-Example-Generation](https://github.com/Azure/oav/blob/develop/documentation/example-generation.md) for example automatic generation. +1. Check for an unexpected skip of the `Publish SDK APIView Artifact to Pipeline Artifacts` and `Generate SDK APIView` step. +2. Look in `SDK Automation` step to verify that the API token generation completed successfully. +3. Search logs for `Read Temp File` +4. Below `Read Temp File` find the .json object and search within to locate the `apiViewArtifact` property. +5. If not present, the APIView parser for the language failed to generate the `APIView Token Artifacts`. +6. Please contact [APIView Support Teams Channel] for assistance. -## `Swagger SemanticValidation` +## `Swagger ApiDocPreview` -To repro issues with `Swagger SemanticValidation` locally: -``` -npm install -g oav -oav validate-spec +If you see `Swagger ApiDocPreview` check fail with a failure [like this one](https://github.com/Azure/azure-rest-api-specs/pull/24841/checks?check_run_id=15056283615): + +| Rule | Message | +|-|-| +| ❌ RestBuild error | "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=373646&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
"detail":"Run.ps1 failed with exit code 1 " | + +Refer to [troubleshooting REST API documentation](https://eng.ms/docs/products/azure-developer-experience/design/api-docs-troubleshooting). + +## `Swagger Avocado` + +> [!IMPORTANT] +> `Swagger Avocado` check is not a blocking for merging your PR, even if it fails. +> It is left to the discretion of the PR reviewer if the Avocado failure actually +> needs to be addressed or suppressed. + +### Get help fixing Avocado validation failures + +Refer to [Avocado README](https://github.com/Azure/avocado/blob/master/README.md) for detailed description of validations and how-to-fix guidance. + +### Run avocado locally + +``` powershell +npm install -g @azure/avocado + +avocado ``` -Please see [readme](https://github.com/Azure/oav/blob/bd04e228b4181c53769ed88e561dec5212e77253/README.md) for how to install or run tool in details. -Refer to [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/Semantic-and-Model-Violations-Reference.md) for detailed description of validations and how-to-fix guidance. + +When type avocado in command line, avocado will validate in the current directory. + +Note: When running in OpenAPI spec PR pipeline, Avocado only report errors with file updates in the PR, but ignore the errors existing in base. However when running Avocado against local directory, it reports all errors existing in the files. + +- Run all specs: Clone the repo `azure/azure-rest-api-specs` and run "avocado" in folder `azure/azure-rest-api-specs`. +- Run single service specs: create a folder `specification`. and move your service specs folder in `specification`. run "avocado" ## `Swagger BreakingChange` and `BreakingChange(Cross-Version)` @@ -131,18 +167,21 @@ See [aka.ms/azsdk/pr-brch-deep](https://aka.ms/azsdk/pr-brch-deep). If you want ### Run `oad` locally To repro issues with "breaking changes" checks, you can locally run the tool that powers them: [Azure/openapi-diff](https://github.com/Azure/openapi-diff), aka `oad`: -``` + +``` powershell npm install -g @azure/oad oad compare ``` + Please see [readme](https://github.com/Azure/openapi-diff/blob/main/README.md) for how to install or run tool in details. Refer to [Oad Docs](https://github.com/Azure/openapi-diff/tree/main/docs) for detailed description of all oad rules. + ## `Swagger LintDiff` and `Swagger Lint(RPaaS)` The [LintDiff validation tool](https://github.com/Azure/azure-openapi-validator) runs linting rules against specification difference. Two specifications are compared: the specification as it would be when proposed PR is merged, vs the specification as seen before the PR is merged. -Refer to [openapi-authoring-automated-guidelines](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md) for detailed description of all lint rules and how-to-fix guidance. +Refer to [openapi-authoring-automated-guidelines](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md) for detailed description of all lint rules and how-to-fix guidance. If that guidance is not enough, please also refer to the [LintDiff rules.md doc](https://github.com/Azure/azure-openapi-validator/blob/main/docs/rules.md). It links to `.md` files related to given error, containing instructions how to fix them. To reproduce LintDiff failures locally, see [CONTRIBUTING.md / How to locally reproduce a LintDiff failure occurring on a PR](https://github.com/Azure/azure-openapi-validator/blob/main/CONTRIBUTING.md#how-to-locally-reproduce-a-lintdiff-failure-occurring-on-a-pr). @@ -153,9 +192,9 @@ Check `Swagger LintDiff` may fail for the OpenAPI generated from TypeSpec, even We are working to address the root causes (where possible). Until then, we recommend you [suppress](#suppression-process) these LintDiff errors, using a "permanent suppression" with a descriptive "reason", so we can revert your suppression when the root cause is fixed. -### `Record` causes `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition` +### `Record` causes `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition` -The use of `Record` in TypeSpec is discouraged, and there is a TypeSpec lint rule to enforce this. If you still need to use `Record`, the OpenAPI spec generated will cause many LintDiff errors of types `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition`. You will need to suppress both the TypeSpec violation (in TypeSpec source code) and the LintDiff violations. +The use of `Record` in TypeSpec is discouraged, and there is a TypeSpec lint rule to enforce this. If you still need to use `Record`, the OpenAPI spec generated will cause many LintDiff errors of types `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition`. You will need to suppress both the TypeSpec violation (in TypeSpec source code) and the LintDiff violations. ### `RequestBodyMustExistForPutPatch` @@ -173,9 +212,9 @@ If `EvenSegmentedPathForPutOperation` and/or `XmsPageableForListCalls` are faili Data-plane specs can suppress violations of the following rules, since they only exist for the benefit of SDKs generated from swagger, and data-plane SDKs are generated directly from TypeSpec. Resource-manager specs should **not** suppress violations of these rules, since resource-manager SDKs are generated from OpenAPI, and rely on these errors being fixed. -* `AvoidAnonymousParameter` -* `AvoidAnonymousTypes` -* `IntegerTypeMustHaveFormat` +- `AvoidAnonymousParameter` +- `AvoidAnonymousTypes` +- `IntegerTypeMustHaveFormat` ### `AvoidAnonymousTypes` inside a 202 response @@ -185,7 +224,7 @@ As an exception to the previous note, resource-manager specs **may** be able to TypeSpec using `OAuth2Auth` may generate the following OpenAPI: -``` +``` yaml "type": { "type": "string", "description": "OAuth2 authentication", @@ -197,41 +236,91 @@ TypeSpec using `OAuth2Auth` may generate the following OpenAPI: Which causes error `XmsEnumValidation`. The recommended workaround is to add `omit-unreachable-types: true` to your `tspconfig.yaml`. -## `Swagger Avocado` +## `Swagger ModelValidation` ->[!IMPORTANT] -> `Swagger Avocado` check is not a blocking for merging your PR, even if it fails. -> It is left to the discretion of the PR reviewer if the Avocado failure actually -> needs to be addressed or suppressed. +To repro issues with `Swagger ModelValidation` locally: -### Get help fixing Avocado validation failures +``` powershell +npm install -g oav +oav validate-example +``` -Refer to [Avocado README](https://github.com/Azure/avocado/blob/master/README.md) for detailed description of validations and how-to-fix guidance. +Please see [readme](https://github.com/Azure/oav/blob/bd04e228b4181c53769ed88e561dec5212e77253/README.md) for how to install or run tool in details. +Refer to [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/Semantic-and-Model-Violations-Reference.md) for detailed description of validations and how-to-fix guidance. +Refer to [Swagger-Example-Generation](https://github.com/Azure/oav/blob/develop/documentation/example-generation.md) for example automatic generation. -### Run avocado locally +## `Swagger PrettierCheck` + +First, ensure you have fulfilled `Prerequisites` as explained above. + +To update all the spec files for a given service run the following: + +``` powershell +# To fix all the files in the repo run from the root of the repo +cd + +# OPTIONAL STEP: To fix a particular service OpenAPI spec cd to that directory like +cd specification/contosowidgetmanager + +# Install the dependencies to the local 'node_modules' folder. +npm install + +# Run 'prettier --check' to verify the problems can be reproduced locally +npx prettier --check **/*.json +# Run 'prettier --write' to fix the problems. +npx prettier --write **/*.json ``` -npm install -g @azure/avocado -avocado +Then please commit and push changes made by prettier. + +### Prettier reference + +- [`prettier` npm package](https://www.npmjs.com/package/prettier) +- [Source: Swagger-Prettier-Check.ps1](https://github.com/Azure/azure-rest-api-specs/blob/main/eng/scripts/Swagger-Prettier-Check.ps1) +- [Pipeline: Swagger PrettierCheck](https://dev.azure.com/azure-sdk/public/_build?definitionId=6405) + +## `Swagger SemanticValidation` + +To repro issues with `Swagger SemanticValidation` locally: + +``` powershell +npm install -g oav +oav validate-spec ``` -When type avocado in command line, avocado will validate in the current directory. +Please see [readme](https://github.com/Azure/oav/blob/bd04e228b4181c53769ed88e561dec5212e77253/README.md) for how to install or run tool in details. +Refer to [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/Semantic-and-Model-Violations-Reference.md) for detailed description of validations and how-to-fix guidance. -Note: When running in OpenAPI spec PR pipeline, Avocado only report errors with file updates in the PR, but ignore the errors existing in base. However when running Avocado against local directory, it reports all errors existing in the files. +## `Swagger SpellCheck` -- Run all specs: Clone the repo `azure/azure-rest-api-specs` and run "avocado" in folder `azure/azure-rest-api-specs`. -- Run single service specs: create a folder `specification`. and move your service specs folder in `specification`. run "avocado" +If you receive a spelling failure either fix the spelling to match or if there are words that need to be suppressed for your service then add the word to the override list in [cspell.json](https://github.com/Azure/azure-rest-api-specs/blob/main/cSpell.json). Either +add to your existing section or create a new section for your specific spec or service family if the work is more generally used in lots of files under your service. -## `Swagger ApiDocPreview` +``` yaml + "overrides": [ + ... example of specific file override + { + "filename": "**/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json", + "words": [ + "saskey" + ] + } + ... example of specific service family override + { + "filename": "**/specification/cognitiveservices/**/*.json", + "words": [ + "flac", + "mpga" + ] + } +``` -If you see `Swagger ApiDocPreview ` check fail with a failure [like this one](https://github.com/Azure/azure-rest-api-specs/pull/24841/checks?check_run_id=15056283615): +Words are case-insensitive so use lower case for the word list. -| Rule | Message | -|-|-| -| ❌ RestBuild error | "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=373646&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
"detail":"Run.ps1 failed with exit code 1 " | +If you need more information on see [cspell configuration](https://cspell.org/configuration/). -Refer to [troubleshooting REST API documentation](https://eng.ms/docs/products/azure-developer-experience/design/api-docs-troubleshooting). +*Note*: We are trying to move away from one shared dictionary file so try and avoid editing custom-words.txt in the root as it will likely go away in the future. ## `TypeSpec Validation` @@ -239,7 +328,7 @@ This validator will help ensure your TypeSpec project follows [standard conventi ### Run `tsv` locally -``` +``` powershell cd git checkout git merge @@ -247,43 +336,31 @@ npm ci npx tsv git commit; git push (if any changes) -# example +# example npx tsv specification/contosowidgetmanager/Contoso.WidgetManager ``` + Then check any errors that might be outputted and address any issues as needed. If there are changed files after the runit generally means -that the generated OpenAPI spec files were not in-sync with the TypeSpec project and you should include those changes in your pull request as well. +that the generated OpenAPI spec files were not in-sync with the TypeSpec project and you should include those changes in your pull request as well. If none of the above helped, please reach out on [TypeSpec Discussions Teams channel]. -## APIView Failures: troubleshooting guides -Various APIViews are generated as part of the Azure REST API specs PR build. Among these are TypeSpec and Swagger as well as any other language that is being generated in the run. When everything is successful you should see a comment box similar to the picture below showing the APIViews generated for TypeSpec or Swagger, plus all other languages being generated. - -![alt text](image-3.png) - -#### If an expected APIView was not generated, follow the step below to troubleshoot. - -- On the CI check click on `details` > `View Azure DevOps build log for more details` to view the devOps logs. -- Investigate the CI job for the languge with error. TypeSpec and Swagger APIViews are generated as part of the `AzureRestApiSpecsPipeline` stage in the `TypeSpecAPIView` and `SwaggerAPIView` jobs respectively, while APIViews for other SDK languges are generated in their respective language jobs in the `SDK Automation` stage. -- Ensure that all previous checks in the job are green before proceeding. +## `license/cla` -#### Diagnosing APIView failure for SDK Language (not Swagger or TypeSpec) -1. Check for an unexpected skip of the `Publish SDK APIView Artifact to Pipeline Artifacts` and `Generate SDK APIView` step. -2. Look in `SDK Automation` step to verify that the API token generation completed successfully. -3. Search logs for `Read Temp File` -4. Below `Read Temp File` find the .json object and search within to locate the `apiViewArtifact` property. -5. If not present, the APIView parser for the language failed to generate the `APIView Token Artifacts`. -6. Please contact [APIView Support Teams Channel] for assistance. +This check is owned by One Engineering System. See [1ES GitHub inside Microsoft] for help. -## Suppression Process +# Suppression Process -In case there are validation errors reported against your service that you believe do not apply, we have a suppression process you can follow to permanently remove these reported errors for your specs. Refer to the [suppression guide](https://aka.ms/pr-suppressions) for detailed guidance. +In case there are validation errors reported against your service that you believe do not apply, +we have a suppression process you can follow to permanently remove these reported errors for your specs. +Refer to the [suppression guide](https://aka.ms/pr-suppressions) for detailed guidance. -## Checks not covered by this guide +# Checks not covered by this guide -If you have an issue with a check that is not covered by this guide and the help at [aka.ms/azsdk/pr-getting-help] is not enough, -please reach out on the Teams channel: [aka.ms/azsdk/support/specreview-channel]. +If you have an issue with a check that is not covered by this guide and the help at [aka.ms/azsdk/pr-getting-help], +see [aka.ms/azsdk/support]. -## Obsolete checks +# Obsolete checks Following checks have been removed from the validation toolchain as of August 2023. @@ -291,10 +368,13 @@ Following checks have been removed from the validation toolchain as of August 20 - Service API Readiness Test - Traffic validation -[automated validation tooling]: https://eng.ms/docs/products/azure-developer-experience/design/api-specs/api-tooling -[Azure REST API specs PR]: https://eng.ms/docs/products/azure-developer-experience/design/api-specs-pr/api-specs-pr +[1ES CredScan]: https://eng.ms/docs/cloud-ai-platform/devdiv/one-engineering-system-1es/1es-docs/1es-pipeline-templates/features/sdlanalysis/credscan +[1ES GitHub inside Microsoft]: https://eng.ms/docs/more/github-inside-microsoft/policies/cla +[1ES PoliCheck]: https://eng.ms/docs/cloud-ai-platform/devdiv/one-engineering-system-1es/1es-docs/1es-pipeline-templates/features/sdlanalysis/policheck [aka.ms/azsdk/pr-getting-help]: https://aka.ms/azsdk/pr-getting-help -[aka.ms/azsdk/support/specreview-channel]: https://aka.ms/azsdk/support/specreview-channel [aka.ms/azsdk/support]: https://aka.ms/azsdk/support -[TypeSpec Discussions Teams channel]: https://teams.microsoft.com/l/channel/19%3A906c1efbbec54dc8949ac736633e6bdf%40thread.skype/TypeSpec%20Discussion%20%F0%9F%90%AE?groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47 +[aka.ms/ci-fix]: https://aka.ms/ci-fix [APIView Support Teams Channel]: https://teams.microsoft.com/l/channel/19%3A3adeba4aa1164f1c889e148b1b3e3ddd%40thread.skype/APIView?groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47 +[automated validation tooling]: https://eng.ms/docs/products/azure-developer-experience/design/api-specs/api-tooling +[Azure REST API specs PR]: https://eng.ms/docs/products/azure-developer-experience/design/api-specs-pr/api-specs-pr +[TypeSpec Discussions Teams channel]: https://teams.microsoft.com/l/channel/19%3A906c1efbbec54dc8949ac736633e6bdf%40thread.skype/TypeSpec%20Discussion%20%F0%9F%90%AE?groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47 From b77b86f656d0b629bb5499887053fdf2fd434bd8 Mon Sep 17 00:00:00 2001 From: Konrad Jamrozik Date: Tue, 4 Jun 2024 02:58:08 -0700 Subject: [PATCH 30/49] Update ci-fix.md: clarify that `SDK azure-powershell` is owned by `Azure.Core`. (#29318) * Update ci-fix.md * Update ci-fix.md * Update ci-fix.md --- documentation/ci-fix.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index dc18577707eb..19069d1d9c5a 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -67,11 +67,11 @@ This check is owned by One Engineering System. See [1ES PoliCheck] for help. > [!IMPORTANT] > > - This check is never blocking merging of a spec PR, even if it fails. -> - The `SDK azure-powershell` check is owned by the Shanghai division of the Azure SDK team, - not the core Redmond Azure SDK team. +> - The `SDK azure-powershell` check is owned by the `Azure.Core` team, + not the Azure SDK team. -The owner of this check is Yeming Liu from the Shanghai division of the Azure SDK team. -Please reach out to him with with any questions or concerns. +The owner of this check is Yeming Liu from the `Azure.Core` team. +Please reach out to him with any questions. ## `SDK azure-sdk-for-*` checks, like `SDK azure-sdk-for-go` From fbf00060551301f0aac38a67b3a544fb28fc1677 Mon Sep 17 00:00:00 2001 From: will Date: Tue, 4 Jun 2024 22:32:04 +0800 Subject: [PATCH 31/49] RouteMatrix 2024-06-01-preview (#29153) * first commit * fix * Add operationType * rename to pointType * fix * update * Update example * update * update description for default value * update description * Remove axleCount for RouteMatrix * Update vehicleSpec * update description * Update description * remove async result * Revert "remove async result" This reverts commit b7b272883564048269cb93ac2f068e1d9e5ef7c2. * Remove Summary * follow azure's convention * Remove Accept-Language for RouteMatrix * Update retention period to 24 hours * Add createdDateTime * Add suppressions * Update description --------- Co-authored-by: Will Huang Co-authored-by: Joel Hendrix --- .../examples/DirectionsAsyncBatch.json | 18 + .../examples/GetRouteMatrixAsyncResult.json | 118 + .../GetRouteOperationStatusFailed.json | 20 + .../GetRouteOperationStatusRunning.json | 16 + .../GetRouteOperationStatusSucceeded.json | 19 + .../examples/PostRouteDirections.json | 485 +++ .../examples/PostRouteDirectionsBatch.json | 175 + .../examples/PostRouteMatrix.json | 166 + .../examples/PostRouteMatrixAsync.json | 62 + .../examples/PostRouteRange.json | 267 ++ .../examples/PostRouteRangeBatch.json | 534 +++ .../examples/PostSnapToRoads.json | 76 + .../examples/PostSnapToRoadsBatch.json | 141 + .../preview/2024-06-01-preview/route.json | 3687 +++++++++++++++++ specification/maps/data-plane/Route/readme.md | 22 +- 15 files changed, 5803 insertions(+), 3 deletions(-) create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/DirectionsAsyncBatch.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteMatrixAsyncResult.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteOperationStatusFailed.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteOperationStatusRunning.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteOperationStatusSucceeded.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteDirections.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteDirectionsBatch.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteMatrix.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteMatrixAsync.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteRange.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteRangeBatch.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostSnapToRoads.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostSnapToRoadsBatch.json create mode 100644 specification/maps/data-plane/Route/preview/2024-06-01-preview/route.json diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/DirectionsAsyncBatch.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/DirectionsAsyncBatch.json new file mode 100644 index 000000000000..399945776e9b --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/DirectionsAsyncBatch.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "AzureKey": "[subscription-key]", + "directionsAsyncBatchRequestBody": { + "inputBlobUrl": "https://exampleinputstorage.blob.core.windows.net/asyncbatch/directionsBatchItems.json", + "outputStorageUrl": "https://exampleoutputstorage.blob.core.windows.net/", + "msiClientId": "12345678-abcd-1234-efgh-12345678ijkl" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/asyncBatch/operations/9f8b47e2-df6e-4f12-a1ce-d5673f9b58f8?api-version=2024-04-01-preview" + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteMatrixAsyncResult.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteMatrixAsyncResult.json new file mode 100644 index 000000000000..13fbb9da7082 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteMatrixAsyncResult.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "id": "bc3f9365-3ee0-4564-aa27-825016325557" + }, + "responses": { + "200": { + "body": { + "kind": "RouteMatrix", + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 9.15049, + 45.458545 + ], + [ + 11.499931, + 48.149853 + ] + ] + }, + "properties": { + "originIndex": 0, + "destinationIndex": 0, + "departureTime": "2022-12-19T16:39:57+01:00", + "arrivalTime": "2022-12-20T00:21:14+01:00", + "distanceInMeters": 573064, + "durationInSeconds": 27677, + "durationTrafficInSeconds": 27677 + } + }, + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 9.15049, + 45.458545 + ], + [ + 11.499931, + 48.149853 + ] + ] + }, + "properties": { + "originIndex": 0, + "destinationIndex": 1, + "error": { + "code": "OUT_OF_REGION", + "message": "Input coordinates out of region" + } + } + }, + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 11.050541, + 45.403337 + ], + [ + 11.499931, + 48.149853 + ] + ] + }, + "properties": { + "originIndex": 1, + "destinationIndex": 0, + "departureTime": "2022-12-19T16:39:57+01:00", + "arrivalTime": "2022-12-19T22:19:10+01:00", + "distanceInMeters": 452488, + "durationInSeconds": 20353, + "durationTrafficInSeconds": 20353 + } + }, + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 11.050541, + 45.403337 + ], + [ + 14.538226, + 50.033688 + ] + ] + }, + "properties": { + "originIndex": 1, + "destinationIndex": 1, + "error": { + "code": "OUT_OF_REGION", + "message": "Input coordinates out of region" + } + } + } + ], + "summary": { + "totalCount": 4, + "successfulCount": 2 + } + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteOperationStatusFailed.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteOperationStatusFailed.json new file mode 100644 index 000000000000..4e05e5536ff2 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteOperationStatusFailed.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "id": "bc3f9365-3ee0-4564-aa27-825016325557" + }, + "responses": { + "200": { + "body": { + "kind": "RouteMatrix", + "status": "Failed", + "createdDateTime": "2023-01-01T00:00:00Z", + "lastActionDateTime": "2023-01-01T00:05:00Z", + "error": { + "code": "Service is temporarily unavailable", + "message": "Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteOperationStatusRunning.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteOperationStatusRunning.json new file mode 100644 index 000000000000..d709010c5f6c --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteOperationStatusRunning.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "id": "bc3f9365-3ee0-4564-aa27-825016325557" + }, + "responses": { + "200": { + "body": { + "kind": "RouteMatrix", + "status": "Running", + "createdDateTime": "2023-01-01T00:00:00Z", + "lastActionDateTime": "2023-01-01T00:05:00Z" + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteOperationStatusSucceeded.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteOperationStatusSucceeded.json new file mode 100644 index 000000000000..2ea80d0995ab --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/GetRouteOperationStatusSucceeded.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "id": "bc3f9365-3ee0-4564-aa27-825016325557" + }, + "responses": { + "200": { + "body": { + "kind": "RouteMatrix", + "status": "Succeeded", + "createdDateTime": "2023-01-01T00:00:00Z", + "lastActionDateTime": "2023-01-01T00:05:00Z", + "result": { + "resultUrl": "https://atlas.microsoft.com/route/operations/a2-aa117770-8831-49d8-b721-19a04246bf6c-0015/result?api-version=2024-06-01-preview" + } + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteDirections.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteDirections.json new file mode 100644 index 000000000000..dea726cb19c4 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteDirections.json @@ -0,0 +1,485 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "routeDirectionsRequest": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.201399, + 47.608678 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 0, + "pointType": "waypoint" + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.20687, + 47.612002 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 1, + "pointType": "viaWaypoint" + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.201669, + 47.615076 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 2, + "pointType": "waypoint" + } + } + ], + "optimizeRoute": "fastestWithTraffic", + "routeOutputOptions": [ + "routePath" + ], + "maxRouteCount": 3, + "travelMode": "driving" + } + }, + "responses": { + "200": { + "body": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.20147, + 47.608676 + ] + }, + "properties": { + "type": "Waypoint", + "routePathPoint": { + "legIndex": 0, + "pointIndex": 0 + }, + "order": { + "inputIndex": 0 + }, + "compassDirection": "north", + "instruction": { + "formattedText": "Head north on Bellevue Way SE toward SE 1st St", + "maneuverType": "DepartStart", + "text": "Head north on Bellevue Way SE toward SE 1st St" + }, + "sideOfStreet": "Unknown", + "towardsRoadName": "SE 1st St", + "distanceInMeters": 98.2, + "durationInSeconds": 19, + "steps": [ + { + "routePathRange": { + "legIndex": 0, + "range": [ + 0, + 1 + ] + }, + "maneuverType": "DepartStart", + "compassDegrees": 358, + "roadType": "Arterial", + "names": [ + "Bellevue Way SE" + ] + } + ], + "travelMode": "driving" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.201495, + 47.610109 + ] + }, + "properties": { + "type": "ManeuverPoint", + "routePathPoint": { + "legIndex": 0, + "pointIndex": 1 + }, + "compassDirection": "north", + "instruction": { + "formattedText": "Turn left onto Main st", + "maneuverType": "TurnLeft", + "text": "Turn left onto Main st" + }, + "sideOfStreet": "Unknown", + "distanceInMeters": 253.5, + "durationInSeconds": 81, + "steps": [ + { + "routePathRange": { + "legIndex": 0, + "range": [ + 1, + 3 + ] + }, + "maneuverType": "TurnLeft", + "compassDegrees": 358, + "roadType": "Arterial", + "names": [ + "Main st" + ] + } + ], + "travelMode": "driving" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.206817, + 47.610185 + ] + }, + "properties": { + "type": "ManeuverPoint", + "routePathPoint": { + "legIndex": 0, + "pointIndex": 3 + }, + "compassDirection": "north", + "instruction": { + "formattedText": "Turn right onto 100th Ave NE", + "maneuverType": "TurnRight", + "text": "Turn right onto 100th Ave NE" + }, + "sideOfStreet": "Unknown", + "distanceInMeters": 252.9, + "durationInSeconds": 49, + "steps": [ + { + "routePathRange": { + "legIndex": 0, + "range": [ + 3, + 5 + ] + }, + "maneuverType": "TurnRight", + "compassDegrees": 357, + "roadType": "Arterial", + "names": [ + "100th Ave NE" + ] + } + ], + "travelMode": "driving" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.206971, + 47.61384 + ] + }, + "properties": { + "type": "ManeuverPoint", + "routePathPoint": { + "legIndex": 0, + "pointIndex": 6 + }, + "compassDirection": "east", + "instruction": { + "formattedText": "Turn right onto NE 4th St", + "maneuverType": "TurnRight", + "text": "Turn right onto NE 4th St" + }, + "sideOfStreet": "Unknown", + "distanceInMeters": 247.9, + "durationInSeconds": 77, + "steps": [ + { + "routePathRange": { + "legIndex": 0, + "range": [ + 6, + 9 + ] + }, + "maneuverType": "TurnRight", + "compassDegrees": 90, + "roadType": "Arterial", + "names": [ + "NE 4th St" + ] + } + ], + "travelMode": "driving" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.201664, + 47.61386 + ] + }, + "properties": { + "type": "ManeuverPoint", + "routePathPoint": { + "legIndex": 0, + "pointIndex": 9 + }, + "compassDirection": "east", + "instruction": { + "formattedText": "Turn left onto Bellevue Way NE", + "maneuverType": "TurnLeft", + "text": "Turn left onto Bellevue Way NE" + }, + "sideOfStreet": "Unknown", + "distanceInMeters": 94.4, + "durationInSeconds": 38, + "steps": [ + { + "routePathRange": { + "legIndex": 0, + "range": [ + 9, + 11 + ] + }, + "maneuverType": "TurnLeft", + "compassDegrees": 91, + "roadType": "Arterial", + "names": [ + "Bellevue Way NE" + ] + } + ], + "travelMode": "driving" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.201603, + 47.615137 + ] + }, + "properties": { + "type": "Waypoint", + "routePathPoint": { + "legIndex": 0, + "pointIndex": 11 + }, + "order": { + "inputIndex": 2 + }, + "compassDirection": "north", + "instruction": { + "formattedText": "Arrive at Bellevue Way NE", + "maneuverType": "ArriveFinish", + "text": "Arrive at Bellevue Way NE", + "hints": [ + { + "hintType": "PreviousIntersection", + "text": "The last intersection before your destination is NE 4th St" + } + ] + }, + "sideOfStreet": "Unknown", + "distanceInMeters": 0.0, + "durationInSeconds": 0, + "steps": [ + { + "routePathRange": { + "legIndex": 0, + "range": [ + 11, + 11 + ] + }, + "maneuverType": "ArriveFinish", + "compassDegrees": 357, + "roadType": "Arterial", + "names": [ + "Bellevue Way NE" + ] + } + ], + "travelMode": "driving" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.206894, + 47.612001 + ] + }, + "properties": { + "type": "ViaWaypoint", + "names": [ + "100th Ave NE" + ], + "routePathPoint": { + "pointIndex": 5, + "legIndex": 0 + }, + "order": { + "inputIndex": 1 + } + } + }, + { + "type": "Feature", + "geometry": { + "type": "MultiLineString", + "coordinates": [ + [ + [ + -122.20147, + 47.608675 + ], + [ + -122.201494, + 47.610108 + ], + [ + -122.201496, + 47.610196 + ], + [ + -122.206817, + 47.610185 + ], + [ + -122.206824, + 47.610369 + ], + [ + -122.206893, + 47.612001 + ], + [ + -122.20697, + 47.613839 + ], + [ + -122.206832, + 47.613839 + ], + [ + -122.204428, + 47.61379 + ], + [ + -122.201664, + 47.61386 + ], + [ + -122.201547, + 47.613857 + ], + [ + -122.201603, + 47.615137 + ] + ] + ] + }, + "bbox": [ + 47.608676, + -122.206971, + 47.615137, + -122.20147 + ], + "properties": { + "type": "RoutePath", + "resourceId": "v70,h-1241513931,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s3,m1,o1,t4,wuOUjKenNR0CdnKG444xewA2~AISjUSdxkDoBAADgAdG_yz4A0~QmVsbGV2dWUgV2F5IFNF0~~~~~~~~v12,wFYvfFFbOR0CBIatbPY1ewA2~AISjUScpizoBAADgARBojT4A0~MTAwdGggQXZlIE5F0~~~1~~~~~v12,w-kZ0z7rOR0B95xcl6IxewA2~AISjUSchJDoBAADgAQAAgD8A0~QmVsbGV2dWUgV2F5IE5F0~~~~~~~~v12,k0,qatt:1", + "distanceInMeters": 947.0, + "durationInSeconds": 266, + "durationTrafficInSeconds": 295, + "trafficDataUsed": "None", + "trafficCongestion": "Mild", + "departureTime": "2023-08-28T18:00:00+00:00", + "arrivalTime": "2023-08-28T18:04:55+00:00", + "legs": [ + { + "description": "100th Ave NE, NE 4th St", + "routePathRange": { + "range": [ + 0, + 11 + ], + "legIndex": 0 + }, + "subLegs": [ + { + "routePathRange": { + "range": [ + 0, + 5 + ], + "legIndex": 0 + }, + "distanceInMeters": 477.8, + "durationInSeconds": 128, + "durationTrafficInSeconds": 138 + }, + { + "routePathRange": { + "range": [ + 5, + 11 + ], + "legIndex": 0 + }, + "distanceInMeters": 469.1, + "durationInSeconds": 137, + "durationTrafficInSeconds": 157 + } + ], + "distanceInMeters": 947.0, + "durationInSeconds": 266, + "durationTrafficInSeconds": 295, + "departureTime": "2023-08-28T18:00:00+00:00", + "arrivalTime": "2023-08-28T18:04:55+00:00" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteDirectionsBatch.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteDirectionsBatch.json new file mode 100644 index 000000000000..74b93b0950d0 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteDirectionsBatch.json @@ -0,0 +1,175 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "routeDirectionsBatchRequest": { + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.3368, + 47.614988 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 0, + "pointType": "waypoint" + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.316067, + 47.606356 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 1, + "pointType": "waypoint" + } + } + ], + "optimizeRoute": "fastestWithTraffic", + "routeOutputOptions": [ + "routeSummary" + ], + "maxRouteCount": 3, + "travelMode": "driving" + }, + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.3368, + 47.614988 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 0, + "pointType": "waypoint" + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.316067, + 47.606356 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 1, + "pointType": "waypoint" + } + } + ], + "optimizeRoute": "fastestWithTraffic", + "routeOutputOptions": [ + "routeSummary" + ], + "maxRouteCount": 3, + "travelMode": "driving" + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "successfulRequests": 2, + "totalRequests": 2 + }, + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "MultiLineString", + "coordinates": [] + }, + "properties": { + "type": "RoutePath", + "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2", + "distanceInMeters": 1432.9, + "durationInSeconds": 524, + "durationTrafficInSeconds": 554 + } + } + ], + "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B" + }, + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "MultiLineString", + "coordinates": [] + }, + "properties": { + "type": "RoutePath", + "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2", + "distanceInMeters": 1432.9, + "durationInSeconds": 524, + "durationTrafficInSeconds": 554 + } + } + ], + "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B" + } + ] + } + }, + "207": { + "body": { + "summary": { + "successfulRequests": 1, + "totalRequests": 2 + }, + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "MultiLineString", + "coordinates": [] + }, + "properties": { + "type": "RoutePath", + "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2", + "distanceInMeters": 1432.9, + "durationInSeconds": 524, + "durationTrafficInSeconds": 554 + } + } + ], + "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B" + }, + { + "error": { + "code": "400 BadRequest", + "message": "Invalid request" + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteMatrix.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteMatrix.json new file mode 100644 index 000000000000..1e9ddae0d8a1 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteMatrix.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "routeMatrixRequest": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 9.15049, + 45.458545 + ], + [ + 11.050541, + 45.403337 + ] + ] + }, + "properties": { + "pointType": "origins" + } + }, + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 11.499931, + 48.149853 + ], + [ + 14.538226, + 50.033688 + ] + ] + }, + "properties": { + "pointType": "destinations" + } + } + ], + "departAt": "2022-12-19T16:39:57+01:00", + "optimizeRoute": "fastest", + "traffic": "historical", + "travelMode": "truck", + "avoid": [ + "unpavedRoads" + ] + } + }, + "responses": { + "200": { + "body": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 9.15049, + 45.458545 + ], + [ + 11.499931, + 48.149853 + ] + ] + }, + "properties": { + "originIndex": 0, + "destinationIndex": 0, + "departureTime": "2022-12-19T16:39:57+01:00", + "arrivalTime": "2022-12-20T00:21:14+01:00", + "distanceInMeters": 573064, + "durationInSeconds": 27677, + "durationTrafficInSeconds": 27677 + } + }, + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 9.15049, + 45.458545 + ], + [ + 11.499931, + 48.149853 + ] + ] + }, + "properties": { + "originIndex": 0, + "destinationIndex": 1, + "error": { + "code": "OUT_OF_REGION", + "message": "Input coordinates out of region" + } + } + }, + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 11.050541, + 45.403337 + ], + [ + 11.499931, + 48.149853 + ] + ] + }, + "properties": { + "originIndex": 1, + "destinationIndex": 0, + "departureTime": "2022-12-19T16:39:57+01:00", + "arrivalTime": "2022-12-19T22:19:10+01:00", + "distanceInMeters": 452488, + "durationInSeconds": 20353, + "durationTrafficInSeconds": 20353 + } + }, + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 11.050541, + 45.403337 + ], + [ + 14.538226, + 50.033688 + ] + ] + }, + "properties": { + "originIndex": 1, + "destinationIndex": 1, + "error": { + "code": "OUT_OF_REGION", + "message": "Input coordinates out of region" + } + } + } + ], + "summary": { + "totalCount": 4, + "successfulCount": 2 + } + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteMatrixAsync.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteMatrixAsync.json new file mode 100644 index 000000000000..3f4b12a7ca72 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteMatrixAsync.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "routeMatrixAsyncRequest": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 9.15049, + 45.458545 + ], + [ + 11.050541, + 45.403337 + ] + ] + }, + "properties": { + "pointType": "origins" + } + }, + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 11.499931, + 48.149853 + ], + [ + 14.538226, + 50.033688 + ] + ] + }, + "properties": { + "pointType": "destinations" + } + } + ], + "departAt": "2022-12-19T16:39:57+01:00", + "optimizeRoute": "fastest", + "traffic": "historical", + "travelMode": "truck", + "avoid": [ + "unpavedRoads" + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://atlas.microsoft.com/route/operations/a2-aa117770-8831-49d8-b721-19a04246bf6c-0015?api-version=2024-06-01-preview" + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteRange.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteRange.json new file mode 100644 index 000000000000..c0c5f06b96f6 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteRange.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "routeRangeRequest": { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 5.86605, + 50.9745 + ] + }, + "properties": { + "timeBudgetInSec": 6000 + } + } + }, + "responses": { + "200": { + "body": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 5.86605, + 50.9745 + ] + }, + "properties": { + "type": "center" + } + }, + { + "type": "Feature", + "bbox": [ + 3.62838, + 49.83259, + 7.9826, + 52.25674 + ], + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 5.73602, + 52.03704 + ], + [ + 5.59435, + 52.09456 + ], + [ + 5.42279, + 52.16815 + ], + [ + 5.21276, + 52.25047 + ], + [ + 5.15355, + 52.21374 + ], + [ + 4.96687, + 52.25674 + ], + [ + 4.739, + 52.07834 + ], + [ + 4.72513, + 52.05647 + ], + [ + 4.53237, + 51.94553 + ], + [ + 4.31165, + 51.70119 + ], + [ + 4.28917, + 51.5837 + ], + [ + 3.82685, + 51.48463 + ], + [ + 3.62838, + 51.21096 + ], + [ + 3.89244, + 50.6814 + ], + [ + 3.93493, + 50.66791 + ], + [ + 3.98156, + 50.49042 + ], + [ + 4.47995, + 50.30944 + ], + [ + 4.60502, + 50.24448 + ], + [ + 4.89999, + 50.24467 + ], + [ + 5.04206, + 50.08735 + ], + [ + 5.23042, + 49.99214 + ], + [ + 5.40994, + 49.88478 + ], + [ + 5.46178, + 49.85797 + ], + [ + 5.7196, + 49.86279 + ], + [ + 5.74151, + 49.83259 + ], + [ + 5.9387, + 50.22239 + ], + [ + 6.08535, + 50.0011 + ], + [ + 6.12089, + 50.04616 + ], + [ + 6.28373, + 50.09472 + ], + [ + 6.51654, + 49.95863 + ], + [ + 6.61034, + 50.00485 + ], + [ + 6.70295, + 50.00587 + ], + [ + 6.65865, + 50.2947 + ], + [ + 6.79276, + 50.36903 + ], + [ + 7.32163, + 50.31614 + ], + [ + 7.58782, + 50.36737 + ], + [ + 7.7626, + 50.46919 + ], + [ + 7.9826, + 50.96246 + ], + [ + 7.55924, + 51.07086 + ], + [ + 7.58138, + 51.36614 + ], + [ + 7.67861, + 51.52015 + ], + [ + 7.35175, + 51.65781 + ], + [ + 7.21664, + 51.81916 + ], + [ + 7.0467, + 51.9587 + ], + [ + 6.67267, + 51.82713 + ], + [ + 6.48424, + 51.81133 + ], + [ + 6.27316, + 51.9368 + ], + [ + 6.14452, + 52.01701 + ], + [ + 6.09312, + 52.20847 + ], + [ + 6.01297, + 52.23705 + ], + [ + 5.86605, + 50.9745 + ], + [ + 5.73602, + 52.03704 + ] + ] + ] + }, + "properties": { + "type": "boundary" + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteRangeBatch.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteRangeBatch.json new file mode 100644 index 000000000000..d2c61ed6b627 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostRouteRangeBatch.json @@ -0,0 +1,534 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "routeRangeBatchRequest": { + "batchItems": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 5.86605, + 50.9745 + ] + }, + "properties": { + "timeBudgetInSec": 6000 + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "successfulRequests": 1, + "totalRequests": 1 + }, + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 5.86605, + 50.9745 + ] + }, + "properties": { + "type": "center" + } + }, + { + "type": "Feature", + "bbox": [ + 3.62838, + 49.83259, + 7.9826, + 52.25674 + ], + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 5.73602, + 52.03704 + ], + [ + 5.59435, + 52.09456 + ], + [ + 5.42279, + 52.16815 + ], + [ + 5.21276, + 52.25047 + ], + [ + 5.15355, + 52.21374 + ], + [ + 4.96687, + 52.25674 + ], + [ + 4.739, + 52.07834 + ], + [ + 4.72513, + 52.05647 + ], + [ + 4.53237, + 51.94553 + ], + [ + 4.31165, + 51.70119 + ], + [ + 4.28917, + 51.5837 + ], + [ + 3.82685, + 51.48463 + ], + [ + 3.62838, + 51.21096 + ], + [ + 3.89244, + 50.6814 + ], + [ + 3.93493, + 50.66791 + ], + [ + 3.98156, + 50.49042 + ], + [ + 4.47995, + 50.30944 + ], + [ + 4.60502, + 50.24448 + ], + [ + 4.89999, + 50.24467 + ], + [ + 5.04206, + 50.08735 + ], + [ + 5.23042, + 49.99214 + ], + [ + 5.40994, + 49.88478 + ], + [ + 5.46178, + 49.85797 + ], + [ + 5.7196, + 49.86279 + ], + [ + 5.74151, + 49.83259 + ], + [ + 5.9387, + 50.22239 + ], + [ + 6.08535, + 50.0011 + ], + [ + 6.12089, + 50.04616 + ], + [ + 6.28373, + 50.09472 + ], + [ + 6.51654, + 49.95863 + ], + [ + 6.61034, + 50.00485 + ], + [ + 6.70295, + 50.00587 + ], + [ + 6.65865, + 50.2947 + ], + [ + 6.79276, + 50.36903 + ], + [ + 7.32163, + 50.31614 + ], + [ + 7.58782, + 50.36737 + ], + [ + 7.7626, + 50.46919 + ], + [ + 7.9826, + 50.96246 + ], + [ + 7.55924, + 51.07086 + ], + [ + 7.58138, + 51.36614 + ], + [ + 7.67861, + 51.52015 + ], + [ + 7.35175, + 51.65781 + ], + [ + 7.21664, + 51.81916 + ], + [ + 7.0467, + 51.9587 + ], + [ + 6.67267, + 51.82713 + ], + [ + 6.48424, + 51.81133 + ], + [ + 6.27316, + 51.9368 + ], + [ + 6.14452, + 52.01701 + ], + [ + 6.09312, + 52.20847 + ], + [ + 6.01297, + 52.23705 + ], + [ + 5.86605, + 50.9745 + ], + [ + 5.73602, + 52.03704 + ] + ] + ] + }, + "properties": { + "type": "boundary" + } + } + ] + } + ] + } + }, + "207": { + "body": { + "summary": { + "successfulRequests": 1, + "totalRequests": 2 + }, + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 5.86605, + 50.9745 + ] + }, + "properties": { + "type": "center" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 5.73602, + 52.03704 + ], + [ + 5.59435, + 52.09456 + ], + [ + 5.42279, + 52.16815 + ], + [ + 5.21276, + 52.25047 + ], + [ + 5.15355, + 52.21374 + ], + [ + 4.96687, + 52.25674 + ], + [ + 4.739, + 52.07834 + ], + [ + 4.72513, + 52.05647 + ], + [ + 4.53237, + 51.94553 + ], + [ + 4.31165, + 51.70119 + ], + [ + 4.28917, + 51.5837 + ], + [ + 3.82685, + 51.48463 + ], + [ + 3.62838, + 51.21096 + ], + [ + 3.89244, + 50.6814 + ], + [ + 3.93493, + 50.66791 + ], + [ + 3.98156, + 50.49042 + ], + [ + 4.47995, + 50.30944 + ], + [ + 4.60502, + 50.24448 + ], + [ + 4.89999, + 50.24467 + ], + [ + 5.04206, + 50.08735 + ], + [ + 5.23042, + 49.99214 + ], + [ + 5.40994, + 49.88478 + ], + [ + 5.46178, + 49.85797 + ], + [ + 5.7196, + 49.86279 + ], + [ + 5.74151, + 49.83259 + ], + [ + 5.9387, + 50.22239 + ], + [ + 6.08535, + 50.0011 + ], + [ + 6.12089, + 50.04616 + ], + [ + 6.28373, + 50.09472 + ], + [ + 6.51654, + 49.95863 + ], + [ + 6.61034, + 50.00485 + ], + [ + 6.70295, + 50.00587 + ], + [ + 6.65865, + 50.2947 + ], + [ + 6.79276, + 50.36903 + ], + [ + 7.32163, + 50.31614 + ], + [ + 7.58782, + 50.36737 + ], + [ + 7.7626, + 50.46919 + ], + [ + 7.9826, + 50.96246 + ], + [ + 7.55924, + 51.07086 + ], + [ + 7.58138, + 51.36614 + ], + [ + 7.67861, + 51.52015 + ], + [ + 7.35175, + 51.65781 + ], + [ + 7.21664, + 51.81916 + ], + [ + 7.0467, + 51.9587 + ], + [ + 6.67267, + 51.82713 + ], + [ + 6.48424, + 51.81133 + ], + [ + 6.27316, + 51.9368 + ], + [ + 6.14452, + 52.01701 + ], + [ + 6.09312, + 52.20847 + ], + [ + 6.01297, + 52.23705 + ], + [ + 5.86605, + 50.9745 + ], + [ + 5.73602, + 52.03704 + ] + ] + ] + }, + "properties": { + "type": "boundary" + } + } + ] + }, + { + "error": { + "code": "400 BadRequest", + "message": "Invalid request" + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostSnapToRoads.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostSnapToRoads.json new file mode 100644 index 000000000000..1329eaaad885 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostSnapToRoads.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "snapToRoadsRequest": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.122353, + 47.672662 + ], + "type": "Point" + }, + "properties": {} + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.132452, + 47.644234 + ], + "type": "Point" + }, + "properties": {} + } + ], + "interpolate": true, + "includeSpeedLimit": true, + "travelMode": "driving" + } + }, + "responses": { + "200": { + "body": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.125153, + 47.671762 + ], + "type": "Point" + }, + "properties": { + "inputIndex": 0, + "isInterpolate": false, + "name": "NE 92nd St", + "speedLimitInKilometersPerHour": 45 + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.123452, + 47.645234 + ], + "type": "Point" + }, + "properties": { + "inputIndex": 1, + "isInterpolate": false, + "name": "NE 140th St", + "speedLimitInKilometersPerHour": 55 + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostSnapToRoadsBatch.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostSnapToRoadsBatch.json new file mode 100644 index 000000000000..d7db6010dc7a --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/examples/PostSnapToRoadsBatch.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "snapToRoadsBatchRequest": { + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.122353, + 47.672662 + ], + "type": "Point" + }, + "properties": {} + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.132452, + 47.644234 + ], + "type": "Point" + }, + "properties": {} + } + ], + "interpolate": false, + "includeSpeedLimit": true, + "travelMode": "driving" + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "successfulRequests": 1, + "totalRequests": 1 + }, + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.125153, + 47.671762 + ], + "type": "Point" + }, + "properties": { + "inputIndex": 0, + "isInterpolate": false, + "name": "NE 92nd St", + "speedLimitInKilometersPerHour": 45 + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.123452, + 47.645234 + ], + "type": "Point" + }, + "properties": { + "inputIndex": 1, + "isInterpolate": false, + "name": "NE 140th St", + "speedLimitInKilometersPerHour": 55 + } + } + ] + } + ] + } + }, + "207": { + "body": { + "summary": { + "successfulRequests": 1, + "totalRequests": 2 + }, + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.125153, + 47.671762 + ], + "type": "Point" + }, + "properties": { + "inputIndex": 0, + "isInterpolate": false, + "name": "NE 92nd St", + "speedLimitInKilometersPerHour": 45 + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.123452, + 47.645234 + ], + "type": "Point" + }, + "properties": { + "inputIndex": 1, + "name": "NE 140th St", + "speedLimitInKilometersPerHour": 55 + } + } + ], + "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B" + }, + { + "error": { + "code": "400 BadRequest", + "message": "Invalid request" + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-06-01-preview/route.json b/specification/maps/data-plane/Route/preview/2024-06-01-preview/route.json new file mode 100644 index 000000000000..9716543ab634 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-06-01-preview/route.json @@ -0,0 +1,3687 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Route Service", + "version": "2024-06-01-preview", + "description": "Azure Maps Route REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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> [!NOTE]\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> * The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n> * The 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> * Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n> * For more information on Microsoft identity platform, see [Microsoft identity platform overview](/entra/identity-platform/v2-overview).\n\n", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "client" + }, + "Accept-Language": { + "name": "Accept-Language", + "in": "header", + "description": "Language in which routing results should be returned. \n\nFor more information, see [Localization support in Azure Maps](https://learn.microsoft.com/en-us/azure/azure-maps/supported-languages#routing-v2-services-preview-supported-languages).", + "required": false, + "type": "string", + "x-ms-parameter-location": "client" + }, + "OperationId": { + "name": "id", + "description": "System generated unique identifier for the asynchronous operation after it has been submitted.", + "type": "string", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$", + "in": "path", + "required": true + } + }, + "paths": { + "/route/directions": { + "post": { + "summary": "Use to get the best route between an origin and destination for automobile, commercial trucks and walking routes.", + "description": "\n\nThe `Route Directions` API is an HTTP `POST` request that returns the ideal route between an origin and destination for automobile (driving), commercial trucks and walking routes. The route passes through a series of waypoints if specified. A waypoint is a geographical location defined by longitude and latitude that is used for navigational purposes. The route considers factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nThe API returns the distance, estimated travel time, and a representation of the route geometry. More routing information such as an optimized waypoint order or turn by turn instructions is also available, depending on the parameters used.\n\nThe Route Directions considers local laws, vehicle dimensions, cargo type, max speed, bridge and tunnel heights to calculate the truck specific routes and avoid complex maneuvers and difficult roads. Not all trucks can travel the same routes as other vehicles due to certain restrictions based on the vehicle profile or cargo type. For example, highways often have separate speed limits for trucks, some roads don't allow trucks with flammable or hazardous materials, and there can be height and weight restriction on bridges.\n\nUp to 25 waypoints and 10 viaWaypoints between any two waypoints is supported for driving and walking routes. Each set of waypoints creates a separate route Leg. ViaWaypoints define the route path and can be used for route creation through specific locations, but they don't create route Legs. Truck routes support up to 150 waypoints but don't support viaWaypoints.\n\nFor information about routing availability in countries/regions, see [Azure Maps routing coverage](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. For more information, see [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/).\n\n", + "operationId": "Route_PostRouteDirections", + "consumes": [ + "application/geo+json" + ], + "produces": [ + "application/geo+json", + "application/json" + ], + "x-ms-client-name": "Route_PostRouteDirections", + "x-ms-examples": { + "Successfully retrieve a route between an origin and a destination with additional parameters in the body": { + "$ref": "./examples/PostRouteDirections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/Accept-Language" + }, + { + "name": "routeDirectionsRequest", + "in": "body", + "description": "Request body of RouteDirections API in GeoJSON format.", + "required": true, + "schema": { + "$ref": "#/definitions/DirectionsRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteDirectionsResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/directions:batch": { + "post": { + "summary": "Use to send a batch of queries to the [Route Directions](/rest/api/maps/route/post-directions?view=rest-maps-2023-10-01-preview) API in a single synchronous request.", + "description": "\n\n\nThe `Route Directions Batch` API is an HTTP `POST` request that sends batches of up to **100** queries in a single call to the [Route Directions](/rest/api/maps/route/post-directions?view=rest-maps-2023-10-01-preview) API.\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions:batch?api-version=2023-10-01-preview\n```\n### POST Body for Batch Request\nTo send the _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 2 _directions_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"optionalId\": \"bbc9c0f6-ab52-49d8-a788-a658fa654c94\",\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.3368,\n 47.614988\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 0,\n \"pointType\": \"waypoint\"\n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.316067,\n 47.606356\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 1,\n \"pointType\": \"waypoint\"\n }\n }\n ],\n \"optimizeRoute\": \"fastestWithoutTraffic\",\n \"routeOutputOptions\": [\n \"routeSummary\"\n ],\n \"maxRouteCount\": 3,\n \"travelMode\": \"driving\"\n },\n {\n \"optionalId\": \"a191de3c-1268-4986-98f0-03f0a5d9302a\",\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.3368,\n 47.614988\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 0,\n \"pointType\": \"waypoint\"\n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.316067,\n 47.606356\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 1,\n \"pointType\": \"waypoint\"\n }\n }\n ],\n \"optimizeRoute\": \"shortest\",\n \"routeOutputOptions\": [\n \"routeSummary\"\n ],\n \"maxRouteCount\": 2,\n \"travelMode\": \"driving\"\n }\n ]\n}\n ```\n\nA _directions_ batchItem object can accept any of the supported _directions_ [Request body](/rest/api/maps/route/post-directions?view=rest-maps-2023-10-01-preview#request-body) \n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe 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 is of one of the following types:\n\n - [`DirectionsResponse`](/rest/api/maps/route/post-directions#response) - 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\n", + "operationId": "Route_PostRouteDirectionsBatch", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-client-name": "Route_PostRouteDirectionsBatch", + "x-ms-examples": { + "A Route Directions Batch request containing 2 queries": { + "$ref": "./examples/PostRouteDirectionsBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "routeDirectionsBatchRequest", + "in": "body", + "description": "The list of route directions queries/requests to process. The list can contain a max of 100 queries for sync version and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "#/definitions/DirectionsBatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "Batch request successfully processed. The response body contains all the batch results.", + "schema": { + "$ref": "#/definitions/DirectionsBatchResponse" + } + }, + "207": { + "description": "Multi-Status. One or more batch items could not be processed and return different status code.", + "schema": { + "$ref": "#/definitions/DirectionsBatchResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/directions:asyncBatch": { + "post": { + "description": "The Directions Asynchronous Batch API is designed for processing large volumes of route direction queries asynchronously. This API is optimized for handling high-volume batch requests without the need for immediate response times, making it ideal for extensive geocoding operations.\n\nAfter submitting your batch request, the service processes the queries in the background. You can check the status of the request periodically and retrieve the results once they are available. This approach is beneficial for applications that can accommodate longer processing times and do not require instant responses.\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. For more information, see [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/).\n\n### Submitting an Asynchronous Batch Request\n\nTo submit a request, you must provide the following:\n\n- **`inputBlobUrl`**: A URL pointing to a blob storage that contains your batch of geocoding queries. The format of the data should be consistent with that used for the synchronous batch version.\n- **`outputStorageUrl`**: The destination URL where the batch results will be stored upon completion.\n- **`msiClientId`** (optional): The Client ID of a user-assigned managed identity. This is used for authentication and authorization of both `inputBlobUrl` and `outputStorageUrl`. If the managed identity is system-assigned, this field can be left null.\n\nThe response header `Operation-Location` returns a URL with the Azure Maps geography endpoint `{geography}.atlas.microsoft.com`. To ensure that the endpoint returned in the `Operation-Location` header is the same as the submit job endpoint, using the geography endpoint is suggested.", + "operationId": "Route_SubmitDirectionsAsynchronousBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location", + "final-state-schema": "#/definitions/AsyncBatchOperation" + }, + "x-ms-examples": { + "Submit an asynchronous batch job for directions": { + "$ref": "./examples/DirectionsAsyncBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/stable/2023-06-01/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Accept-Language" + }, + { + "name": "directionsAsyncBatchRequestBody", + "in": "body", + "description": "The request body for directions asynchronous batch request.", + "required": true, + "schema": { + "$ref": "#/definitions/AsyncBatchRequestBody" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Operation-Location": { + "description": "URL to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/snapToRoads": { + "post": { + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe Snap to Roads API accepts GPS point data, represented as latitude and longitude coordinates, and generates a route that aligns with existing roadways on a map. This process, known as \"snapping to roads,\" produces a series of objects that trace a path closely following the road network. The resulting data includes road names and their respective speed limits, pertinent to the traversed segments.\n\nMoreover, the Snap to Roads API offers an interpolation feature, which refines the GPS points to create a smoother route that adheres to the road's geometry. This functionality is especially beneficial for asset tracking and enhancing data visualization in mapping applications.\n\n\n\nFor information about routing availability in countries/regions, see [Azure Maps routing coverage](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n\n", + "operationId": "Route_PostSnapToRoads", + "consumes": [ + "application/geo+json" + ], + "produces": [ + "application/geo+json", + "application/json" + ], + "x-ms-client-name": "Route_PostSnapToRoads", + "x-ms-examples": { + "Successfully retrieve a snap to roads points with additional parameters in the body": { + "$ref": "./examples/PostSnapToRoads.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/Accept-Language" + }, + { + "name": "snapToRoadsRequest", + "in": "body", + "description": "Request body of SnapToRoads API in GeoJSON format.", + "required": true, + "schema": { + "$ref": "#/definitions/SnapToRoadsRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapToRoadsResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/snapToRoads:batch": { + "post": { + "description": "**SnapToRoads Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Snap To Roads Batch API sends batches of up to **100** queries as a single call to the [Snap To Roads API](https://learn.microsoft.com/en-us/rest/api/maps/route/post-snap-to-roads?view=rest-maps-2024-06-01-preview).\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/snapToRoads:batch?api-version=2024-06-01-preview\n```\n### POST Body for Batch Request\nTo send the _snap to roads_ 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 2 _snap to roads_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.122353,\n 47.672662\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.132452,\n 47.644234\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \n }\n }\n ],\n \"interpolate\": true,\n \"includeSpeedLimit\": true,\n \"travelMode\": \"driving\"\n },\n {\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.33669,\n 47.590849\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 0\n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n 122.34509,\n 47.610524\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 1\n }\n }\n ],\n \"interpolate\": false,\n \"includeSpeedLimit\": false,\n \"travelMode\": \"driving\"\n }\n ]\n}\n```\n\nA _snap to roads_ batchItem object can accept any of the supported _snap to roads_ [Request body](/rest/api/maps/route/post-snap-to-roads?view=rest-maps-2024-06-01-preview#request-body) \n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe 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 is of one of the following types:\n\n - [`SnapToRoadsResponse`](/rest/api/maps/route/post-snap-to-roads#response) - 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\n", + "operationId": "Route_PostSnapToRoadsBatch", + "consumes": [ + "application/geo+json" + ], + "produces": [ + "application/json" + ], + "x-ms-client-name": "Route_PostSnapToRoadsBatch", + "x-ms-examples": { + "A Snap To Roads Batch request containing 1 query": { + "$ref": "./examples/PostSnapToRoadsBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "snapToRoadsBatchRequest", + "in": "body", + "description": "The list of Snap To Roads queries/requests to process. The list can contain a max of 100 queries for sync version and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "#/definitions/SnapToRoadsBatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "Batch request successfully processed. The response body contains all the batch results.", + "schema": { + "$ref": "#/definitions/SnapToRoadsBatchResponse" + } + }, + "207": { + "description": "Multi-Status. One or more batch items could not be processed and return different status code.", + "schema": { + "$ref": "#/definitions/SnapToRoadsBatchResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/range": { + "post": { + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis service will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point.\n\nThe returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone.\n\n\n\nFor information about routing availability in countries/regions, see [Azure Maps routing coverage](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n\n", + "operationId": "Route_PostRouteRange", + "consumes": [ + "application/geo+json" + ], + "produces": [ + "application/geo+json", + "application/json" + ], + "x-ms-client-name": "Route_PostRouteRange", + "x-ms-examples": { + "Successfully retrieve a snap to roads points with additional parameters in the body": { + "$ref": "./examples/PostRouteRange.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/Accept-Language" + }, + { + "name": "routeRangeRequest", + "in": "body", + "description": "Request body of RouteRange API in GeoJSON format.", + "required": true, + "schema": { + "$ref": "#/definitions/RouteRangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteRangeResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/range:batch": { + "post": { + "description": "**Route Range Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Route Range Batch API sends batches of up to **100** queries as a single call to the [Route Range API](https://learn.microsoft.com/en-us/rest/api/maps/route/post-route-range?view=rest-maps-2024-06-01-preview).\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/range:batch?api-version=2024-06-01-preview\n```\n### POST Body for Batch Request\nTo send the _route range_ 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 2 _route_range_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 5.86605,\n 50.9745\n ]\n },\n \"properties\": {\n \"timeBudgetInSec\": 6000\n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -122.201669,\n 47.615076\n ]\n },\n \"properties\": {\n \"timeBudgetInSec\": 2000\n }\n }\n ]\n}\n```\n\nA _route range_ batchItem object can accept any of the supported _snap to roads_ [Request body](/rest/api/maps/route/post-snap-to-roads?view=rest-maps-2024-06-01-preview#request-body) \n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe 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 is of one of the following types:\n\n - [`RouteRangeResponse`](/rest/api/maps/route/post-route-range#response) - 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\n", + "operationId": "Route_PostRouteRangeBatch", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-client-name": "Route_PostRouteRangeBatch", + "x-ms-examples": { + "A Route Range Batch request containing 1 query": { + "$ref": "./examples/PostRouteRangeBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "routeRangeBatchRequest", + "in": "body", + "description": "The list of route directions queries/requests to process. The list can contain a max of 100 queries for sync version and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "#/definitions/RouteRangeBatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "Batch request successfully processed. The response body contains all the batch results.", + "schema": { + "$ref": "#/definitions/RouteRangeBatchResponse" + } + }, + "207": { + "description": "Multi-Status. One or more batch items could not be processed and return different status code.", + "schema": { + "$ref": "#/definitions/RouteRangeBatchResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/matrix": { + "post": { + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\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 a sync request. 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 sync request it's **2500** (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 2500, you might want to make synchronous request. The maximum size of a matrix for this API is **2500** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x50, 60x40, 90x20 (it does not need to be square).", + "operationId": "Route_PostRouteMatrix", + "consumes": [ + "application/geo+json" + ], + "produces": [ + "application/geo+json" + ], + "x-ms-client-name": "Route_PostRouteMatrix", + "x-ms-examples": { + "Successfully retrieve a route matrix with additional parameters in the body": { + "$ref": "./examples/PostRouteMatrix.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "name": "routeMatrixRequest", + "in": "body", + "description": "Request body of RouteMatrix API in GeoJSON format.", + "required": true, + "schema": { + "$ref": "#/definitions/RouteMatrixRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteMatrixResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/matrix:async": { + "post": { + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\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. 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 **50000** and for sync request it's **2500** (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 2500, you might want to make synchronous request. The maximum size of a matrix for this API is **2500** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x50, 60x40, 90x20 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix?api-version=2024-06-01-preview&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 URL in the Operation-Location field of the response header with the Azure Maps geography endpoint `{geography}.atlas.microsoft.com. This URL should be checked periodically until the status is Succeeded. \n\n\nThe maximum size of a matrix for this API is **50000** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 500x100, 100x100, 280x170. 100x50 (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:async?api-version=2024-06-01-preview&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 get the status of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/operations/{id}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the resultUrl obtained in Step 3 to get the results\n\n \n\n ```\n GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n\n", + "operationId": "Route_PostRouteMatrixAsync", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location", + "final-state-schema": "#/definitions/RouteOperation" + }, + "consumes": [ + "application/geo+json" + ], + "produces": [ + "application/json" + ], + "x-ms-client-name": "Route_PostRouteMatrixAsync", + "x-ms-examples": { + "Submit an asynchronous request for matrix": { + "$ref": "./examples/PostRouteMatrixAsync.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "name": "routeMatrixAsyncRequest", + "in": "body", + "description": "Request body of RouteMatrix API in GeoJSON format.", + "required": true, + "schema": { + "$ref": "#/definitions/RouteMatrixAsyncRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Operation-Location": { + "description": "URL to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/operations/{id}": { + "get": { + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n Get the status of an asynchronous operation by its operation ID.", + "operationId": "Route_GetRouteOperationsStatus", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a succeeded operation status": { + "$ref": "./examples/GetRouteOperationStatusSucceeded.json" + }, + "Get a running operation status": { + "$ref": "./examples/GetRouteOperationStatusRunning.json" + }, + "Get a failed operation status": { + "$ref": "./examples/GetRouteOperationStatusFailed.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/OperationId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteOperation" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/operations/{id}/result": { + "get": { + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet the result of an asynchronous operation by its operation ID.", + "operationId": "Route_GetRouteOperationResult", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-client-name": "Route_GetOperationResult", + "x-ms-examples": { + "Successfully retrieve the async matrix result": { + "$ref": "./examples/GetRouteMatrixAsyncResult.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/Accept-Language" + }, + { + "$ref": "#/parameters/OperationId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteOperationResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + } + }, + "definitions": { + "DirectionsRequest": { + "description": "This object is the request body.", + "type": "object", + "required": [ + "type", + "features" + ], + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "Driving and walking routes are defined by a set of waypoints(stops) and viaWaypoints (intermediate locations that the route must pass through). You can have a maximum of 25 waypoints, and a maximum of 10 viaWaypoints between each set of waypoints. Truck route supports up to 150 waypoints and viaWaypoints are not supported.\n\nA route must have a minimum of 2 waypoints and the start and end points of the route cannot be viaWaypoints.\n\nBoth waypoint and viaWaypoint locations must be specified as a valid GeoJSON Point feature object along with pointIndex that specifies the order of the locations. For more information on the GeoJSON format, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "minimum": 2, + "items": { + "$ref": "#/definitions/InputWaypointFeaturesItem" + } + }, + "travelMode": { + "$ref": "#/definitions/TravelModeEnum" + }, + "departAt": { + "description": "The date and time of departure from the origin point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `departAt` value must be in the future in the date-time format or now value to set it to the current time.\n\nExamples:\n\n\"departAt\": \"2023-06-01T09:30:00.000-07:00\"", + "type": "string", + "format": "date-time" + }, + "arriveAt": { + "description": "The date and time of arrival at the destination point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `arriveAt` value must be in the future. The `arriveAt` parameter cannot be used in conjunction with `departAt`.\n\nExample: \"arriveAt\": \"2023-06-01T09:30:00.000-07:00\"", + "type": "string", + "format": "date-time" + }, + "optimizeRoute": { + "description": "Specifies the parameter to use to optimize the route. If not defined, the default is \"fastestWithoutTraffic\" which returns the route to minimize the travel time without using current traffic information.\n\nExample: \"optimizeRoute\":\"shortest\"", + "type": "string", + "default": "fastestWithoutTraffic", + "enum": [ + "shortest", + "fastestWithoutTraffic", + "fastestAvoidClosureWithoutTraffic", + "fastestWithTraffic" + ], + "x-ms-enum": { + "name": "RouteDirectionOptimizeRouteEnum", + "modelAsString": true, + "values": [ + { + "value": "shortest", + "name": "Shortest", + "description": "The route is calculated to minimize the distance. Traffic information is not used." + }, + { + "value": "fastestWithoutTraffic", + "name": "FastestWithoutTraffic", + "description": "Finds the fastest route, without factoring in traffic information." + }, + { + "value": "fastestAvoidClosureWithoutTraffic", + "name": "FastestAvoidClosureWithoutTraffic", + "description": "The route is calculated to minimize the time and avoid road closures. No traffic information except for road closures is used in the calculation. `Note`: Only supported for driving travelMode." + }, + { + "value": "fastestWithTraffic", + "name": "FastestWithTraffic", + "description": "The route is calculated to minimize the time using current traffic information. `Note`: Only supported for driving and truck travelMode." + } + ] + } + }, + "optimizeWaypointOrder": { + "description": "Re-order the route waypoints using a fast heuristic algorithm to reduce the route cost specified with the optimize parameter. The origin and destination are excluded from the optimized waypoint and their position is considered fixed. Acceptable values are true or false.\n\n`Note`: Only supported for truck travelMode.", + "type": "boolean", + "default": false + }, + "avoid": { + "$ref": "#/definitions/AvoidEnum" + }, + "routeOutputOptions": { + "description": "Include the desired route information from the response. By default, the itinerary is included in the response.\n\nSupports multiple values such as \"routeOutputOptions\": [\"routePath\", \"regionTravelSummary\"]", + "type": "array", + "default": [ + "itinerary" + ], + "items": { + "type": "string", + "enum": [ + "routeSummary", + "regionTravelSummary", + "routePath", + "itinerary" + ], + "x-ms-enum": { + "name": "RouteOutputOptionEnum", + "modelAsString": true, + "values": [ + { + "value": "routeSummary", + "description": "Include only travel time and distance for the route, and do not provide other information." + }, + { + "value": "regionTravelSummary", + "description": "Include travel summary of distance, time, and toll road distance by two entity types: country (e.g., US, Canada) and administrative division or subregion (e.g., \"state\" in US and \"province\" in Canada). `Note`: Only supported for driving and walking travelMode" + }, + { + "value": "routePath", + "description": "Include a GeoJSON MultiLineString [RFC 7946, section 3.1.5](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.5) that describe the route's path in the response." + }, + { + "value": "itinerary", + "description": "Include detailed directions in the response. Detailed directions are provided as \"ManeuverPoints\" and contain details such as turn-by-turn instructions." + } + ] + } + } + }, + "maxRouteCount": { + "description": "The maximum number of routes to return. Available for the driving and truck travel modes.\n\nFor driving routes, this parameter supports routes with up to two waypoints in addition to the origin and destination and avoid parameter must not be set.\n\nDefault: \"maxRouteCount\":1\n\nMinimum: \"maxRouteCount\":1\n\nMaximum: \"maxRouteCount\":3", + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 3 + }, + "heading": { + "description": "The initial directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359", + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 359 + }, + "vehicleSpec": { + "description": "Specifies the vehicle attributes such as size, weight, max speed, type of cargo for truck routing only. This helps avoid low bridge clearances, road restrictions, difficult right turns to provide the optimized truck route based on the vehicle specifications.\n\n`Note`: Only supported for truck travelMode", + "$ref": "#/definitions/VehicleSpec" + } + } + }, + "RouteDirectionsResponse": { + "description": "This object is returned from a successful call.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureCollection" + }, + { + "type": "object", + "description": "Alternative route.", + "properties": { + "alternativeRoutes": { + "description": "Alternative route.", + "type": "array", + "items": { + "$ref": "#/definitions/FeatureCollection" + } + } + } + } + ] + }, + "SnapToRoadsRequest": { + "description": "This object is the request body.", + "type": "object", + "required": [ + "type", + "features" + ], + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "A set of points to snap to roads. You can have a maximum of 100 points. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details on the GeoJSON format.", + "minimum": 2, + "maximum": 100, + "items": { + "$ref": "#/definitions/InputSnapToRoadsFeaturesItem" + } + }, + "interpolate": { + "description": "Specify whether to insert additional points between the snapped points to complete the full route path", + "type": "boolean", + "default": false + }, + "includeSpeedLimit": { + "description": "Specify whether to include speed limit information for the snapped points. The unit is in kilometers per hour. `Note`: Only supported for driving travelMode", + "type": "boolean", + "default": false + }, + "travelMode": { + "description": "Specify the travel mode for snapping the coordinates. If unspecified, the default mode is \"driving\", which optimizes the snapped coordinates for driving routes.", + "type": "string", + "default": "driving", + "enum": [ + "driving", + "walking" + ], + "x-ms-enum": { + "name": "SnapToRoadsTravelModeEnum", + "modelAsString": true, + "values": [ + { + "value": "driving", + "description": "driving" + }, + { + "value": "walking", + "description": "walking." + } + ] + } + } + } + }, + "SnapToRoadsResponse": { + "description": "This object is returned from a successful call.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "`GeoJSON` feature object that contains Geometry object and additional properties. Refer to [RFC 7946, Section 3.2](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) for details.", + "items": { + "$ref": "#/definitions/SnapToRoadFeaturesItem" + } + } + } + }, + "RouteRangeRequest": { + "type": "object", + "description": "Specifies the starting point for range calculation. `GeoJSON` feature object and additional properties. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "required": [ + "type", + "geometry", + "properties" + ], + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonPoint" + }, + "properties": { + "$ref": "#/definitions/InputRouteRangeProperties" + } + } + }, + "RouteRangeResponse": { + "description": "This object is returned from a successful call.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "`GeoJSON` feature object that contains Geometry object and additional properties. Refer to [RFC 7946, Section 3.2](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) for details.", + "items": { + "$ref": "#/definitions/RouteRangeFeaturesItem" + } + } + } + }, + "RouteMatrixRequest": { + "description": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destination. `GeoJSON` feature object and additional properties. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "type": "object", + "required": [ + "type", + "features" + ], + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "A set of MultiPoint for matrix. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details on the GeoJSON format.", + "minimum": 2, + "maximum": 2, + "items": { + "$ref": "#/definitions/InputRouteMatrixFeaturesItem" + } + }, + "departAt": { + "description": "The date and time of departure from the origin point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `departAt` value must be in the future in the date-time format or now value to set it to the current time.\n\nExamples:\n\n\"departAt\": \"2023-06-01T09:30:00.000-07:00\"", + "type": "string", + "format": "date-time" + }, + "arriveAt": { + "description": "The date and time of arrival at the destination point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `arriveAt` value must be in the future. The `arriveAt` parameter cannot be used in conjunction with `departAt`.\n\nExample: \"arriveAt\": \"2023-06-01T09:30:00.000-07:00\"", + "type": "string", + "format": "date-time" + }, + "travelMode": { + "$ref": "#/definitions/TravelModeEnum" + }, + "optimizeRoute": { + "description": "Specifies the parameter to use to optimize the route. If not defined, the default is \"fastest\" which returns the route to minimize the travel time.\n\nExample: \"optimizeRoute\":\"fastest \"", + "type": "string", + "default": "fastest", + "enum": [ + "fastest" + ], + "x-ms-enum": { + "name": "RouteMatrixOptimizeRouteEnum", + "modelAsString": true, + "values": [ + { + "value": "fastest", + "name": "Fastest", + "description": "Finds the fastest route" + } + ] + } + }, + "traffic": { + "$ref": "#/definitions/RouteMatrixTrafficEnum" + }, + "avoid": { + "description": "Specifies something that the route calculation should try to avoid when determining the route.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteMatrixAvoidEnum" + } + }, + "vehicleSpec": { + "$ref": "#/definitions/RouteMatrixVehicleSpec" + } + } + }, + "RouteMatrixAsyncRequest": { + "description": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destination. `GeoJSON` feature object and additional properties. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "type": "object", + "required": [ + "type", + "features" + ], + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "A set of MultiPoint for matrix. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details on the GeoJSON format.", + "minimum": 2, + "maximum": 2, + "items": { + "$ref": "#/definitions/InputRouteMatrixFeaturesItem" + } + }, + "departAt": { + "description": "The date and time of departure from the origin point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `departAt` value must be in the future in the date-time format or now value to set it to the current time.\n\nExamples:\n\n\"departAt\": \"2023-06-01T09:30:00.000-07:00\"", + "type": "string", + "format": "date-time" + }, + "arriveAt": { + "description": "The date and time of arrival at the destination point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `arriveAt` value must be in the future. The `arriveAt` parameter cannot be used in conjunction with `departAt`.\n\nExample: \"arriveAt\": \"2023-06-01T09:30:00.000-07:00\"", + "type": "string", + "format": "date-time" + }, + "travelMode": { + "$ref": "#/definitions/TravelModeEnum" + }, + "optimizeRoute": { + "description": "Specifies the parameter to use to optimize the route. If not defined, the default is \"fastest\" which returns the route to minimize the travel time.\n\nExample: \"optimizeRoute\":\"shortest\"", + "type": "string", + "default": "fastest", + "enum": [ + "shortest", + "fastest" + ], + "x-ms-enum": { + "name": "RouteMatrixAsyncOptimizeRouteEnum", + "modelAsString": true, + "values": [ + { + "value": "shortest", + "name": "Shortest", + "description": "The route is calculated to minimize the distance." + }, + { + "value": "fastest", + "name": "Fastest", + "description": "Finds the fastest route" + } + ] + } + }, + "traffic": { + "$ref": "#/definitions/RouteMatrixTrafficEnum" + }, + "avoid": { + "description": "Specifies something that the route calculation should try to avoid when determining the route.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteMatrixAvoidEnum" + } + }, + "vehicleSpec": { + "$ref": "#/definitions/RouteMatrixVehicleSpec" + } + } + }, + "RouteMatrixResponse": { + "description": "This object is returned from a successful call.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "`GeoJSON` feature object that contains Geometry object and additional properties. Refer to [RFC 7946, Section 3.2](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) for details.", + "items": { + "$ref": "#/definitions/RouteMatrixFeatureItem" + } + }, + "summary": { + "$ref": "#/definitions/RouteMatrixSummary" + } + } + }, + "RouteOperationResponse": { + "type": "object", + "description": "This object is returned from a successful call.", + "properties": { + "kind": { + "$ref": "#/definitions/RouteOperationKindEnum" + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "RouteMatrixAsyncResponse": { + "type": "object", + "x-ms-discriminator-value": "RouteMatrix", + "description": "Specifies the driving instructions and additional properties for each maneuver point in the route Leg.", + "allOf": [ + { + "$ref": "#/definitions/RouteOperationResponse" + }, + { + "$ref": "#/definitions/RouteMatrixResponse" + } + ] + }, + "FeatureCollection": { + "description": "`GeoJSON` `FeatureCollection` object that contains a list of Features. For more information, see [RFC 7946, section 3.3](https://www.rfc-editor.org/rfc/rfc7946#section-3.3).", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "$ref": "#/definitions/Features" + } + } + }, + "RegionTravelSummary": { + "description": "Travel summary of distance, time, and toll road distance by two entity types: country (e.g. US, Canada) and administrative division or subregion (e.g. “state” in US and “province” in Canada).", + "type": "object", + "properties": { + "countryRegion": { + "description": "Country region name.", + "type": "string", + "readOnly": true + }, + "adminDistricts": { + "description": "adminDistrict array.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AdminDistrict" + } + }, + "distanceInMeters": { + "description": "Length In Meters property", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "Estimated travel time in seconds that does not include delays on the route due to traffic conditions.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "durationTrafficInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.", + "format": "int64", + "type": "integer", + "readOnly": true + } + } + }, + "FeatureTypeEnum": { + "type": "string", + "description": "Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "enum": [ + "FeatureCollection" + ], + "x-ms-enum": { + "name": "FeatureTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "FeatureCollection", + "description": "Specifies the `GeoJSON` `FeatureCollection` object type." + } + ] + } + }, + "FeaturesItemTypeEnum": { + "type": "string", + "description": "Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "enum": [ + "Feature" + ], + "x-ms-enum": { + "name": "FeaturesItemTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "Feature", + "description": "Specifies the `GeoJSON` Feature object type." + } + ] + } + }, + "Bbox": { + "description": "A rectangular area on the earth defined as a bounding box object. The sides of the rectangles are defined by latitude and longitude values. For more information, see [RFC 7946, Section 5](https://www.rfc-editor.org/rfc/rfc7946#section-5).\n\nExample: \"bbox\": [-10.0, -10.0, 10.0, 10.0]", + "type": "array", + "items": { + "type": "number", + "format": "double" + }, + "minItems": 4, + "maxItems": 4 + }, + "Features": { + "type": "array", + "description": "`GeoJSON` feature object that contains Geometry object and additional properties. For more information, see [RFC 7946, Section 3.2](https://www.rfc-editor.org/rfc/rfc7946#section-3.2).", + "items": { + "$ref": "#/definitions/FeaturesItem" + } + }, + "FeaturesItem": { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "allOf": [ + { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "#/definitions/Geometry" + }, + "properties": { + "$ref": "#/definitions/FeatureProperties" + }, + "bbox": { + "$ref": "#/definitions/Bbox" + } + } + } + ] + }, + "Geometry": { + "type": "object", + "description": "A valid `GeoJSON` Geometry object. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "properties": { + "type": { + "description": "Specifies the geometry type for the 'GeoJSON` Geometry object. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "type": "string" + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "RouteRangeGeometry": { + "type": "object", + "description": "A valid `GeoJSON` Geometry object. Please refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "properties": { + "type": { + "description": "Specifies the geometry type for the 'GeoJSON` Geometry object. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "type": "string" + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "PointGeometry": { + "type": "object", + "description": "Specifies the `GeoJSON` Point Geometry object. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "x-ms-discriminator-value": "Point", + "allOf": [ + { + "$ref": "#/definitions/Geometry" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonPoint" + } + ] + }, + "MultiLineStringGeometry": { + "type": "object", + "description": "Specifies the `GeoJSON` MultiLineString Geometry object. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "x-ms-discriminator-value": "MultiLineString", + "allOf": [ + { + "$ref": "#/definitions/Geometry" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonMultiLineString" + } + ] + }, + "RouteRangePolygonGeometry": { + "type": "object", + "description": "Specifies the `GeoJSON` Polygon Geometry object. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "x-ms-discriminator-value": "Polygon", + "allOf": [ + { + "$ref": "#/definitions/RouteRangeGeometry" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonPolygon" + } + ] + }, + "RouteRangePointGeometry": { + "type": "object", + "description": "Specifies the `GeoJSON` Point Geometry object. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "x-ms-discriminator-value": "Point", + "allOf": [ + { + "$ref": "#/definitions/RouteRangeGeometry" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonPointData" + } + ] + }, + "InputWaypointFeaturesItem": { + "type": "object", + "description": "Specifies the input waypoint and viaWaypoint `GeoJSON` feature object and additional properties. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonPoint" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InputWaypointProperties" + } + }, + "required": [ + "type", + "geometry", + "properties" + ] + }, + "InputWaypointProperties": { + "type": "object", + "description": "Specifies the properties of a Waypoint which is a specific location or point along a route or trip that serves as a reference or stopping point.", + "properties": { + "pointIndex": { + "description": "Identify and order the sequence of waypoints in the route. The default value is the `index value` of a features array.", + "format": "int64", + "type": "integer" + }, + "pointType": { + "$ref": "#/definitions/InputWaypointTypeEnum" + } + } + }, + "WaypointProperties": { + "x-ms-discriminator-value": "Waypoint", + "type": "object", + "description": "Specifies the properties of a Waypoint which is a specific location or point along a route or trip that serves as a reference or stopping point.", + "allOf": [ + { + "$ref": "#/definitions/FeatureProperties" + }, + { + "$ref": "#/definitions/NavigationPointProperties" + } + ] + }, + "ManeuverPointProperties": { + "x-ms-discriminator-value": "ManeuverPoint", + "type": "object", + "description": "Specifies the driving instructions and additional properties for each maneuver point in the route Leg.", + "allOf": [ + { + "$ref": "#/definitions/FeatureProperties" + }, + { + "$ref": "#/definitions/NavigationPointProperties" + } + ] + }, + "NavigationPointProperties": { + "description": "Waypoint and ManeuverPoint properties.", + "type": "object", + "properties": { + "routePathPoint": { + "$ref": "#/definitions/RoutePathPoint" + }, + "order": { + "$ref": "#/definitions/Order" + }, + "compassDirection": { + "description": "The direction of travel associated with a maneuver on a route, such as south or southwest. `Note`: Only supported for driving travelMode.", + "type": "string", + "readOnly": true + }, + "steps": { + "description": "Steps between two consecutive maneuver points.", + "type": "array", + "items": { + "$ref": "#/definitions/Step" + } + }, + "instruction": { + "$ref": "#/definitions/Instruction" + }, + "sideOfStreet": { + "$ref": "#/definitions/SideOfStreetEnum" + }, + "signs": { + "description": "Signage text for the route. There may be more than one sign value.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "towardsRoadName": { + "description": "The name of the street that the route goes towards in the first `ManeuverPoint`.", + "type": "string", + "readOnly": true + }, + "exitIdentifier": { + "description": "The name or number of the exit associated with this route step.", + "type": "string", + "readOnly": true + }, + "distanceInMeters": { + "description": "The physical distance in meters covered by this route step.", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance`.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "travelMode": { + "$ref": "#/definitions/RoutePathTravelModeEnum" + } + } + }, + "ViaWaypointProperties": { + "x-ms-discriminator-value": "ViaWaypoint", + "type": "object", + "description": "Specifies the properties of a `ViaWaypoint` which is a waypoint that must be passed through or visited along a route or trip.", + "allOf": [ + { + "$ref": "#/definitions/FeatureProperties" + }, + { + "description": "Specifies the properties of a ViaWaypoint which is a waypoint that must be passed through or visited along a route or trip.", + "type": "object", + "properties": { + "names": { + "description": "A street, highway or intersection where the maneuver occurs. If the maneuver is complex, there may be more than one name field in the details collection. The name field may also have no value. This can occur if the name is not known or if a street, highway or intersection does not have a name.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "routePathPoint": { + "$ref": "#/definitions/RoutePathPoint" + }, + "order": { + "$ref": "#/definitions/Order" + } + } + } + ] + }, + "RoutePathProperties": { + "x-ms-discriminator-value": "RoutePath", + "type": "object", + "description": "Specifies the properties that describe the route's path in the response.", + "allOf": [ + { + "$ref": "#/definitions/FeatureProperties" + }, + { + "type": "object", + "description": "Specifies the properties that describe the route's path in the response.", + "properties": { + "resourceId": { + "description": "A unique ID for the resource.", + "type": "string", + "readOnly": true + }, + "distanceInMeters": { + "description": "The physical distance in meters covered by the entire route.", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "Estimated travel time in seconds that does not include delays on the route due to traffic conditions.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "durationTrafficInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "trafficDataUsed": { + "$ref": "#/definitions/TrafficDataUsedEnum" + }, + "trafficCongestion": { + "$ref": "#/definitions/TrafficCongestionEnum" + }, + "departureTime": { + "type": "string", + "description": "The estimated departure time for the leg, which takes into account the traffic conditions, is formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.", + "format": "date-time", + "readOnly": true + }, + "arrivalTime": { + "type": "string", + "description": "The estimated arrival time for the leg, which takes into account the traffic conditions, is formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.", + "format": "date-time", + "readOnly": true + }, + "legs": { + "description": "An array of route Legs. Check route Leg object description for more information.", + "type": "array", + "items": { + "$ref": "#/definitions/Leg" + } + } + } + } + ] + }, + "FeatureProperties": { + "type": "object", + "description": "Specifies the feature properties of the route like itinerary, route Legs and geometry, travel summary.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturePropertiesTypeEnum" + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "FeaturePropertiesTypeEnum": { + "description": "Output type.", + "type": "string", + "readOnly": true, + "enum": [ + "ManeuverPoint", + "Waypoint", + "ViaWaypoint", + "RoutePath" + ], + "x-ms-enum": { + "name": "PropertiesTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "ManeuverPoint", + "description": "A maneuverPoint is a specific point on a route or trip where a change in direction or mode of transportation is required or recommended." + }, + { + "value": "Waypoint", + "description": "A waypoint is a specific location or point along a route or trip that serves as a reference or stopping point." + }, + { + "value": "ViaWaypoint", + "description": "A viaWaypoint is specific waypoint that must be passed through or visited along a route or trip." + }, + { + "value": "RoutePath", + "description": "A routePath is a line that represents the path of a route or trip." + } + ] + } + }, + "InputWaypointTypeEnum": { + "description": "Waypoint type on the route. It can be a stop or an intermediate location that the route must pass through.", + "type": "string", + "default": "waypoint", + "enum": [ + "waypoint", + "viaWaypoint" + ], + "x-ms-enum": { + "name": "InputWaypointTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "waypoint", + "description": "A waypoint is a specific location or point along a route or trip that serves as a reference or stopping point." + }, + { + "value": "viaWaypoint", + "description": "A viaWaypoint is a specific waypoint that must be passed through or visited along a route or trip. `Note`: Only supported for driving travelMode." + } + ] + } + }, + "AdminDistrict": { + "description": "The subdivision name in the country or region for an address. This element is typically treated as the first order administrative subdivision, but in some cases it also contains the second, third, or fourth order subdivision in a country, dependency, or region.", + "type": "object", + "properties": { + "longName": { + "description": "The long name of an address, such as Washington.", + "type": "string", + "readOnly": true + }, + "distanceInMeters": { + "description": "The total distance traveled in meters within the administrative district.", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "Estimated travel time in seconds that does not include delays on the route due to traffic conditions.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "durationTrafficInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.", + "format": "int64", + "type": "integer", + "readOnly": true + } + } + }, + "Leg": { + "x-ms-client-name": "RouteLeg", + "description": "Information about a section of a route between two waypoints. More information about the fields contained in a route Leg:", + "type": "object", + "properties": { + "description": { + "description": "A short description of the route.", + "type": "string", + "readOnly": true + }, + "routePathRange": { + "$ref": "#/definitions/RoutePathRange" + }, + "distanceInMeters": { + "description": "The physical distance in meters covered by a route Leg.", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "Estimated travel time in seconds that does not include delays on the route due to traffic conditions.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "durationTrafficInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "departureTime": { + "description": "The estimated departure time for the leg, which takes into account the traffic conditions, is formatted as a dateTime value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "arrivalTime": { + "description": "The estimated arrival time for the leg, which takes into account the traffic conditions, is formatted as a dateTime value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "subLegs": { + "description": "Information about a segments of the route Leg defined by the route Leg waypoints and any intermediate via-waypoints. For example, if the route Leg has two via-waypoints in addition to start and end waypoints, there would be three (3) route sub-legs.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SubLeg" + } + }, + "regionTravelSummary": { + "description": "Include travel summary of distance, time, and toll road distance by two entity types: country (e.g. US, Canada) and administrative division or subregion (e.g. “state” in US and “province” in Canada).", + "$ref": "#/definitions/RegionTravelSummary" + } + } + }, + "SubLeg": { + "x-ms-client-name": "RouteSubLeg", + "description": "Information about a segments of the route Leg defined by the route Leg waypoints and any intermediate via-waypoints. For example, if the route Leg has two via-waypoints in addition to start and end waypoints, there would be three (3) route sub-legs.", + "type": "object", + "properties": { + "routePathRange": { + "$ref": "#/definitions/RoutePathRange" + }, + "distanceInMeters": { + "description": "The physical distance in meters covered by the sub-leg.", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "Estimated travel time in seconds that does not include delays on the route due to traffic conditions.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "durationTrafficInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.", + "format": "int64", + "type": "integer", + "readOnly": true + } + } + }, + "RoutePathRange": { + "description": "Refers to the range covered by a specific Leg of a route or path.", + "type": "object", + "properties": { + "range": { + "description": "Refers to the range covered by a specific Leg of a route or path.", + "type": "array", + "readOnly": true, + "maximum": 2, + "maxItems": 2, + "items": { + "format": "int64", + "type": "integer" + } + }, + "legIndex": { + "$ref": "#/definitions/LegIndex" + } + } + }, + "RoutePathPoint": { + "description": "Refers to the index of a point within a specific Leg of a route.", + "type": "object", + "properties": { + "legIndex": { + "$ref": "#/definitions/LegIndex" + }, + "pointIndex": { + "description": "Index of a point within a specific Leg.", + "format": "int64", + "type": "integer", + "readOnly": true + } + } + }, + "LegIndex": { + "description": "The route Leg index is a sequential number assigned to each Leg of the route to help identify and distinguish between different segments of the route.", + "readOnly": true, + "format": "int64", + "type": "integer" + }, + "Hint": { + "description": "Additional information that may be helpful in following a route. In addition to the hint text, this element has an attribute hintType that specifies what the hint refers to, such as “NextIntersection.” Hint is an optional element. `Note`: Only supported for driving travelMode.", + "type": "object", + "properties": { + "hintType": { + "description": "hint type.", + "type": "string", + "readOnly": true + }, + "text": { + "description": "hint text.", + "type": "string", + "readOnly": true + } + } + }, + "Step": { + "x-ms-client-name": "RouteStep", + "description": "A route Leg contain turn-by-turn instructions. A step refers to a range of a route between two consecutive maneuverPoint.", + "type": "object", + "properties": { + "compassDegrees": { + "description": "The direction in degrees. `Note`: Only supported for driving travelMode.", + "readOnly": true, + "type": "number" + }, + "maneuverType": { + "readOnly": true, + "$ref": "#/definitions/ManeuverTypeEnum" + }, + "names": { + "description": "A street, highway or intersection where the maneuver occurs. If the maneuver is complex, there may be more than one name field in the details collection. The name field may also have no value. This can occur if the name is not known or if a street, highway or intersection does not have a name.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "routePathRange": { + "$ref": "#/definitions/RoutePathRange" + }, + "roadType": { + "readOnly": true, + "$ref": "#/definitions/RoadTypeEnum" + } + } + }, + "ManeuverTypeEnum": { + "description": "The type of maneuver described by this detail collection. The ManeuverType in A detail collection can provide information for a portion of the maneuver described by the maneuverType attribute of the corresponding Instruction. For example the maneuverType attribute of an Instruction may specify TurnLeftThenTurnRight as the maneuver while the associated detail items may specify specifics about the TurnLeft and TurnRight maneuvers.", + "type": "string", + "readOnly": true, + "enum": [ + "ArriveFinish", + "ArriveIntermediate", + "BearLeft", + "BearLeftThenBearLeft", + "BearLeftThenBearRight", + "BearLeftThenTurnLeft", + "BearLeftThenTurnRight", + "BearRight", + "BearRightThenBearLeft", + "BearRightThenBearRight", + "BearRightThenTurnLeft", + "BearRightThenTurnRight", + "BearThenKeep", + "BearThenMerge", + "Continue", + "DepartIntermediateStop", + "DepartIntermediateStopReturning", + "DepartStart", + "EnterRoundabout", + "ExitRoundabout", + "EnterThenExitRoundabout", + "ExitRoundaboutRight", + "ExitRoundaboutLeft", + "Follow", + "GoAroundRoundabout", + "KeepLeft", + "KeepOnRampLeft", + "KeepOnRampRight", + "KeepOnRampStraight", + "KeepRight", + "KeepStraight", + "KeepToStayLeft", + "KeepToStayRight", + "KeepToStayStraight", + "MergeFreeway", + "MergeHighway", + "MergeMotorway", + "MotorwayExitLeft", + "MotorwayExitRight", + "None", + "RampThenHighwayLeft", + "RampThenHighwayRight", + "RampThenHighwayStraight", + "RoadNameChange", + "SwitchToParallelRoad", + "SwitchToMainRoad", + "Take", + "TakeFerry", + "TakeExit", + "TakeRamp", + "TakeRampLeft", + "TakeRampRight", + "TakeRampStraight", + "TurnBack", + "TurnLeft", + "TurnLeftSharp", + "TurnLeftThenBearLeft", + "TurnLeftThenBearRight", + "TurnLeftThenTurnLeft", + "TurnLeftThenTurnRight", + "TurnRight", + "TurnRightSharp", + "TurnRightThenBearLeft", + "TurnRightThenBearRight", + "TurnRightThenTurnLeft", + "TurnRightThenTurnRight", + "TurnThenMerge", + "TurnToStayLeft", + "TurnToStayRight", + "Unknown", + "UTurn", + "Wait", + "Walk" + ], + "x-ms-enum": { + "name": "ManeuverTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "ArriveFinish", + "name": "ArriveFinish", + "description": "Arrive at the final destination." + }, + { + "value": "ArriveIntermediate", + "name": "ArriveIntermediate", + "description": "Arrive at an intermediate waypoint." + }, + { + "value": "BearLeft", + "name": "BearLeft", + "description": "Bear left." + }, + { + "value": "BearLeftThenBearLeft", + "name": "BearLeftThenBearLeft", + "description": "Bear left and then bear left again." + }, + { + "value": "BearLeftThenBearRight", + "name": "BearLeftThenBearRight", + "description": "Bear left and then bear right." + }, + { + "value": "BearLeftThenTurnLeft", + "name": "BearLeftThenTurnLeft", + "description": "Bear left and then turn left." + }, + { + "value": "BearLeftThenTurnRight", + "name": "BearLeftThenTurnRight", + "description": "Bear left and then turn right." + }, + { + "value": "BearRight", + "name": "BearRight", + "description": "Bear right." + }, + { + "value": "BearRightThenBearLeft", + "name": "BearRightThenBearLeft", + "description": "Bear right and then bear left." + }, + { + "value": "BearRightThenBearRight", + "name": "BearRightThenBearRight", + "description": "Bear right and then bear right again." + }, + { + "value": "BearRightThenTurnLeft", + "name": "BearRightThenTurnLeft", + "description": "Bear right and then turn left." + }, + { + "value": "BearRightThenTurnRight", + "name": "BearRightThenTurnRight", + "description": "Bear right and then turn right." + }, + { + "value": "BearThenKeep", + "name": "BearThenKeep", + "description": "Bear instruction and then a keep instruction" + }, + { + "value": "DepartStart", + "name": "DepartStart", + "description": "Leave the starting point." + }, + { + "value": "BearThenMerge", + "name": "BearThenMerge", + "description": "Bear instruction and then a merge instruction." + }, + { + "value": "Continue", + "name": "Continue", + "description": "Continue on the current road." + }, + { + "value": "DepartIntermediateStop", + "name": "DepartIntermediateStop", + "description": "Leave an intermediate waypoint in a different direction and road than you arrived on." + }, + { + "value": "DepartIntermediateStopReturning", + "name": "DepartIntermediateStopReturning", + "description": "Leave an intermediate waypoint in the same direction and on the same road that you arrived on." + }, + { + "value": "EnterRoundabout", + "name": "EnterRoundabout", + "description": "Enter a roundabout." + }, + { + "value": "ExitRoundabout", + "name": "ExitRoundabout", + "description": "Exit a roundabout." + }, + { + "value": "EnterThenExitRoundabout", + "name": "EnterThenExitRoundabout", + "description": "Enter and exit a roundabout." + }, + { + "value": "ExitRoundaboutRight", + "name": "ExitRoundaboutRight", + "description": "At the roundabout take the exit on the right." + }, + { + "value": "ExitRoundaboutLeft", + "name": "ExitRoundaboutLeft", + "description": "At the roundabout take the exit on the left." + }, + { + "value": "Follow", + "name": "Follow", + "description": "Follow." + }, + { + "value": "GoAroundRoundabout", + "name": "GoAroundRoundabout", + "description": "Go around the roundabout." + }, + { + "value": "KeepLeft", + "name": "KeepLeft", + "description": "Keep left onto a different road." + }, + { + "value": "KeepOnRampLeft", + "name": "KeepOnRampLeft", + "description": "Keep left and continue onto ramp." + }, + { + "value": "KeepOnRampRight", + "name": "KeepOnRampRight", + "description": "Keep right and continue onto ramp." + }, + { + "value": "KeepOnRampStraight", + "name": "KeepOnRampStraight", + "description": "Keep straight and continue onto ramp." + }, + { + "value": "KeepRight", + "name": "KeepRight", + "description": "Keep right onto a different road." + }, + { + "value": "KeepStraight", + "name": "KeepStraight", + "description": "Keep straight onto a different road." + }, + { + "value": "KeepToStayLeft", + "name": "KeepToStayLeft", + "description": "Keep left to stay on the same road." + }, + { + "value": "KeepToStayRight", + "name": "KeepToStayRight", + "description": "Keep right to stay on the same road." + }, + { + "value": "KeepToStayStraight", + "name": "KeepToStayStraight", + "description": "Keep straight to stay on the same road." + }, + { + "value": "MergeFreeway", + "name": "MergeFreeway", + "description": "Merge onto a freeway." + }, + { + "value": "MergeHighway", + "name": "MergeHighway", + "description": "Merge onto a highway." + }, + { + "value": "MergeMotorway", + "name": "MergeMotorway", + "description": "Merge onto a motorway." + }, + { + "value": "MotorwayExitLeft", + "name": "MotorwayExitLeft", + "description": "Take the left exit." + }, + { + "value": "MotorwayExitRight", + "name": "MotorwayExitRight", + "description": "Take the right exit." + }, + { + "value": "None", + "name": "None", + "description": "No instruction." + }, + { + "value": "RampThenHighwayLeft", + "name": "RampThenHighwayLeft", + "description": "Take left ramp onto highway. This is part of a combined instruction." + }, + { + "value": "RampThenHighwayRight", + "name": "RampThenHighwayRight", + "description": "Take right ramp onto highway. This is part of a combined instruction." + }, + { + "value": "RampThenHighwayStraight", + "name": "RampThenHighwayStraight", + "description": "Stay straight to take ramp onto highway. This is part of a combined instruction." + }, + { + "value": "RoadNameChange", + "name": "RoadNameChange", + "description": "Road name changes." + }, + { + "value": "SwitchToParallelRoad", + "name": "SwitchToParallelRoad", + "description": "Switch to the parallel road." + }, + { + "value": "SwitchToMainRoad", + "name": "SwitchToMainRoad", + "description": "Switch to the main road." + }, + { + "value": "Take", + "name": "Take", + "description": "Take the road. This instruction is used when you are entering or exiting a ferry." + }, + { + "value": "TakeFerry", + "name": "TakeFerry", + "description": "Take the ferry." + }, + { + "value": "TakeExit", + "name": "TakeExit", + "description": "Take the exit." + }, + { + "value": "TakeRamp", + "name": "TakeRamp", + "description": "Take ramp." + }, + { + "value": "TakeRampLeft", + "name": "TakeRampLeft", + "description": "Take ramp to the left." + }, + { + "value": "TakeRampRight", + "name": "TakeRampRight", + "description": "Take ramp to the right." + }, + { + "value": "TakeRampStraight", + "name": "TakeRampStraight", + "description": "Stay straight to take ramp." + }, + { + "value": "TurnBack", + "name": "TurnBack", + "description": "Turn back sharply." + }, + { + "value": "TurnLeft", + "name": "TurnLeft", + "description": "Turn left." + }, + { + "value": "TurnLeftSharp", + "name": "TurnLeftSharp", + "description": "Take a sharp left turn." + }, + { + "value": "TurnLeftThenBearLeft", + "name": "TurnLeftThenBearLeft", + "description": "Turn left and then bear left." + }, + { + "value": "TurnLeftThenBearRight", + "name": "TurnLeftThenBearRight", + "description": "Turn left and then bear right." + }, + { + "value": "TurnLeftThenTurnLeft", + "name": "TurnLeftThenTurnLeft", + "description": "Turn left and then turn left again." + }, + { + "value": "TurnLeftThenTurnRight", + "name": "TurnLeftThenTurnRight", + "description": "Turn left and then turn right." + }, + { + "value": "TurnRight", + "name": "TurnRight", + "description": "Turn right." + }, + { + "value": "TurnRightSharp", + "name": "TurnRightSharp", + "description": "Take a sharp right turn." + }, + { + "value": "TurnRightThenBearLeft", + "name": "TurnRightThenBearLeft", + "description": "Turn right and then bear left." + }, + { + "value": "TurnRightThenBearRight", + "name": "TurnRightThenBearRight", + "description": "Turn right and then bear right." + }, + { + "value": "TurnRightThenTurnLeft", + "name": "TurnRightThenTurnLeft", + "description": "Turn right and then turn left." + }, + { + "value": "TurnRightThenTurnRight", + "name": "TurnRightThenTurnRight", + "description": "Turn right and then turn right again" + }, + { + "value": "TurnThenMerge", + "name": "TurnThenMerge", + "description": "Turn instruction followed by a merge instruction." + }, + { + "value": "TurnToStayLeft", + "name": "TurnToStayLeft", + "description": "Turn left to stay on the same road." + }, + { + "value": "TurnToStayRight", + "name": "TurnToStayRight", + "description": "Turn right to stay on the same road." + }, + { + "value": "Unknown", + "name": "Unknown", + "description": "The instruction is unknown." + }, + { + "value": "UTurn", + "name": "UTurn", + "description": "Make a u-turn to go in the opposite direction." + }, + { + "value": "Wait", + "name": "Wait", + "description": "Wait" + }, + { + "value": "Walk", + "name": "Walk", + "description": "Walk" + } + ] + } + }, + "RoadTypeEnum": { + "description": "The type of road. `Note`: Only supported for driving travelMode.", + "type": "string", + "enum": [ + "NotApplicable", + "LimitedAccessHighway", + "Highway", + "MajorRoad", + "Arterial", + "Street", + "Ramp", + "Ferry", + "WalkingPath" + ], + "x-ms-enum": { + "name": "RoadTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "NotApplicable", + "name": "NotApplicable", + "description": "NotApplicable." + }, + { + "value": "LimitedAccessHighway", + "name": "LimitedAccessHighway", + "description": "LimitedAccessHighway." + }, + { + "value": "Highway", + "name": "Highway", + "description": "Highway." + }, + { + "value": "MajorRoad", + "name": "MajorRoad", + "description": "MajorRoad." + }, + { + "value": "Arterial", + "name": "Arterial", + "description": "Arterial." + }, + { + "value": "Street", + "name": "Street", + "description": "Street." + }, + { + "value": "Ramp", + "name": "Ramp", + "description": "Ramp." + }, + { + "value": "Ferry", + "name": "Ferry", + "description": "Ferry." + }, + { + "value": "WalkingPath", + "name": "WalkingPath", + "description": "WalkingPath." + } + ] + } + }, + "SideOfStreetEnum": { + "description": "The side of the street where the destination is found based on the arrival direction. This field applies to the last maneuverPoint only.", + "type": "string", + "readOnly": true, + "enum": [ + "Left", + "Right", + "Unknown" + ], + "x-ms-enum": { + "name": "SideOfStreetEnum", + "modelAsString": true, + "values": [ + { + "value": "Left", + "name": "Left", + "description": "Left." + }, + { + "value": "Right", + "name": "Right", + "description": "Right." + }, + { + "value": "Unknown", + "name": "Unknown", + "description": "Unknown." + } + ] + } + }, + "TrafficDataUsedEnum": { + "description": "The type of real-time traffic data used to generate the route.", + "type": "string", + "enum": [ + "None", + "Flow", + "Closure", + "FlowAndClosure" + ], + "x-ms-enum": { + "name": "TrafficDataUsedEnum", + "modelAsString": true, + "values": [ + { + "value": "None", + "name": "None", + "description": "None." + }, + { + "value": "Flow", + "name": "Flow", + "description": "Real-time traffic speeds used to calculate travel time." + }, + { + "value": "Closure", + "name": "Closure", + "description": "Real-time closure data used, if applicable." + }, + { + "value": "FlowAndClosure", + "name": "FlowAndClosure", + "description": "Flow and Closure." + } + ] + } + }, + "TrafficCongestionEnum": { + "description": "The level of traffic congestion along the route. `Note`: Only supported for driving travelMode", + "type": "string", + "enum": [ + "Unknown", + "None", + "Mild", + "Medium", + "Heavy" + ], + "x-ms-enum": { + "name": "TrafficCongestionEnum", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "name": "Unknown", + "description": "Unknown." + }, + { + "value": "None", + "name": "None", + "description": "None." + }, + { + "value": "Mild", + "name": "Mild", + "description": "Mild." + }, + { + "value": "Medium", + "name": "Medium", + "description": "Medium." + }, + { + "value": "Heavy", + "name": "Heavy", + "description": "Heavy." + } + ] + } + }, + "Instruction": { + "description": "A description of a maneuver in a set of directions.", + "type": "object", + "properties": { + "maneuverType": { + "$ref": "#/definitions/ManeuverTypeEnum" + }, + "text": { + "description": "The plain text description of the instruction.", + "type": "string", + "readOnly": true + }, + "formattedText": { + "description": "The formatted text description of the instruction.", + "type": "string", + "readOnly": true + }, + "hints": { + "description": "Additional information that may be helpful in following a route. In addition to the hint text, this element has an attribute hintType that specifies what the hint refers to, such as “NextIntersection.” Hint is an optional element and a route step can contain more than one hint. `Note`: Only supported for driving travelMode", + "type": "array", + "items": { + "$ref": "#/definitions/Hint" + } + } + } + }, + "RouteMatrixVehicleSpec": { + "description": "Vehicle attributes are specified inside of a vehicleSpec. Different regions may have different definitions for the truck classification and types, e.g., light truck, medium truck, heavy truck, etc. To get the most accurate results of the route restrictions based on the truck specs, specify the vehicle attributes.\n\n `Note`: Only supported for truck travelMode.", + "type": "object", + "properties": { + "isVehicleCommercial": { + "description": "Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads.", + "type": "boolean", + "default": false + }, + "length": { + "x-ms-client-name": "lengthInMeters", + "description": "Length of the vehicle in meters. A value of 0 means that length restrictions are not considered.", + "type": "number", + "format": "double", + "maximum": 1000000, + "minimum": 0, + "default": 0 + }, + "width": { + "x-ms-client-name": "widthInMeters", + "description": "Width of the vehicle in meters. A value of 0 means that width restrictions are not considered.", + "type": "number", + "format": "double", + "maximum": 1000000, + "minimum": 0, + "default": 0 + }, + "height": { + "x-ms-client-name": "heightInMeters", + "description": "Height of the vehicle in meters. A value of 0 means that height restrictions are not considered.", + "type": "number", + "format": "double", + "maximum": 1000000, + "minimum": 0, + "default": 0 + }, + "weight": { + "x-ms-client-name": "weightInKilograms", + "description": "Weight of the vehicle in kilograms. A value of 0 means that weight restrictions are not considered.", + "format": "int64", + "type": "integer", + "maximum": 1000000, + "minimum": 0, + "default": 0 + }, + "maxSpeed": { + "x-ms-client-name": "maxSpeedInKilometersPerHour", + "description": "Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.\n\nA value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.\n\nA non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.", + "format": "int64", + "type": "integer", + "maximum": 250, + "minimum": 0, + "default": 0 + }, + "axleWeight": { + "x-ms-client-name": "axleWeightInKilograms", + "description": "Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.", + "format": "int64", + "type": "integer", + "maximum": 1000000, + "minimum": 0, + "default": 0 + }, + "loadType": { + "description": "Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType supports multiple values in a request.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "USHazmatClass1", + "USHazmatClass2", + "USHazmatClass3", + "USHazmatClass4", + "USHazmatClass5", + "USHazmatClass6", + "USHazmatClass7", + "USHazmatClass8", + "USHazmatClass9", + "otherHazmatExplosive", + "otherHazmatGeneral", + "otherHazmatHarmfulToWater" + ], + "x-ms-enum": { + "name": "VehicleLoadTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "USHazmatClass1", + "description": "Explosives" + }, + { + "value": "USHazmatClass2", + "description": "Compressed gas" + }, + { + "value": "USHazmatClass3", + "description": "Flammable liquids" + }, + { + "value": "USHazmatClass4", + "description": "Flammable solids" + }, + { + "value": "USHazmatClass5", + "description": "Oxidizers" + }, + { + "value": "USHazmatClass6", + "description": "Poisons" + }, + { + "value": "USHazmatClass7", + "description": "Radioactive" + }, + { + "value": "USHazmatClass8", + "description": "Corrosives" + }, + { + "value": "USHazmatClass9", + "description": "Miscellaneous" + }, + { + "value": "otherHazmatExplosive", + "description": "Explosives" + }, + { + "value": "otherHazmatGeneral", + "description": "Miscellaneous" + }, + { + "value": "otherHazmatHarmfulToWater", + "description": "Harmful to water" + } + ] + } + } + }, + "adrTunnelRestrictionCode": { + "description": "The ADR tunnel restriction code. ADR is a European agreement concerning the international carriage of dangerous goods by road. The ADR tunnel restriction code is used to determine whether a vehicle is allowed to pass through a tunnel with restrictions on the carriage of dangerous goods.", + "type": "string", + "enum": [ + "B", + "C", + "D", + "E" + ], + "x-ms-enum": { + "name": "AdrTunnelRestrictionCodeEnum", + "modelAsString": true, + "values": [ + { + "value": "B", + "name": "B", + "description": "Vehicles with code B are restricted from roads with ADR tunnel categories B, C, D, and E." + }, + { + "value": "C", + "name": "C", + "description": "Vehicles with code C are restricted from roads with ADR tunnel categories C, D, and E" + }, + { + "value": "D", + "name": "D", + "description": "Vehicles with code D are restricted from roads with ADR tunnel categories D and E." + }, + { + "value": "E", + "name": "E", + "description": "Vehicles with code E are restricted from roads with ADR tunnel category E." + } + ] + } + } + } + }, + "VehicleSpec": { + "description": "Vehicle attributes are specified inside of a vehicleSpec. Different regions may have different definitions for the truck classification and types, e.g., light truck, medium truck, heavy truck, etc. To get the most accurate results of the route restrictions based on the truck specs, specify the vehicle attributes.\n\n `Note`: Only supported for truck travelMode.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RouteMatrixVehicleSpec" + }, + { + "type": "object", + "properties": { + "axleCount": { + "description": "Number of axles on the vehicle. A value of 0 means that axle restrictions are not considered.", + "format": "int64", + "type": "integer", + "maximum": 1000000, + "minimum": 0, + "default": 0 + } + } + } + ] + }, + "AvoidEnum": { + "description": "Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode.\n\nExample: \"avoid\": [\"limitedAccessHighways\", \"tolls\"]", + "type": "array", + "items": { + "type": "string", + "enum": [ + "limitedAccessHighways", + "tollRoads", + "ferries", + "tunnels", + "borderCrossings", + "lowEmissionZones", + "unpavedRoads" + ], + "x-ms-enum": { + "name": "AvoidEnum", + "modelAsString": true, + "values": [ + { + "value": "limitedAccessHighways", + "description": "Avoids the use of limited access highways in the route." + }, + { + "value": "tollRoads", + "description": "Avoids the use of toll roads in the route." + }, + { + "value": "ferries", + "description": "Avoids the use of ferries in the route." + }, + { + "value": "tunnels", + "description": "Avoids the use of tunnels in the route. `Note`: Only supported for truck travelMode." + }, + { + "value": "borderCrossings", + "description": "Avoids crossing country borders in the route." + }, + { + "value": "lowEmissionZones", + "description": "Avoids low-emission zones in the route. `Note`: Only supported for truck travelMode." + }, + { + "value": "unpavedRoads", + "description": "Avoids unpaved roads in the route. `Note`: Only supported for truck travelMode." + } + ] + } + } + }, + "RouteMatrixAvoidEnum": { + "description": "Specifies something that the route calculation should try to avoid when determining the route.", + "type": "string", + "enum": [ + "tollRoads", + "unpavedRoads" + ], + "x-ms-enum": { + "name": "RouteMatrixAvoidEnum", + "modelAsString": true, + "values": [ + { + "value": "tollRoads", + "name": "TollRoads", + "description": "Avoids toll roads." + }, + { + "value": "unpavedRoads", + "name": "UnpavedRoads", + "description": "Avoids unpaved roads." + } + ] + } + }, + "RouteMatrixTrafficEnum": { + "description": "Decides how traffic is considered for computing routes.", + "type": "string", + "default": "historical", + "enum": [ + "historical", + "live" + ], + "x-ms-enum": { + "name": "RouteMatrixTrafficEnum", + "modelAsString": true, + "values": [ + { + "value": "historical", + "name": "Historical", + "description": "Finds the route based on historical traffic data" + }, + { + "value": "live", + "name": "Live", + "description": "Finds the route based on live traffic data." + } + ] + } + }, + "TravelModeEnum": { + "description": "The mode of travel for the requested route. If not defined, the default value is \"driving\" that returns the route optimized for cars.\n\n`Note`: For truck travelMode, the requested truck route may not be available for the entire route. Where the truck route is not available for a particular section, the travelMode element of the response for that section will be \"other\".\n\nExample: \"travelMode\":\"driving\"", + "type": "string", + "default": "driving", + "enum": [ + "driving", + "truck", + "walking" + ], + "x-ms-enum": { + "name": "TravelModeEnum", + "modelAsString": true, + "values": [ + { + "value": "driving", + "description": "The returned routes are optimized for cars." + }, + { + "value": "truck", + "description": "The returned routes are optimized for large size trucks based on the vehicle specification." + }, + { + "value": "walking", + "description": "The returned routes are optimized for pedestrians, including the use of sidewalks." + } + ] + } + }, + "OptionalId": { + "type": "object", + "description": "optional Id", + "properties": { + "optionalId": { + "description": "Id of the request which would show in corresponding batchItem.", + "type": "string" + } + } + }, + "RoutePathTravelModeEnum": { + "description": "The mode of travel for the route path in the response.", + "type": "string", + "default": "driving", + "enum": [ + "driving", + "truck", + "walking", + "other" + ], + "x-ms-enum": { + "name": "RoutePathTravelModeEnum", + "modelAsString": true, + "values": [ + { + "value": "driving", + "description": "Routes optimized for cars." + }, + { + "value": "truck", + "description": "Routes optimized for large size trucks based on the vehicle specification." + }, + { + "value": "walking", + "description": "Routes optimized for pedestrians." + }, + { + "value": "other", + "description": "RouteTravelMode is returned as \"other\" for the truck travelMode when the truck route is not available for a particular section of a route." + } + ] + } + }, + "Order": { + "description": "Sequence for visiting waypoints and viaWaypoints.", + "type": "object", + "properties": { + "inputIndex": { + "description": "User-provided index for waypoint and viaWaypoint inputs.", + "type": "integer", + "format": "int64" + }, + "optimizedIndex": { + "description": "System-optimized waypoint and viaWaypoint index.", + "type": "integer", + "format": "int64" + } + } + }, + "InputSnapToRoadsFeaturesItem": { + "type": "object", + "description": "Specifies the input snap to roads points. `GeoJSON` feature object and additional properties. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonPoint" + }, + "properties": { + "description": "Feature properties.", + "type": "object" + } + }, + "required": [ + "type", + "geometry", + "properties" + ] + }, + "SnapToRoadFeaturesItem": { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "allOf": [ + { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonPoint" + }, + "bbox": { + "$ref": "#/definitions/Bbox" + }, + "properties": { + "$ref": "#/definitions/SnapToRoadsFeatureProperties" + } + } + } + ] + }, + "SnapToRoadsFeatureProperties": { + "description": "Snap to Roads properties.", + "type": "object", + "properties": { + "inputIndex": { + "description": "Identify the corresponding index in the original list of points for each snapped point. Ensure that interpolated points have unique indices to distinguish them from the snapped points.", + "format": "int64", + "type": "integer" + }, + "isInterpolate": { + "description": "Identify whether this is the interpolation point.", + "type": "boolean" + }, + "name": { + "description": "Name of the road.", + "type": "string" + }, + "speedLimitInKilometersPerHour": { + "description": "Speed limit in kilometers per hour.", + "type": "number", + "format": "double" + } + } + }, + "InputRouteRangeProperties": { + "type": "object", + "description": "Specifies the properties of Route Range", + "properties": { + "departAt": { + "description": "The date and time of departure from the origin point formatted as a dateTime value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe departAt value must be in the future in the date-time format or now value to set it to the current time.\n\nExamples:\n\n\"departAt\": \"2023-06-01T09:30:00.000-07:00\"", + "type": "string", + "format": "date-time" + }, + "isSimplifiedPolygon": { + "description": "Return simplified polygons for the route range.", + "type": "boolean", + "default": "false" + }, + "optimizeRoute": { + "description": "Specifies the parameter to use to optimize the route. If not defined, the default is \"fastestWithoutTraffic\" which returns the route to minimize the travel time without using current traffic information.\n\nExample: \"optimizeRoute\":\"shortest\"", + "type": "string", + "default": "fastestWithoutTraffic", + "enum": [ + "shortest", + "fastestWithoutTraffic", + "fastestWithTraffic", + "thrillingWithTraffic", + "thrillingWithoutTraffic" + ], + "x-ms-enum": { + "name": "RouteRangeOptimizeRouteEnum", + "modelAsString": true, + "values": [ + { + "value": "shortest", + "name": "Shortest", + "description": "The route is calculated to minimize the distance. Traffic information is not used." + }, + { + "value": "fastestWithoutTraffic", + "name": "FastestWithoutTraffic", + "description": "Finds the fastest route, without factoring in traffic information." + }, + { + "value": "fastestWithTraffic", + "name": "FastestWithTraffic", + "description": "The route is calculated to minimize the time using current traffic information. `Note`: Only supported for driving and truck travelMode." + }, + { + "value": "thrillingWithTraffic", + "name": "ThrillingWithTraffic", + "description": "The route is calculated to provide a thrilling driving experience using current traffic information." + }, + { + "value": "thrillingWithoutTraffic", + "name": "ThrillingWithoutTraffic", + "description": "The route is calculated to provide a thrilling driving experience without using current traffic information." + } + ] + } + }, + "avoid": { + "$ref": "#/definitions/AvoidEnum" + }, + "vehicleSpec": { + "$ref": "#/definitions/VehicleSpec" + }, + "distanceBudgetInMeters ": { + "description": "The distance budget refers to the maximum number of meters one can travel without going over the set limit.", + "type": "number", + "minimum": 0, + "maximum": 500000 + }, + "timeBudgetInSec": { + "description": "The time budget represents the maximum number of seconds available for travel, defining how far one can go within this time constraint.", + "type": "number", + "minimum": 0, + "maximum": 60000 + }, + "thrilling": { + "type": "object", + "description": "The thrilling object is used to describe a route with two main characteristics: windingness and hilliness and is used when optimizedRoute is thrilling mode.", + "properties": { + "windingness": { + "description": "Specify the windingness of the route. If unspecified, the default mode is \"normal\".", + "type": "string", + "default": "normal", + "enum": [ + "normal", + "low", + "high" + ], + "x-ms-enum": { + "name": "WindingnessEnum", + "modelAsString": true, + "values": [ + { + "value": "normal", + "description": "normal" + }, + { + "value": "low", + "description": "low" + }, + { + "value": "high", + "description": "high" + } + ] + } + }, + "hilliness": { + "description": "Specify the hilliness of the route. If unspecified, the default mode is \"normal\".", + "type": "string", + "default": "normal", + "enum": [ + "normal", + "low", + "high" + ], + "x-ms-enum": { + "name": "HillinessEnum", + "modelAsString": true, + "values": [ + { + "value": "normal", + "description": "normal" + }, + { + "value": "low", + "description": "low" + }, + { + "value": "high", + "description": "high" + } + ] + } + } + } + }, + "travelMode": { + "description": "Specify the travel mode. If unspecified, the default mode is \"driving\".", + "type": "string", + "default": "driving", + "enum": [ + "driving", + "truck" + ], + "x-ms-enum": { + "name": "RouteRangeTravelModeEnum", + "modelAsString": true, + "values": [ + { + "value": "driving", + "description": "driving" + }, + { + "value": "truck", + "description": "truck." + } + ] + } + } + } + }, + "InputRouteRangeFeaturesItem": { + "type": "object", + "description": "Specifies the starting point for range calculation. `GeoJSON` feature object and additional properties. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonPoint" + }, + "properties": { + "type": "object", + "description": "Route Ranges properties." + } + }, + "required": [ + "type", + "geometry", + "properties" + ] + }, + "RouteRangeFeaturesItem": { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "allOf": [ + { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "#/definitions/RouteRangeGeometry" + }, + "bbox": { + "$ref": "#/definitions/Bbox" + }, + "properties": { + "$ref": "#/definitions/RouteRangeFeatureProperties" + } + } + } + ] + }, + "RouteRangeFeatureProperties": { + "description": "Route Ranges properties.", + "type": "object", + "properties": { + "type": { + "description": "The point type", + "type": "string", + "enum": [ + "center", + "boundary" + ], + "x-ms-enum": { + "name": "RouteRangeTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "center", + "description": "The center point for the range calculation." + }, + { + "value": "boundary", + "description": "The boundary for the range calculation." + } + ] + } + } + } + }, + "InputRouteMatrixFeaturesItem": { + "type": "object", + "description": "Specifies the input origins and destination points. `GeoJSON` feature object and additional properties. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonMultiPoint" + }, + "properties": { + "description": "Feature properties.", + "type": "object", + "$ref": "#/definitions/InputRouteMatrixProperties" + } + }, + "required": [ + "type", + "geometry", + "properties" + ] + }, + "InputRouteMatrixProperties": { + "type": "object", + "description": "Specifies the properties of Route Matrix", + "properties": { + "pointType": { + "description": "The type of the route matrix.", + "type": "string", + "enum": [ + "origins", + "destinations" + ], + "x-ms-enum": { + "name": "RouteMatrixTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "origins", + "description": "The route matrix is calculated based on the distance between the points." + }, + { + "value": "destinations", + "description": "The route matrix is calculated based on the duration between the points." + } + ] + } + } + } + }, + "RouteMatrixFeatureItem": { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "allOf": [ + { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonMultiPoint" + }, + "properties": { + "$ref": "#/definitions/RouteMatrixFeatureProperties" + } + } + } + ] + }, + "RouteMatrixFeatureProperties": { + "description": "Route Matrix properties.", + "type": "object", + "properties": { + "originIndex": { + "description": "Index of the origin point", + "type": "integer", + "format": "int32" + }, + "destinationIndex": { + "description": "Index of the destination point", + "type": "integer", + "format": "int32" + }, + "departureTime": { + "description": "The estimated departure time, which takes into account the traffic conditions, is formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.", + "format": "date-time", + "readOnly": true + }, + "arrivalTime": { + "description": "The estimated arrival time, which takes into account the traffic conditions, is formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.", + "format": "date-time", + "readOnly": true + }, + "distanceInMeters": { + "description": "Length In Meters property", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "Estimated travel time in seconds that does not include delays on the route due to traffic conditions.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "durationTrafficInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "error": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" + } + } + }, + "DirectionsBatchRequestItem": { + "description": "Batch Query object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OptionalId" + }, + { + "$ref": "#/definitions/DirectionsRequest" + } + ] + }, + "DirectionsBatchRequestBody": { + "description": "The list of directions queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query.", + "type": "object", + "properties": { + "batchItems": { + "description": "The list of queries to process.", + "type": "array", + "items": { + "$ref": "#/definitions/DirectionsBatchRequestItem" + } + } + } + }, + "DirectionsBatchResponseItem": { + "description": "Batch response item", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OptionalId" + }, + { + "$ref": "#/definitions/RouteDirectionsResponse" + }, + { + "type": "object", + "description": "error details", + "properties": { + "error": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" + } + } + } + ] + }, + "DirectionsBatchResponse": { + "description": "This object is returned from a successful Directions Batch service call.", + "type": "object", + "properties": { + "summary": { + "description": "Summary for the batch request", + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "successfulRequests": { + "description": "Number of successful requests in the batch", + "type": "integer", + "format": "int32" + }, + "totalRequests": { + "description": "Total number of requests in the batch", + "type": "integer", + "format": "int32" + } + } + }, + "batchItems": { + "description": "Array containing the batch results.", + "type": "array", + "items": { + "$ref": "#/definitions/DirectionsBatchResponseItem" + } + } + } + }, + "AsyncBatchRequestBody": { + "type": "object", + "description": "Universal asynchronous batch request body.", + "properties": { + "inputBlobUrl": { + "description": "The URL to the input blob containing the batch of queries. This should be a valid URL pointing to a blob of an Azure Storage Account", + "type": "string", + "format": "uri" + }, + "outputStorageUrl": { + "description": "The URL that points to a blob storage where the batch results will be stored.", + "type": "string", + "format": "uri" + }, + "msiClientId": { + "description": "Client ID of a user-assigned managed identity. This is used for authentication and authorization purposes. If the managed identity is system-assigned, this field can be null.", + "type": "string" + } + }, + "required": [ + "inputBlobUrl", + "outputStorageUrl" + ] + }, + "RouteOperation": { + "type": "object", + "description": "This object is returned from a successful Get Operation request.", + "properties": { + "id": { + "description": "Unique identifier for the asynchronous operation.", + "type": "string" + }, + "status": { + "type": "string", + "description": "Current status of the async operation.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "StatusEnum", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "The operation has not started yet." + }, + { + "value": "Running", + "description": "The operation is running." + }, + { + "value": "Succeeded", + "description": "The operation has completed successfully." + }, + { + "value": "Failed", + "description": "The operation has failed." + } + ] + } + }, + "kind": { + "$ref": "#/definitions/RouteOperationKindEnum" + }, + "result": { + "description": "The result of async operation", + "type": "object", + "properties": { + "resultUrl": { + "description": "URL to the get the result of async operation", + "type": "string", + "format": "uri" + } + } + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the operation was created." + }, + "lastActionDateTime": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the operation status was updated." + }, + "error": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" + } + } + }, + "RouteOperationKindEnum": { + "type": "string", + "description": "Type of asynchronous operation", + "enum": [ + "RouteMatrix" + ], + "x-ms-enum": { + "name": "RouteOperationKindEnum", + "modelAsString": true, + "values": [ + { + "value": "RouteMatrix", + "description": "Route matrix asynchronous job." + } + ] + } + }, + "RouteMatrixSummary": { + "type": "object", + "description": "Summary for the route matrix request", + "properties": { + "successfulCount": { + "description": "Number of successful routes within this matrix.", + "type": "integer", + "format": "int32" + }, + "totalCount": { + "description": "Total number of routes within this matrix.", + "type": "integer", + "format": "int32" + } + } + }, + "AsyncBatchOperation": { + "$ref": "../../../AsyncBatchManagement/preview/2024-04-01-preview/asyncBatchManagement.json#/definitions/AsyncBatchOperation" + }, + "SnapToRoadsBatchRequestBody": { + "description": "The list of snap to roads queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query.", + "type": "object", + "properties": { + "batchItems": { + "description": "The list of queries to process.", + "type": "array", + "items": { + "$ref": "#/definitions/SnapToRoadsBatchRequestItem" + } + } + } + }, + "SnapToRoadsBatchRequestItem": { + "description": "Batch Query object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OptionalId" + }, + { + "$ref": "#/definitions/SnapToRoadsRequest" + } + ] + }, + "SnapToRoadsBatchResponseItem": { + "description": "Batch response item", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OptionalId" + }, + { + "$ref": "#/definitions/SnapToRoadsResponse" + }, + { + "type": "object", + "description": "error details", + "properties": { + "error": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" + } + } + } + ] + }, + "SnapToRoadsBatchResponse": { + "description": "This object is returned from a successful Snap To Roads Batch service call.", + "type": "object", + "properties": { + "summary": { + "description": "Summary for the batch request", + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "successfulRequests": { + "description": "Number of successful requests in the batch", + "type": "integer", + "format": "int32" + }, + "totalRequests": { + "description": "Total number of requests in the batch", + "type": "integer", + "format": "int32" + } + } + }, + "batchItems": { + "description": "Array containing the batch results.", + "type": "array", + "items": { + "$ref": "#/definitions/SnapToRoadsBatchResponseItem" + } + } + } + }, + "RouteRangeBatchRequestBody": { + "description": "The list of route range queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query.", + "type": "object", + "properties": { + "batchItems": { + "description": "The list of queries to process.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteRangeBatchRequestItem" + } + } + } + }, + "RouteRangeBatchRequestItem": { + "description": "Batch Query object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OptionalId" + }, + { + "$ref": "#/definitions/RouteRangeRequest" + } + ] + }, + "RouteRangeBatchResponse": { + "description": "This object is returned from a successful Route Range Batch service call.", + "type": "object", + "properties": { + "summary": { + "description": "Summary for the batch request", + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "successfulRequests": { + "description": "Number of successful requests in the batch", + "type": "integer", + "format": "int32" + }, + "totalRequests": { + "description": "Total number of requests in the batch", + "type": "integer", + "format": "int32" + } + } + }, + "batchItems": { + "description": "Array containing the batch results.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteRangeBatchResponseItem" + } + } + } + }, + "RouteRangeBatchResponseItem": { + "description": "Batch response item", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OptionalId" + }, + { + "$ref": "#/definitions/RouteRangeResponse" + }, + { + "type": "object", + "description": "error details", + "properties": { + "error": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" + } + } + } + ] + } + } +} diff --git a/specification/maps/data-plane/Route/readme.md b/specification/maps/data-plane/Route/readme.md index 5893d10109aa..b04054c72ab5 100644 --- a/specification/maps/data-plane/Route/readme.md +++ b/specification/maps/data-plane/Route/readme.md @@ -27,7 +27,7 @@ These are the global settings for Route Client. ``` yaml title: RouteClient openapi-type: data-plane -tag: package-preview-2024-05 +tag: package-preview-2024-06 add-credentials: true credential-default-policy-type: BearerTokenCredentialPolicy credential-scopes: 'https://atlas.microsoft.com/.default' @@ -39,15 +39,31 @@ modelerfour: lenient-model-deduplication: true ``` -### Tag: package-preview-2024-05 +### Tag: package-preview-2024-6 + +These settings apply only when `--tag=package-preview-2024-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-06' +input-file: + - preview/2024-06-01-preview/route.json + +suppressions: + - code: OperationIdNounVerb + reason: False alarm. Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. +``` +### Tag: package-preview-2024-5 These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. ```yaml $(tag) == 'package-preview-2024-05' input-file: - preview/2024-05-01-preview/route.json -``` +suppressions: + - code: OperationIdNounVerb + reason: False alarm. Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. + +``` ### Tag: package-preview-2024-04 These settings apply only when `--tag=package-preview-2024-04` is specified on the command line. From cb458ebd35c56a91f6f6723ade22527b28952421 Mon Sep 17 00:00:00 2001 From: Shawn Fang <45607042+mssfang@users.noreply.github.com> Date: Tue, 4 Jun 2024 11:35:09 -0700 Subject: [PATCH 32/49] [OAI-Assistant] Added Missing annotation and delete unnecessary annotation (#29297) * fixed the error * npx tsp compile updates --------- Co-authored-by: Travis Wilson Co-authored-by: Jose Alvarez --- .../tools/tool_resources.tsp | 1 + .../vector_stores/files/routes.tsp | 1 - .../assistants_generated.json | 23 +++++++++++++------ .../assistants_generated.yaml | 11 ++++++--- 4 files changed, 25 insertions(+), 11 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/tools/tool_resources.tsp b/specification/ai/OpenAI.Assistants/tools/tool_resources.tsp index b3b5b81c9164..55f43651c27f 100644 --- a/specification/ai/OpenAI.Assistants/tools/tool_resources.tsp +++ b/specification/ai/OpenAI.Assistants/tools/tool_resources.tsp @@ -160,5 +160,6 @@ model UpdateCodeInterpreterToolResourceOptions { model UpdateFileSearchToolResourceOptions { /** A list of vector store IDs to override the current list of the assistant. */ @maxItems(1) + @encodedName("application/json", "vector_store_ids") vectorStoreIds?: string[]; } diff --git a/specification/ai/OpenAI.Assistants/vector_stores/files/routes.tsp b/specification/ai/OpenAI.Assistants/vector_stores/files/routes.tsp index 2f0d81651415..54730eac9e85 100644 --- a/specification/ai/OpenAI.Assistants/vector_stores/files/routes.tsp +++ b/specification/ai/OpenAI.Assistants/vector_stores/files/routes.tsp @@ -45,7 +45,6 @@ op createVectorStoreFile( /** A File ID that the vector store should use. Useful for tools like `file_search` that can access files. */ @encodedName("application/json", "file_id") - @body fileId: string, ): VectorStoreFile; diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index 3784be740a46..b0fe2a911183 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -1941,14 +1941,22 @@ "type": "string" }, { - "name": "file_id", + "name": "body", "in": "body", - "description": "A File ID that the vector store should use. Useful for tools like `file_search` that can access files.", "required": true, "schema": { - "type": "string" - }, - "x-ms-client-name": "fileId" + "type": "object", + "properties": { + "file_id": { + "type": "string", + "description": "A File ID that the vector store should use. Useful for tools like `file_search` that can access files.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + } } ], "responses": { @@ -4590,13 +4598,14 @@ "type": "object", "description": "Request object to update `file_search` tool resources.", "properties": { - "vectorStoreIds": { + "vector_store_ids": { "type": "array", "description": "A list of vector store IDs to override the current list of the assistant.", "maxItems": 1, "items": { "type": "string" - } + }, + "x-ms-client-name": "vectorStoreIds" } } }, diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml index c4bafc803e41..050d1237ad90 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml @@ -1228,12 +1228,17 @@ paths: schema: $ref: '#/components/schemas/VectorStoreFile' requestBody: - description: A File ID that the vector store should use. Useful for tools like `file_search` that can access files. required: true content: application/json: schema: - type: string + type: object + properties: + file_id: + type: string + description: A File ID that the vector store should use. Useful for tools like `file_search` that can access files. + required: + - file_id /vector_stores/{vectorStoreId}/files/{fileId}: get: operationId: getVectorStoreFile @@ -3844,7 +3849,7 @@ components: UpdateFileSearchToolResourceOptions: type: object properties: - vectorStoreIds: + vector_store_ids: type: array items: type: string From f6fbf63641332dd06c025d995a82dc090a5f6fad Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Tue, 4 Jun 2024 20:35:33 +0200 Subject: [PATCH 33/49] [OpenAI] [Inference] TSP definition updates for `v2024_05_01_preview` service release (#29182) * Azure OpenAI: 2024-04-01-preview updates * add audio formats * post-merge fix incl. tool update for enum conversion to union * minor: spellcheck fix * refine duration encoding for word start/end * enable serialization into azure json and rename customization class name * Added new customBlockList filter and fields to OYD * Adding changes to authentication for Vector Search * Adjusted docs for OYD vector search auth models * Added missing field and retrieved documents * Examples added * corrected examples api-versions in json * Reformat * Recompile after reformat * PR comments: wrong plural and type precision * Revert added tab to service spec Co-authored-by: Shawn Fang <45607042+mssfang@users.noreply.github.com> * Added readme entry for generated openAPI doc * Trying to improve folder structure * Removed moved and renamed generated.json files * Reverted last 3 commits * Added entry for generated.json swagger in the readme * Changed enum to nonExpandable * Ran formatter --------- Co-authored-by: Travis Wilson Co-authored-by: Travis Wilson <35748617+trrwilson@users.noreply.github.com> Co-authored-by: Shawn Fang Co-authored-by: Shawn Fang <45607042+mssfang@users.noreply.github.com> --- .../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 + .../generated_chat_completions.json | 45 + .../generated_completions.json | 38 + .../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 + .../generated_image_generation.json | 31 + .../get_image_operation_status.json | 27 + .../start_generate_image.json | 25 + .../OpenAI.Inference/main.tsp | 3 + .../completions/azure_chat_extensions.tsp | 49 + .../extensions/oyd/common_options.tsp | 36 + .../extensions/oyd/vector_search.tsp | 57 +- .../OpenAI.Inference/models/images/images.tsp | 5 + .../preview/2024-02-15-preview/generated.json | 7 +- .../preview/2024-03-01-preview/generated.json | 7 +- .../preview/2024-04-01-preview/generated.json | 7 +- .../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 + .../preview/2024-05-01-preview/generated.json | 4701 +++++++++++++++++ .../AzureOpenAI/inference/readme.md | 7 + 44 files changed, 9440 insertions(+), 19 deletions(-) create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_speech.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_transcription_object.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_transcription_text.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_translation_object.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_translation_text.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_chat_completions.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_completions.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_embeddings.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_aml_index.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_azure_search_advanced.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_azure_search_image_vector.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_azure_search_minimum.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_cosmos_db.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_elasticsearch.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_pinecone.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_image_generation.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/get_image_operation_status.json create mode 100644 specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/start_generate_image.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_audio_speech.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_audio_transcription_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_audio_transcription_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_audio_translation_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_audio_translation_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_chat_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_embeddings.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_aml_index.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_pinecone.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_image_generation.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_speech.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_speech.json new file mode 100644 index 000000000000..311e4b88a36c --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_transcription_object.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_transcription_object.json new file mode 100644 index 000000000000..6ba2f060b5f5 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_transcription_text.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_transcription_text.json new file mode 100644 index 000000000000..f48298297e37 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "type": "string", + "body": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_translation_object.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_translation_object.json new file mode 100644 index 000000000000..fa1b6db54ecb --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_translation_text.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_audio_translation_text.json new file mode 100644 index 000000000000..0e1e8cb85203 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "type": "string", + "body": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_chat_completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_chat_completions.json new file mode 100644 index 000000000000..786e2993cdde --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-05-01-preview/generated_completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_completions.json new file mode 100644 index 000000000000..da5f289b26e4 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-05-01-preview/generated_embeddings.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_embeddings.json new file mode 100644 index 000000000000..9c45cdea0fbc --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_embeddings.json @@ -0,0 +1,1567 @@ +{ + "operationId": "GetEmbeddings", + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-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/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_aml_index.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_aml_index.json new file mode 100644 index 000000000000..142771a8da2b --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..58d8d4dfbd9f --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..7d8799795653 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..4177a2b09465 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_cosmos_db.json new file mode 100644 index 000000000000..7208385ad243 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_elasticsearch.json new file mode 100644 index 000000000000..553e75a496be --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_pinecone.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_extensions_chat_completions_pinecone.json new file mode 100644 index 000000000000..e804ebf0efd3 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/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-05-01-preview", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-05-01-preview/generated_image_generation.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_image_generation.json new file mode 100644 index 000000000000..843719ac294c --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/generated_image_generation.json @@ -0,0 +1,31 @@ +{ + "operationId": "GetImageGenerations", + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-05-01-preview/get_image_operation_status.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/get_image_operation_status.json new file mode 100644 index 000000000000..084fb3c4b5c8 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/get_image_operation_status.json @@ -0,0 +1,27 @@ +{ + "operationId": "GetAzureBatchImageGenerationOperationStatus", + "title": "Returns the status of the images operation", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "operationId": "" + }, + "responses": { + "200": { + "body": { + "created": 1686676595, + "expires": 1686762999, + "id": "", + "result": { + "created": 1686676595, + "data": [ + { + "url": "https://image/path" + } + ] + }, + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/start_generate_image.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/start_generate_image.json new file mode 100644 index 000000000000..b193d850a6cd --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-05-01-preview/start_generate_image.json @@ -0,0 +1,25 @@ +{ + "operationId": "BeginAzureBatchImageGeneration", + "title": "Starts the generation of a batch of images from a text caption", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "prompt": "a monkey eating a banana", + "size": "256x256", + "n": 1 + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{endpoint}/openai/operations/images/?api-version=2023-06-01-preview" + }, + "body": { + "id": "", + "status": "notRunning", + "created": 0 + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/main.tsp b/specification/cognitiveservices/OpenAI.Inference/main.tsp index 2ef69bead900..a8421a3f7fbf 100644 --- a/specification/cognitiveservices/OpenAI.Inference/main.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/main.tsp @@ -61,4 +61,7 @@ enum ServiceApiVersions { @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2024_04_01_Preview: "2024-04-01-preview", + + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_05_01_Preview: "2024-05-01-preview", } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_chat_extensions.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_chat_extensions.tsp index a15d803cfbcc..3f30a4ccced3 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_chat_extensions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_chat_extensions.tsp @@ -68,6 +68,11 @@ model AzureChatExtensionsMessageContext { @doc("The detected intent from the chat history, used to pass to the next turn to carry over the context.") intent?: string; + + /** All the retrieved documents. */ + @added(ServiceApiVersions.v2024_05_01_Preview) + @encodedName("application/json", "all_retrieved_documents") + allRetrievedDocuments?: AzureChatExtensionRetrievedDocument[]; } @added(ServiceApiVersions.v2024_02_15_Preview) @@ -94,6 +99,50 @@ model AzureChatExtensionDataSourceResponseCitation { chunk_id?: string; } +/** The retrieved document. */ +@added(ServiceApiVersions.v2024_05_01_Preview) +model AzureChatExtensionRetrievedDocument { + ...AzureChatExtensionDataSourceResponseCitation; + + /** The search queries used to retrieve the document. */ + @encodedName("application/json", "search_queries") + searchQueries: string[]; + + /** The index of the data source. */ + @encodedName("application/json", "data_source_index") + dataSourceIndex: int32; + + /** The original search score of the retrieved document. */ + @encodedName("application/json", "original_search_score") + originalSearchScore?: float64; + + /** The rerank score of the retrieved document. */ + @encodedName("application/json", "rerank_score") + rerankScore?: float64; + + /** + * Represents the rationale for filtering the document. If the document does not undergo filtering, + * this field will remain unset. + */ + @encodedName("application/json", "filter_reason") + filterReason?: AzureChatExtensionRetrieveDocumentFilterReason; +} + +/** The reason for filtering the retrieved document. */ +#suppress "@azure-tools/typespec-azure-core/no-closed-literal-union" "Enforcing closed set of values per service release" +@added(ServiceApiVersions.v2024_05_01_Preview) +union AzureChatExtensionRetrieveDocumentFilterReason { + /** + * The document is filtered by original search score threshold defined by `strictness` configure. + */ + score: "score", + + /** + * The document is not filtered by original search score threshold, but is filtered by rerank score and `top_n_documents` configure. + */ + rerank: "rerank", +} + @added(ServiceApiVersions.v2024_02_15_Preview) @doc("A representation of the available options for the Azure OpenAI grounding enhancement.") model AzureChatGroundingEnhancementConfiguration { diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/common_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/common_options.tsp index 9924cf7c9f9d..22cc07d0778c 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/common_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/common_options.tsp @@ -38,4 +38,40 @@ alias OnYourDataCommonChatExtensionConfiguration = { @doc("Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.") @encodedName("application/json", "role_information") roleInformation?: string; + + /** + * 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. + */ + @encodedName("application/json", "max_search_queries") + @added(ServiceApiVersions.v2024_05_01_Preview) + maxSearchQueries?: int32; + + /** + * 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. + */ + @encodedName("application/json", "allow_partial_result") + @added(ServiceApiVersions.v2024_05_01_Preview) + allowPartialResult?: boolean = false; + + /** The included properties of the output context. If not specified, the default value is `citations` and `intent`. */ + @encodedName("application/json", "include_contexts") + @added(ServiceApiVersions.v2024_05_01_Preview) + includeContexts?: OnYourDataContextProperty[]; }; + +/** The context property. */ +@added(ServiceApiVersions.v2024_05_01_Preview) +union OnYourDataContextProperty { + string, + + /** The `citations` property. */ + citations: "citations", + + /** The `intent` property. */ + intent: "intent", + + /** The `all_retrieved_documents` property. */ + allRetrievedDocuments: "all_retrieved_documents", +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/vector_search.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/vector_search.tsp index 087d0f6f0016..8fcd2f6603fe 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/vector_search.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/vector_search.tsp @@ -53,8 +53,10 @@ model OnYourDataEndpointVectorizationSource @doc("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.") endpoint: url; + // `authentication` according to the 05-01-preview spec, only supports api-key and data access token auth. @doc("Specifies the authentication options to use when retrieving embeddings from the specified endpoint.") - authentication: OnYourDataAuthenticationOptions; + @added(ServiceApiVersions.v2024_05_01_Preview) + authentication: OnYourDataVectorSearchAuthenticationOptions; } @added(ServiceApiVersions.v2024_02_15_Preview) @@ -70,6 +72,10 @@ model OnYourDataDeploymentNameVectorizationSource @doc("The embedding model deployment name within the same Azure OpenAI resource. This enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.") @encodedName("application/json", "deployment_name") deploymentName: string; + + /** The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models. */ + @added(ServiceApiVersions.v2024_05_01_Preview) + dimensions?: int32; } @added(ServiceApiVersions.v2024_02_15_Preview) @@ -86,3 +92,52 @@ model OnYourDataModelIdVectorizationSource @encodedName("application/json", "model_id") modelId: string; } + +/** The authentication types supported with Azure OpenAI On Your Data vector search. */ +@added(ServiceApiVersions.v2024_05_01_Preview) +union OnYourDataVectorSearchAuthenticationType { + string, + + /** Authentication via API key. */ + apiKey: "api_key", + + /** Authentication via access token. */ + accessToken: "access_token", +} + +/** + * The authentication options for Azure OpenAI On Your Data vector search. + */ +@discriminator("type") +@added(ServiceApiVersions.v2024_05_01_Preview) +model OnYourDataVectorSearchAuthenticationOptions { + /** The type of authentication to use. */ + type: OnYourDataVectorSearchAuthenticationType; +} + +/** + * The authentication options for Azure OpenAI On Your Data when using an API key. + */ +@added(ServiceApiVersions.v2024_05_01_Preview) +model OnYourDataVectorSearchApiKeyAuthenticationOptions + extends OnYourDataVectorSearchAuthenticationOptions { + /** The authentication type of API key. */ + type: OnYourDataVectorSearchAuthenticationType.apiKey; + + /** The API key to use for authentication. */ + key: string; +} + +/** + * The authentication options for Azure OpenAI On Your Data vector search when using access token. + */ +@added(ServiceApiVersions.v2024_05_01_Preview) +model OnYourDataVectorSearchAccessTokenAuthenticationOptions + extends OnYourDataVectorSearchAuthenticationOptions { + /** The authentication type of access token. */ + type: OnYourDataVectorSearchAuthenticationType.accessToken; + + /** The access token to use for authentication. */ + @encodedName("application/json", "access_token") + accessToken: string; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp b/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp index 650083d225b8..e0b920275934 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp @@ -196,6 +196,11 @@ model ImageGenerationPromptFilterResults { @doc("Whether a jailbreak attempt was detected in the prompt.") jailbreak?: ContentFilterDetectionResult; + + /** Information about customer block lists and if something was detected the associated list ID. */ + @encodedName("application/json", "custom_blocklists") + @added(ServiceApiVersions.v2024_05_01_Preview) + customBlocklists?: ContentFilterDetailedResults; } @doc(""" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json index a1af931cdd66..43de460be08c 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json @@ -3631,15 +3631,10 @@ "type": "string", "format": "uri", "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." - }, - "authentication": { - "$ref": "#/definitions/OnYourDataAuthenticationOptions", - "description": "Specifies the authentication options to use when retrieving embeddings from the specified endpoint." } }, "required": [ - "endpoint", - "authentication" + "endpoint" ], "allOf": [ { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json index 456a7ff77380..3586f7590bf8 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json @@ -3662,15 +3662,10 @@ "type": "string", "format": "uri", "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." - }, - "authentication": { - "$ref": "#/definitions/OnYourDataAuthenticationOptions", - "description": "Specifies the authentication options to use when retrieving embeddings from the specified endpoint." } }, "required": [ - "endpoint", - "authentication" + "endpoint" ], "allOf": [ { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json index 0bf9be3b2580..7a140362995b 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json @@ -3756,15 +3756,10 @@ "type": "string", "format": "uri", "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." - }, - "authentication": { - "$ref": "#/definitions/OnYourDataAuthenticationOptions", - "description": "Specifies the authentication options to use when retrieving embeddings from the specified endpoint." } }, "required": [ - "endpoint", - "authentication" + "endpoint" ], "allOf": [ { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_audio_speech.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_audio_speech.json new file mode 100644 index 000000000000..311e4b88a36c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_audio_transcription_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_audio_transcription_object.json new file mode 100644 index 000000000000..6ba2f060b5f5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_audio_transcription_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_audio_transcription_text.json new file mode 100644 index 000000000000..f48298297e37 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_audio_translation_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_audio_translation_object.json new file mode 100644 index 000000000000..fa1b6db54ecb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_audio_translation_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_audio_translation_text.json new file mode 100644 index 000000000000..0e1e8cb85203 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_chat_completions.json new file mode 100644 index 000000000000..786e2993cdde --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_completions.json new file mode 100644 index 000000000000..da5f289b26e4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_embeddings.json new file mode 100644 index 000000000000..9c45cdea0fbc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-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-05-01-preview/examples/generated_extensions_chat_completions_aml_index.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_aml_index.json new file mode 100644 index 000000000000..142771a8da2b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..58d8d4dfbd9f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..7d8799795653 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..4177a2b09465 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json new file mode 100644 index 000000000000..7208385ad243 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json new file mode 100644 index 000000000000..553e75a496be --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_extensions_chat_completions_pinecone.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_extensions_chat_completions_pinecone.json new file mode 100644 index 000000000000..e804ebf0efd3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/examples/generated_image_generation.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/examples/generated_image_generation.json new file mode 100644 index 000000000000..843719ac294c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-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-05-01-preview", + "deploymentId": "", + "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-05-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json new file mode 100644 index 000000000000..24ed1b370093 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json @@ -0,0 +1,4701 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI API", + "version": "2024-05-01-preview", + "description": "Azure OpenAI APIs for completions and search", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/openai", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example:\nhttps://westus.api.cognitive.microsoft.com).", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "api-key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/deployments/{deploymentId}/audio/speech": { + "post": { + "operationId": "GenerateSpeechFromText", + "description": "Generates text-to-speech audio from the input text.", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SpeechGenerationOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "file" + } + }, + "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": { + "Generates text-to-speech audio from the input text.": { + "$ref": "./examples/generated_audio_speech.json" + } + } + } + }, + "/deployments/{deploymentId}/audio/transcriptions": { + "post": { + "operationId": "GetAudioTranscriptionAsPlainText", + "description": "Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the\nwritten language corresponding to the language it was spoken in.", + "produces": [ + "text/plain", + "application/json" + ], + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.file" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.filename" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.language" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.prompt" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.temperature" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.timestampGranularities" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.model" + } + ], + "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 transcribed text and associated metadata from provided spoken audio data.": { + "$ref": "./examples/generated_audio_transcription_text.json" + } + } + } + }, + "/deployments/{deploymentId}/audio/translations": { + "post": { + "operationId": "GetAudioTranslationAsPlainText", + "description": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "produces": [ + "text/plain", + "application/json" + ], + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.file" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.filename" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.responseFormat" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.prompt" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.temperature" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.model" + } + ], + "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 English language transcribed text and associated metadata from provided spoken audio data.": { + "$ref": "./examples/generated_audio_translation_text.json" + } + } + } + }, + "/deployments/{deploymentId}/chat/completions": { + "post": { + "operationId": "GetChatCompletions", + "description": "Gets chat completions for the provided chat messages.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ChatCompletions" + } + }, + "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 a completion based on Azure Cognitive Services data and system-assigned managed identity. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_azure_search_minimum.json" + }, + "Creates a completion based on Azure Cognitive Services image vector data. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_azure_search_image_vector.json" + }, + "Creates a completion based on Azure Cognitive Services vector data and user-assigned managed identity. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_azure_search_advanced.json" + }, + "Creates a completion for the provided AML index. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_aml_index.json" + }, + "Creates a completion for the provided Azure Cosmos DB. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_cosmos_db.json" + }, + "Creates a completion for the provided Elasticsearch. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_elasticsearch.json" + }, + "Creates a completion for the provided Pinecone resource. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_pinecone.json" + }, + "Creates a completion for the provided prompt, parameters and chosen model.": { + "$ref": "./examples/generated_chat_completions.json" + } + } + } + }, + "/deployments/{deploymentId}/completions": { + "post": { + "operationId": "GetCompletions", + "description": "Gets completions for the provided input prompts.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CompletionsOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Completions" + } + }, + "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 a completion for the provided prompt, parameters and chosen model.": { + "$ref": "./examples/generated_completions.json" + } + } + } + }, + "/deployments/{deploymentId}/embeddings": { + "post": { + "operationId": "GetEmbeddings", + "description": "Return the embeddings for a given prompt.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Embeddings" + } + }, + "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": { + "Return the embeddings for a given prompt.": { + "$ref": "./examples/generated_embeddings.json" + } + } + } + }, + "/deployments/{deploymentId}/images/generations": { + "post": { + "operationId": "GetImageGenerations", + "description": "Creates an image given a prompt.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageGenerationOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageGenerations" + } + }, + "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 images given a prompt.": { + "$ref": "./examples/generated_image_generation.json" + } + } + } + } + }, + "x-ms-paths": { + "/deployments/{deploymentId}/audio/transcriptions?_overload=getAudioTranscriptionAsResponseObject": { + "post": { + "operationId": "GetAudioTranscriptionAsResponseObject", + "description": "Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the\nwritten language corresponding to the language it was spoken in.", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.file" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.filename" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.language" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.prompt" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.temperature" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.timestampGranularities" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.model" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AudioTranscription" + } + }, + "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 transcribed text and associated metadata from provided spoken audio data.": { + "$ref": "./examples/generated_audio_transcription_object.json" + } + } + } + }, + "/deployments/{deploymentId}/audio/translations?_overload=getAudioTranslationAsResponseObject": { + "post": { + "operationId": "GetAudioTranslationAsResponseObject", + "description": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.file" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.filename" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.responseFormat" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.prompt" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.temperature" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.model" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AudioTranslation" + } + }, + "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 English language transcribed text and associated metadata from provided spoken audio data.": { + "$ref": "./examples/generated_audio_translation_object.json" + } + } + } + } + }, + "definitions": { + "AudioTaskLabel": { + "type": "string", + "description": "Defines the possible descriptors for available audio operation responses.", + "enum": [ + "transcribe", + "translate" + ], + "x-ms-enum": { + "name": "AudioTaskLabel", + "modelAsString": true, + "values": [ + { + "name": "transcribe", + "value": "transcribe", + "description": "Accompanying response data resulted from an audio transcription task." + }, + { + "name": "translate", + "value": "translate", + "description": "Accompanying response data resulted from an audio translation task." + } + ] + } + }, + "AudioTranscription": { + "type": "object", + "description": "Result information for an operation that transcribed spoken audio into written text.", + "properties": { + "text": { + "type": "string", + "description": "The transcribed text for the provided audio data." + }, + "task": { + "$ref": "#/definitions/AudioTaskLabel", + "description": "The label that describes which operation type generated the accompanying response data." + }, + "language": { + "type": "string", + "description": "The spoken language that was detected in the transcribed audio data.\nThis is expressed as a two-letter ISO-639-1 language code like 'en' or 'fr'." + }, + "duration": { + "type": "number", + "format": "float", + "description": "The total duration of the audio processed to produce accompanying transcription information." + }, + "segments": { + "type": "array", + "description": "A collection of information about the timing, probabilities, and other detail of each processed audio segment.", + "items": { + "$ref": "#/definitions/AudioTranscriptionSegment" + } + }, + "words": { + "type": "array", + "description": "A collection of information about the timing of each processed word.", + "items": { + "$ref": "#/definitions/AudioTranscriptionWord" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "text" + ] + }, + "AudioTranscriptionFormat": { + "type": "string", + "description": "Defines available options for the underlying response format of output transcription information.", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + } + }, + "AudioTranscriptionOptions": { + "type": "object", + "description": "The configuration information for an audio transcription request.", + "properties": { + "file": { + "type": "string", + "format": "byte", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm." + }, + "filename": { + "type": "string", + "description": "The optional filename or descriptive identifier to associate with with the audio data." + }, + "response_format": { + "$ref": "#/definitions/AudioTranscriptionFormat", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "x-ms-client-name": "responseFormat" + }, + "language": { + "type": "string", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription." + }, + "prompt": { + "type": "string", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data." + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + }, + "timestamp_granularities": { + "type": "array", + "description": "The timestamp granularities to populate for this transcription.\n`response_format` must be set `verbose_json` to use timestamp granularities.\nEither or both of these options are supported: `word`, or `segment`.\nNote: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", + "default": [ + "segment" + ], + "items": { + "$ref": "#/definitions/AudioTranscriptionTimestampGranularity" + }, + "x-ms-client-name": "timestampGranularities" + }, + "model": { + "type": "string", + "description": "The model to use for this transcription request." + } + }, + "required": [ + "file" + ] + }, + "AudioTranscriptionSegment": { + "type": "object", + "description": "Extended information about a single segment of transcribed audio data.\nSegments generally represent roughly 5-10 seconds of speech. Segment boundaries typically occur between words but not\nnecessarily sentences.", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The 0-based index of this segment within a transcription." + }, + "start": { + "type": "number", + "format": "float", + "description": "The time at which this segment started relative to the beginning of the transcribed audio." + }, + "end": { + "type": "number", + "format": "float", + "description": "The time at which this segment ended relative to the beginning of the transcribed audio." + }, + "text": { + "type": "string", + "description": "The transcribed text that was part of this audio segment." + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The temperature score associated with this audio segment." + }, + "avg_logprob": { + "type": "number", + "format": "float", + "description": "The average log probability associated with this audio segment.", + "x-ms-client-name": "avgLogprob" + }, + "compression_ratio": { + "type": "number", + "format": "float", + "description": "The compression ratio of this audio segment.", + "x-ms-client-name": "compressionRatio" + }, + "no_speech_prob": { + "type": "number", + "format": "float", + "description": "The probability of no speech detection within this audio segment.", + "x-ms-client-name": "noSpeechProb" + }, + "tokens": { + "type": "array", + "description": "The token IDs matching the transcribed text in this audio segment.", + "items": { + "type": "integer", + "format": "int32" + } + }, + "seek": { + "type": "integer", + "format": "int32", + "description": "The seek position associated with the processing of this audio segment.\nSeek positions are expressed as hundredths of seconds.\nThe model may process several segments from a single seek position, so while the seek position will never represent\na later time than the segment's start, the segment's start may represent a significantly later time than the\nsegment's associated seek position." + } + }, + "required": [ + "id", + "start", + "end", + "text", + "temperature", + "avg_logprob", + "compression_ratio", + "no_speech_prob", + "tokens", + "seek" + ] + }, + "AudioTranscriptionTimestampGranularity": { + "type": "string", + "description": "Defines the timestamp granularities that can be requested on a verbose transcription response.", + "enum": [ + "word", + "segment" + ], + "x-ms-enum": { + "name": "AudioTranscriptionTimestampGranularity", + "modelAsString": true, + "values": [ + { + "name": "word", + "value": "word", + "description": "Indicates that responses should include timing information about each transcribed word. Note that generating word\ntimestamp information will incur additional response latency." + }, + { + "name": "segment", + "value": "segment", + "description": "Indicates that responses should include timing and other information about each transcribed audio segment. Audio\nsegment timestamp information does not incur any additional latency." + } + ] + } + }, + "AudioTranscriptionWord": { + "type": "object", + "description": "Extended information about a single transcribed word, as provided on responses when the 'word' timestamp granularity is provided.", + "properties": { + "word": { + "type": "string", + "description": "The textual content of the word." + }, + "start": { + "type": "number", + "format": "float", + "description": "The start time of the word relative to the beginning of the audio, expressed in seconds." + }, + "end": { + "type": "number", + "format": "float", + "description": "The end time of the word relative to the beginning of the audio, expressed in seconds." + } + }, + "required": [ + "word", + "start", + "end" + ] + }, + "AudioTranslation": { + "type": "object", + "description": "Result information for an operation that translated spoken audio into written text.", + "properties": { + "text": { + "type": "string", + "description": "The translated text for the provided audio data." + }, + "task": { + "$ref": "#/definitions/AudioTaskLabel", + "description": "The label that describes which operation type generated the accompanying response data." + }, + "language": { + "type": "string", + "description": "The spoken language that was detected in the translated audio data.\nThis is expressed as a two-letter ISO-639-1 language code like 'en' or 'fr'." + }, + "duration": { + "type": "number", + "format": "float", + "description": "The total duration of the audio processed to produce accompanying translation information." + }, + "segments": { + "type": "array", + "description": "A collection of information about the timing, probabilities, and other detail of each processed audio segment.", + "items": { + "$ref": "#/definitions/AudioTranslationSegment" + } + } + }, + "required": [ + "text" + ] + }, + "AudioTranslationFormat": { + "type": "string", + "description": "Defines available options for the underlying response format of output translation information.", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + } + }, + "AudioTranslationOptions": { + "type": "object", + "description": "The configuration information for an audio translation request.", + "properties": { + "file": { + "type": "string", + "format": "byte", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm." + }, + "filename": { + "type": "string", + "description": "The optional filename or descriptive identifier to associate with with the audio data." + }, + "response_format": { + "$ref": "#/definitions/AudioTranslationFormat", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "x-ms-client-name": "responseFormat" + }, + "prompt": { + "type": "string", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data." + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + }, + "model": { + "type": "string", + "description": "The model to use for this translation request." + } + }, + "required": [ + "file" + ] + }, + "AudioTranslationSegment": { + "type": "object", + "description": "Extended information about a single segment of translated audio data.\nSegments generally represent roughly 5-10 seconds of speech. Segment boundaries typically occur between words but not\nnecessarily sentences.", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The 0-based index of this segment within a translation." + }, + "start": { + "type": "number", + "format": "float", + "description": "The time at which this segment started relative to the beginning of the translated audio." + }, + "end": { + "type": "number", + "format": "float", + "description": "The time at which this segment ended relative to the beginning of the translated audio." + }, + "text": { + "type": "string", + "description": "The translated text that was part of this audio segment." + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The temperature score associated with this audio segment." + }, + "avg_logprob": { + "type": "number", + "format": "float", + "description": "The average log probability associated with this audio segment.", + "x-ms-client-name": "avgLogprob" + }, + "compression_ratio": { + "type": "number", + "format": "float", + "description": "The compression ratio of this audio segment.", + "x-ms-client-name": "compressionRatio" + }, + "no_speech_prob": { + "type": "number", + "format": "float", + "description": "The probability of no speech detection within this audio segment.", + "x-ms-client-name": "noSpeechProb" + }, + "tokens": { + "type": "array", + "description": "The token IDs matching the translated text in this audio segment.", + "items": { + "type": "integer", + "format": "int32" + } + }, + "seek": { + "type": "integer", + "format": "int32", + "description": "The seek position associated with the processing of this audio segment.\nSeek positions are expressed as hundredths of seconds.\nThe model may process several segments from a single seek position, so while the seek position will never represent\na later time than the segment's start, the segment's start may represent a significantly later time than the\nsegment's associated seek position." + } + }, + "required": [ + "id", + "start", + "end", + "text", + "temperature", + "avg_logprob", + "compression_ratio", + "no_speech_prob", + "tokens", + "seek" + ] + }, + "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." + } + } + }, + "AzureChatEnhancementConfiguration": { + "type": "object", + "description": "A representation of the available Azure OpenAI enhancement configurations.", + "properties": { + "grounding": { + "$ref": "#/definitions/AzureChatGroundingEnhancementConfiguration", + "description": "A representation of the available options for the Azure OpenAI grounding enhancement." + }, + "ocr": { + "$ref": "#/definitions/AzureChatOCREnhancementConfiguration", + "description": "A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement." + } + } + }, + "AzureChatEnhancements": { + "type": "object", + "description": "Represents the output results of Azure enhancements to chat completions, as configured via the matching input provided\nin the request.", + "properties": { + "grounding": { + "$ref": "#/definitions/AzureGroundingEnhancement", + "description": "The grounding enhancement that returns the bounding box of the objects detected in the image." + } + } + }, + "AzureChatExtensionConfiguration": { + "type": "object", + "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.", + "properties": { + "type": { + "$ref": "#/definitions/AzureChatExtensionType", + "description": " The label for the type of an Azure chat extension. This typically corresponds to a matching Azure resource.\n Azure chat extensions are only compatible with Azure OpenAI." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "AzureChatExtensionDataSourceResponseCitation": { + "type": "object", + "description": "A single instance of additional context information available when Azure OpenAI chat extensions are involved\nin the generation of a corresponding chat completions response. This context information is only populated when\nusing an Azure OpenAI request configured to use a matching extension.", + "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." + } + }, + "required": [ + "content" + ] + }, + "AzureChatExtensionRetrieveDocumentFilterReason": { + "type": "string", + "description": "The reason for filtering the retrieved document.", + "enum": [ + "score", + "rerank" + ], + "x-ms-enum": { + "name": "AzureChatExtensionRetrieveDocumentFilterReason", + "modelAsString": false, + "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." + } + ] + } + }, + "AzureChatExtensionRetrievedDocument": { + "type": "object", + "description": "The retrieved document.", + "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." + }, + "search_queries": { + "type": "array", + "description": "The search queries used to retrieve the document.", + "items": { + "type": "string" + }, + "x-ms-client-name": "searchQueries" + }, + "data_source_index": { + "type": "integer", + "format": "int32", + "description": "The index of the data source.", + "x-ms-client-name": "dataSourceIndex" + }, + "original_search_score": { + "type": "number", + "format": "double", + "description": "The original search score of the retrieved document.", + "x-ms-client-name": "originalSearchScore" + }, + "rerank_score": { + "type": "number", + "format": "double", + "description": "The rerank score of the retrieved document.", + "x-ms-client-name": "rerankScore" + }, + "filter_reason": { + "$ref": "#/definitions/AzureChatExtensionRetrieveDocumentFilterReason", + "description": "Represents the rationale for filtering the document. If the document does not undergo filtering,\nthis field will remain unset.", + "x-ms-client-name": "filterReason" + } + }, + "required": [ + "content", + "search_queries", + "data_source_index" + ] + }, + "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_ml_index", + "azure_cosmos_db", + "elasticsearch", + "pinecone" + ], + "x-ms-enum": { + "name": "AzureChatExtensionType", + "modelAsString": true, + "values": [ + { + "name": "azureSearch", + "value": "azure_search", + "description": "Represents the use of Azure AI Search as an Azure OpenAI chat extension." + }, + { + "name": "azureMachineLearningIndex", + "value": "azure_ml_index", + "description": "Represents the use of Azure Machine Learning index 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": "pinecone", + "value": "pinecone", + "description": "Represents the use of Pinecone index as an Azure OpenAI chat extension." + } + ] + } + }, + "AzureChatExtensionsMessageContext": { + "type": "object", + "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.", + "properties": { + "citations": { + "type": "array", + "description": " The contextual information associated with the Azure chat extensions used for a chat completions request.\n These messages describe the data source retrievals, plugin invocations, and other intermediate steps taken in the\n course of generating a chat completions response that was augmented by capabilities from Azure OpenAI chat\n extensions.", + "items": { + "$ref": "#/definitions/AzureChatExtensionDataSourceResponseCitation" + }, + "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": "#/definitions/AzureChatExtensionRetrievedDocument" + }, + "x-ms-client-name": "allRetrievedDocuments", + "x-ms-identifiers": [] + } + } + }, + "AzureChatGroundingEnhancementConfiguration": { + "type": "object", + "description": "A representation of the available options for the Azure OpenAI grounding enhancement.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether the enhancement is enabled." + } + }, + "required": [ + "enabled" + ] + }, + "AzureChatOCREnhancementConfiguration": { + "type": "object", + "description": "A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether the enhancement is enabled." + } + }, + "required": [ + "enabled" + ] + }, + "AzureCosmosDBChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat\nextension.", + "properties": { + "parameters": { + "$ref": "#/definitions/AzureCosmosDBChatExtensionParameters", + "description": "The parameters to use when configuring Azure OpenAI CosmosDB chat extensions." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "azure_cosmos_db" + }, + "AzureCosmosDBChatExtensionParameters": { + "type": "object", + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore. The supported authentication type is ConnectionString.", + "properties": { + "authentication": { + "$ref": "#/definitions/OnYourDataAuthenticationOptions", + "description": "The authentication method to use when accessing the defined data source.\nEach data source type supports a specific set of available authentication methods; please see the documentation of\nthe data source for supported mechanisms.\nIf not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential)\nauthentication." + }, + "top_n_documents": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query.", + "x-ms-client-name": "topNDocuments" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data.", + "x-ms-client-name": "inScope" + }, + "strictness": { + "type": "integer", + "format": "int32", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "minimum": 1, + "maximum": 5 + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.", + "x-ms-client-name": "roleInformation" + }, + "max_search_queries": { + "type": "integer", + "format": "int32", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified,\nthe system will decide the number of queries to send.", + "x-ms-client-name": "maxSearchQueries" + }, + "allow_partial_result": { + "type": "boolean", + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.\nIf not specified, or specified as false, the request will fail if any search query fails.", + "default": false, + "x-ms-client-name": "allowPartialResult" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/definitions/OnYourDataContextProperty" + }, + "x-ms-client-name": "includeContexts" + }, + "database_name": { + "type": "string", + "description": "The MongoDB vCore database name to use with Azure Cosmos DB.", + "x-ms-client-name": "databaseName" + }, + "container_name": { + "type": "string", + "description": "The name of the Azure Cosmos DB resource container.", + "x-ms-client-name": "containerName" + }, + "index_name": { + "type": "string", + "description": "The MongoDB vCore index name to use with Azure Cosmos DB.", + "x-ms-client-name": "indexName" + }, + "fields_mapping": { + "$ref": "#/definitions/AzureCosmosDBFieldMappingOptions", + "description": "Customized field mapping behavior to use when interacting with the search index.", + "x-ms-client-name": "fieldsMapping" + }, + "embedding_dependency": { + "$ref": "#/definitions/OnYourDataVectorizationSource", + "description": "The embedding dependency for vector search.", + "x-ms-client-name": "embeddingDependency" + } + }, + "required": [ + "database_name", + "container_name", + "index_name", + "fields_mapping", + "embedding_dependency" + ] + }, + "AzureCosmosDBFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource.", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title.", + "x-ms-client-name": "titleField" + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL.", + "x-ms-client-name": "urlField" + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath.", + "x-ms-client-name": "filepathField" + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + }, + "x-ms-client-name": "contentFields" + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use.", + "x-ms-client-name": "contentFieldsSeparator" + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + }, + "x-ms-client-name": "vectorFields" + } + }, + "required": [ + "content_fields", + "vector_fields" + ] + }, + "AzureGroundingEnhancement": { + "type": "object", + "description": "The grounding enhancement that returns the bounding box of the objects detected in the image.", + "properties": { + "lines": { + "type": "array", + "description": "The lines of text detected by the grounding enhancement.", + "items": { + "$ref": "#/definitions/AzureGroundingEnhancementLine" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "lines" + ] + }, + "AzureGroundingEnhancementCoordinatePoint": { + "type": "object", + "description": "A representation of a single polygon point as used by the Azure grounding enhancement.", + "properties": { + "x": { + "type": "number", + "format": "float", + "description": "The x-coordinate (horizontal axis) of the point." + }, + "y": { + "type": "number", + "format": "float", + "description": "The y-coordinate (vertical axis) of the point." + } + }, + "required": [ + "x", + "y" + ] + }, + "AzureGroundingEnhancementLine": { + "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", + "description": "The text within the line." + }, + "spans": { + "type": "array", + "description": "An array of spans that represent detected objects and its bounding box information.", + "items": { + "$ref": "#/definitions/AzureGroundingEnhancementLineSpan" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "text", + "spans" + ] + }, + "AzureGroundingEnhancementLineSpan": { + "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", + "format": "int32", + "description": "The character offset within the text where the span begins. This offset is defined as the position of the first\ncharacter of the span, counting from the start of the text as Unicode codepoints." + }, + "length": { + "type": "integer", + "format": "int32", + "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": { + "$ref": "#/definitions/AzureGroundingEnhancementCoordinatePoint" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "text", + "offset", + "length", + "polygon" + ] + }, + "AzureMachineLearningIndexChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Azure Machine Learning vector index when using it as an Azure\nOpenAI chat extension.", + "properties": { + "parameters": { + "$ref": "#/definitions/AzureMachineLearningIndexChatExtensionParameters", + "description": "The parameters for the Azure Machine Learning vector index chat extension." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "azure_ml_index" + }, + "AzureMachineLearningIndexChatExtensionParameters": { + "type": "object", + "description": "Parameters for the Azure Machine Learning vector index chat extension. The supported authentication types are AccessToken, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.", + "properties": { + "authentication": { + "$ref": "#/definitions/OnYourDataAuthenticationOptions", + "description": "The authentication method to use when accessing the defined data source.\nEach data source type supports a specific set of available authentication methods; please see the documentation of\nthe data source for supported mechanisms.\nIf not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential)\nauthentication." + }, + "top_n_documents": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query.", + "x-ms-client-name": "topNDocuments" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data.", + "x-ms-client-name": "inScope" + }, + "strictness": { + "type": "integer", + "format": "int32", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "minimum": 1, + "maximum": 5 + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.", + "x-ms-client-name": "roleInformation" + }, + "max_search_queries": { + "type": "integer", + "format": "int32", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified,\nthe system will decide the number of queries to send.", + "x-ms-client-name": "maxSearchQueries" + }, + "allow_partial_result": { + "type": "boolean", + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.\nIf not specified, or specified as false, the request will fail if any search query fails.", + "default": false, + "x-ms-client-name": "allowPartialResult" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/definitions/OnYourDataContextProperty" + }, + "x-ms-client-name": "includeContexts" + }, + "project_resource_id": { + "type": "string", + "description": "The resource ID of the Azure Machine Learning project.", + "x-ms-client-name": "projectResourceId" + }, + "name": { + "type": "string", + "description": "The Azure Machine Learning vector index name." + }, + "version": { + "type": "string", + "description": "The version of the Azure Machine Learning vector index." + }, + "filter": { + "type": "string", + "description": "Search filter. Only supported if the Azure Machine Learning vector index is of type AzureSearch." + } + }, + "required": [ + "project_resource_id", + "name", + "version" + ] + }, + "AzureSearchChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat\nextension.", + "properties": { + "parameters": { + "$ref": "#/definitions/AzureSearchChatExtensionParameters", + "description": "The parameters to use when configuring Azure Search." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "azure_search" + }, + "AzureSearchChatExtensionParameters": { + "type": "object", + "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. The supported authentication types are APIKey, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.", + "properties": { + "authentication": { + "$ref": "#/definitions/OnYourDataAuthenticationOptions", + "description": "The authentication method to use when accessing the defined data source.\nEach data source type supports a specific set of available authentication methods; please see the documentation of\nthe data source for supported mechanisms.\nIf not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential)\nauthentication." + }, + "top_n_documents": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query.", + "x-ms-client-name": "topNDocuments" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data.", + "x-ms-client-name": "inScope" + }, + "strictness": { + "type": "integer", + "format": "int32", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "minimum": 1, + "maximum": 5 + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.", + "x-ms-client-name": "roleInformation" + }, + "max_search_queries": { + "type": "integer", + "format": "int32", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified,\nthe system will decide the number of queries to send.", + "x-ms-client-name": "maxSearchQueries" + }, + "allow_partial_result": { + "type": "boolean", + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.\nIf not specified, or specified as false, the request will fail if any search query fails.", + "default": false, + "x-ms-client-name": "allowPartialResult" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/definitions/OnYourDataContextProperty" + }, + "x-ms-client-name": "includeContexts" + }, + "endpoint": { + "type": "string", + "format": "uri", + "description": "The absolute endpoint path for the Azure Cognitive Search resource to use." + }, + "index_name": { + "type": "string", + "description": "The name of the index to use as available in the referenced Azure Cognitive Search resource.", + "x-ms-client-name": "indexName" + }, + "fields_mapping": { + "$ref": "#/definitions/AzureSearchIndexFieldMappingOptions", + "description": "Customized field mapping behavior to use when interacting with the search index.", + "x-ms-client-name": "fieldsMapping" + }, + "query_type": { + "$ref": "#/definitions/AzureSearchQueryType", + "description": "The query type to use with Azure Cognitive Search.", + "x-ms-client-name": "queryType" + }, + "semantic_configuration": { + "type": "string", + "description": "The additional semantic configuration for the query.", + "x-ms-client-name": "semanticConfiguration" + }, + "filter": { + "type": "string", + "description": "Search filter." + }, + "embedding_dependency": { + "$ref": "#/definitions/OnYourDataVectorizationSource", + "description": "The embedding dependency for vector search.", + "x-ms-client-name": "embeddingDependency" + } + }, + "required": [ + "endpoint", + "index_name" + ] + }, + "AzureSearchIndexFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Azure Search resource.", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title.", + "x-ms-client-name": "titleField" + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL.", + "x-ms-client-name": "urlField" + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath.", + "x-ms-client-name": "filepathField" + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + }, + "x-ms-client-name": "contentFields" + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use.", + "x-ms-client-name": "contentFieldsSeparator" + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + }, + "x-ms-client-name": "vectorFields" + }, + "image_vector_fields": { + "type": "array", + "description": "The names of fields that represent image vector data.", + "items": { + "type": "string" + }, + "x-ms-client-name": "imageVectorFields" + } + } + }, + "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." + } + ] + } + }, + "ChatChoice": { + "type": "object", + "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "properties": { + "message": { + "$ref": "#/definitions/ChatResponseMessage", + "description": "The chat message for a given chat completions prompt." + }, + "logprobs": { + "type": "object", + "description": "The log probability information for this choice, as enabled via the 'logprobs' request option.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/ChatChoiceLogProbabilityInfo" + } + ] + }, + "index": { + "type": "integer", + "format": "int32", + "description": "The ordered index associated with this chat completions choice." + }, + "finish_reason": { + "$ref": "#/definitions/CompletionsFinishReason", + "description": "The reason that this chat completions choice completed its generated.", + "x-nullable": true, + "x-ms-client-name": "finishReason" + }, + "finish_details": { + "$ref": "#/definitions/ChatFinishDetails", + "description": "The reason the model stopped generating tokens, together with any applicable details.\nThis structured representation replaces 'finish_reason' for some models.", + "x-ms-client-name": "finishDetails" + }, + "delta": { + "$ref": "#/definitions/ChatResponseMessage", + "description": "The delta message content for a streaming response." + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResultsForChoice", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it\nhas been detected, as well as the severity level (very_low, low, medium, high-scale that\ndetermines the intensity and risk level of harmful content) and if it has been filtered or not.", + "x-ms-client-name": "contentFilterResults" + }, + "enhancements": { + "$ref": "#/definitions/AzureChatEnhancements", + "description": "Represents the output results of Azure OpenAI enhancements to chat completions, as configured via the matching input\nprovided in the request. This supplementary information is only available when using Azure OpenAI and only when the\nrequest is configured to use enhancements." + } + }, + "required": [ + "logprobs", + "index", + "finish_reason" + ] + }, + "ChatChoiceLogProbabilityInfo": { + "type": "object", + "description": "Log probability information for a choice, as requested via 'logprobs' and 'top_logprobs'.", + "properties": { + "content": { + "type": "array", + "description": "The list of log probability information entries for the choice's message content tokens, as requested via the 'logprobs' option.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ChatTokenLogProbabilityResult" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "content" + ] + }, + "ChatCompletions": { + "type": "object", + "description": "Representation of the response data from a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier associated with this chat completions response." + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." + }, + "choices": { + "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "items": { + "$ref": "#/definitions/ChatChoice" + }, + "x-ms-identifiers": [] + }, + "model": { + "type": "string", + "description": "The model name used for this completions request." + }, + "prompt_filter_results": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/definitions/ContentFilterResultsForPrompt" + }, + "x-ms-client-name": "promptFilterResults", + "x-ms-identifiers": [] + }, + "system_fingerprint": { + "type": "string", + "description": "Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that\nmight impact determinism.", + "x-ms-client-name": "systemFingerprint" + }, + "usage": { + "$ref": "#/definitions/CompletionsUsage", + "description": "Usage information for tokens processed and generated as part of this completions operation." + } + }, + "required": [ + "id", + "created", + "choices", + "usage" + ] + }, + "ChatCompletionsFunctionToolCall": { + "type": "object", + "description": "A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\na function invocation needed for a subsequent chat completions request to resolve.", + "properties": { + "function": { + "$ref": "#/definitions/FunctionCall", + "description": "The details of the function invocation requested by the tool call." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsToolCall" + } + ], + "x-ms-discriminator-value": "function" + }, + "ChatCompletionsFunctionToolDefinition": { + "type": "object", + "description": "The definition information for a chat completions function tool that can call a function in response to a tool call.", + "properties": { + "function": { + "$ref": "#/definitions/FunctionDefinition", + "description": "The function definition details for the function tool." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsToolDefinition" + } + ], + "x-ms-discriminator-value": "function" + }, + "ChatCompletionsJsonResponseFormat": { + "type": "object", + "description": "A response format for Chat Completions that restricts responses to emitting valid JSON objects.", + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsResponseFormat" + } + ], + "x-ms-discriminator-value": "json_object" + }, + "ChatCompletionsOptions": { + "type": "object", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "messages": { + "type": "array", + "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", + "items": { + "$ref": "#/definitions/ChatRequestMessage" + }, + "x-ms-identifiers": [] + }, + "functions": { + "type": "array", + "description": "A list of functions the model may generate JSON inputs for.", + "items": { + "$ref": "#/definitions/FunctionDefinition" + }, + "x-ms-identifiers": [] + }, + "function_call": { + "description": "Controls how the model responds to function calls. \"none\" means the model does not call a function,\nand responds to the end-user. \"auto\" means the model can pick between an end-user or calling a function.\n Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n \"none\" is the default when no functions are present. \"auto\" is the default if functions are present.", + "x-ms-client-name": "functionCall" + }, + "max_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tokens to generate.", + "x-ms-client-name": "maxTokens" + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature to use that controls the apparent creativity of generated completions.\nHigher values will make output more random while lower values will make results more focused\nand deterministic.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict." + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature called nucleus sampling. This value causes the\nmodel to consider the results of tokens with the provided probability mass. As an example, a\nvalue of 0.15 will cause only the tokens comprising the top 15% of probability mass to be\nconsidered.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", + "x-ms-client-name": "topP" + }, + "logit_bias": { + "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-ms-client-name": "logitBias" + }, + "user": { + "type": "string", + "description": "An identifier for the caller or end user of the operation. This may be used for tracking\nor rate-limiting purposes." + }, + "n": { + "type": "integer", + "format": "int32", + "description": "The number of chat completions choices that should be generated for a chat completions\nresponse.\nBecause this setting can generate many completions, it may quickly consume your token quota.\nUse carefully and ensure reasonable settings for max_tokens and stop." + }, + "stop": { + "type": "array", + "description": "A collection of textual sequences that will end completions generation.", + "items": { + "type": "string" + } + }, + "presence_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their existing\npresence in generated text.\nPositive values will make tokens less likely to appear when they already exist and increase the\nmodel's likelihood to output new topics.", + "x-ms-client-name": "presencePenalty" + }, + "frequency_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their cumulative\nfrequency in generated text.\nPositive values will make tokens less likely to appear as their frequency increases and\ndecrease the likelihood of the model repeating the same statements verbatim.", + "x-ms-client-name": "frequencyPenalty" + }, + "stream": { + "type": "boolean", + "description": "A value indicating whether chat completions should be streamed for this request." + }, + "model": { + "type": "string", + "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." + }, + "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": "#/definitions/AzureChatExtensionConfiguration" + }, + "x-ms-client-name": "dataSources", + "x-ms-identifiers": [] + }, + "enhancements": { + "$ref": "#/definitions/AzureChatEnhancementConfiguration", + "description": "If provided, the configuration options for available Azure OpenAI chat enhancements." + }, + "seed": { + "type": "integer", + "format": "int64", + "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the\nsystem_fingerprint response parameter to monitor changes in the backend.\"" + }, + "logprobs": { + "type": "boolean", + "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`. This option is currently not available on the `gpt-4-vision-preview` model.", + "default": false, + "x-nullable": true + }, + "top_logprobs": { + "type": "integer", + "format": "int32", + "description": "An integer between 0 and 5 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.", + "x-nullable": true + }, + "response_format": { + "$ref": "#/definitions/ChatCompletionsResponseFormat", + "description": "An object specifying the format that the model must output. Used to enable JSON mode.", + "x-ms-client-name": "responseFormat" + }, + "tools": { + "type": "array", + "description": "The available tool definitions that the chat completions request can use, including caller-defined functions.", + "items": { + "$ref": "#/definitions/ChatCompletionsToolDefinition" + }, + "x-ms-identifiers": [] + }, + "tool_choice": { + "description": "If specified, the model will configure which of the provided tools it can use for the chat completions response.", + "x-ms-client-name": "toolChoice" + } + }, + "required": [ + "messages" + ] + }, + "ChatCompletionsResponseFormat": { + "type": "object", + "description": "An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON\nmode.", + "properties": { + "type": { + "type": "string", + "description": "The discriminated type for the response format." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ChatCompletionsTextResponseFormat": { + "type": "object", + "description": "The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response\ncontent that adheres to a specific schema.", + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsResponseFormat" + } + ], + "x-ms-discriminator-value": "text" + }, + "ChatCompletionsToolCall": { + "type": "object", + "description": "An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested\nchat completion.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + }, + "id": { + "type": "string", + "description": "The ID of the tool call." + } + }, + "discriminator": "type", + "required": [ + "type", + "id" + ] + }, + "ChatCompletionsToolDefinition": { + "type": "object", + "description": "An abstract representation of a tool that can be used by the model to improve a chat completions response.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ChatFinishDetails": { + "type": "object", + "description": "An abstract representation of structured information about why a chat completions response terminated.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ChatRequestAssistantMessage": { + "type": "object", + "description": "A request chat message representing response or action from the assistant.", + "properties": { + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + }, + "name": { + "type": "string", + "description": "An optional name for the participant." + }, + "tool_calls": { + "type": "array", + "description": "The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat\ncompletions request to resolve as configured.", + "items": { + "$ref": "#/definitions/ChatCompletionsToolCall" + }, + "x-ms-client-name": "toolCalls" + }, + "function_call": { + "$ref": "#/definitions/FunctionCall", + "description": "The function call that must be resolved and have its output appended to subsequent input messages for the chat\ncompletions request to resolve as configured.", + "x-ms-client-name": "functionCall" + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "assistant" + }, + "ChatRequestFunctionMessage": { + "type": "object", + "description": "A request chat message representing requested output from a configured function.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function that was called to produce output." + }, + "content": { + "type": "string", + "description": "The output of the function as requested by the function call.", + "x-nullable": true + } + }, + "required": [ + "name", + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "function" + }, + "ChatRequestMessage": { + "type": "object", + "description": "An abstract representation of a chat message as provided in a request.", + "properties": { + "role": { + "$ref": "#/definitions/ChatRole", + "description": "The chat role associated with this message." + } + }, + "discriminator": "role", + "required": [ + "role" + ] + }, + "ChatRequestSystemMessage": { + "type": "object", + "description": "A request chat message containing system instructions that influence how the model will generate a chat completions\nresponse.", + "properties": { + "content": { + "type": "string", + "description": "The contents of the system message." + }, + "name": { + "type": "string", + "description": "An optional name for the participant." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "system" + }, + "ChatRequestToolMessage": { + "type": "object", + "description": "A request chat message representing requested output from a configured tool.", + "properties": { + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + }, + "tool_call_id": { + "type": "string", + "description": "The ID of the tool call resolved by the provided content.", + "x-ms-client-name": "toolCallId" + } + }, + "required": [ + "content", + "tool_call_id" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "tool" + }, + "ChatRequestUserMessage": { + "type": "object", + "description": "A request chat message representing user input to the assistant.", + "properties": { + "content": { + "description": "The contents of the user message, with available input types varying by selected model." + }, + "name": { + "type": "string", + "description": "An optional name for the participant." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "user" + }, + "ChatResponseMessage": { + "type": "object", + "description": "A representation of a chat message as received in a response.", + "properties": { + "role": { + "$ref": "#/definitions/ChatRole", + "description": "The chat role associated with the message." + }, + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + }, + "tool_calls": { + "type": "array", + "description": "The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat\ncompletions request to resolve as configured.", + "items": { + "$ref": "#/definitions/ChatCompletionsToolCall" + }, + "x-ms-client-name": "toolCalls" + }, + "function_call": { + "$ref": "#/definitions/FunctionCall", + "description": "The function call that must be resolved and have its output appended to subsequent input messages for the chat\ncompletions request to resolve as configured.", + "x-ms-client-name": "functionCall" + }, + "context": { + "$ref": "#/definitions/AzureChatExtensionsMessageContext", + "description": "If Azure OpenAI chat extensions are configured, this array represents the incremental steps performed by those\nextensions while processing the chat completions request." + } + }, + "required": [ + "role", + "content" + ] + }, + "ChatRole": { + "type": "string", + "description": "A description of the intended purpose of a message within a chat completions interaction.", + "enum": [ + "system", + "assistant", + "user", + "function", + "tool" + ], + "x-ms-enum": { + "name": "ChatRole", + "modelAsString": true, + "values": [ + { + "name": "system", + "value": "system", + "description": "The role that instructs or sets the behavior of the assistant." + }, + { + "name": "assistant", + "value": "assistant", + "description": "The role that provides responses to system-instructed, user-prompted input." + }, + { + "name": "user", + "value": "user", + "description": "The role that provides input for chat completions." + }, + { + "name": "function", + "value": "function", + "description": "The role that provides function results for chat completions." + }, + { + "name": "tool", + "value": "tool", + "description": "The role that represents extension tool activity within a chat completions operation." + } + ] + } + }, + "ChatTokenLogProbabilityInfo": { + "type": "object", + "description": "A representation of the log probability information for a single message content token.", + "properties": { + "token": { + "type": "string", + "description": "The message content token." + }, + "logprob": { + "type": "number", + "format": "float", + "description": "The log probability of the message content token." + }, + "bytes": { + "type": "array", + "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.", + "x-nullable": true, + "items": { + "type": "integer", + "format": "int32" + } + } + }, + "required": [ + "token", + "logprob", + "bytes" + ] + }, + "ChatTokenLogProbabilityResult": { + "type": "object", + "description": "A representation of the log probability information for a single content token, including a list of most likely tokens if 'top_logprobs' were requested.", + "properties": { + "token": { + "type": "string", + "description": "The message content token." + }, + "logprob": { + "type": "number", + "format": "float", + "description": "The log probability of the message content token." + }, + "bytes": { + "type": "array", + "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.", + "x-nullable": true, + "items": { + "type": "integer", + "format": "int32" + } + }, + "top_logprobs": { + "type": "array", + "description": "The list of most likely tokens and their log probability information, as requested via 'top_logprobs'.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ChatTokenLogProbabilityInfo" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "token", + "logprob", + "bytes", + "top_logprobs" + ] + }, + "Choice": { + "type": "object", + "description": "The representation of a single prompt completion as part of an overall completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "properties": { + "text": { + "type": "string", + "description": "The generated text for a given completions prompt." + }, + "index": { + "type": "integer", + "format": "int32", + "description": "The ordered index associated with this completions choice." + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResultsForChoice", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it\nhas been detected, as well as the severity level (very_low, low, medium, high-scale that\ndetermines the intensity and risk level of harmful content) and if it has been filtered or not.", + "x-ms-client-name": "contentFilterResults" + }, + "logprobs": { + "type": "object", + "description": "The log probabilities model for tokens associated with this completions choice.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/CompletionsLogProbabilityModel" + } + ] + }, + "finish_reason": { + "$ref": "#/definitions/CompletionsFinishReason", + "description": "Reason for finishing", + "x-nullable": true, + "x-ms-client-name": "finishReason" + } + }, + "required": [ + "text", + "index", + "logprobs", + "finish_reason" + ] + }, + "Completions": { + "type": "object", + "description": "Representation of the response data from a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier associated with this completions response." + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." + }, + "prompt_filter_results": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/definitions/ContentFilterResultsForPrompt" + }, + "x-ms-client-name": "promptFilterResults", + "x-ms-identifiers": [] + }, + "choices": { + "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "items": { + "$ref": "#/definitions/Choice" + }, + "x-ms-identifiers": [] + }, + "usage": { + "$ref": "#/definitions/CompletionsUsage", + "description": "Usage information for tokens processed and generated as part of this completions operation." + } + }, + "required": [ + "id", + "created", + "choices", + "usage" + ] + }, + "CompletionsFinishReason": { + "type": "string", + "description": "Representation of the manner in which a completions response concluded.", + "enum": [ + "stop", + "length", + "content_filter", + "function_call", + "tool_calls" + ], + "x-ms-enum": { + "name": "CompletionsFinishReason", + "modelAsString": true, + "values": [ + { + "name": "stopped", + "value": "stop", + "description": "Completions ended normally and reached its end of token generation." + }, + { + "name": "tokenLimitReached", + "value": "length", + "description": "Completions exhausted available token limits before generation could complete." + }, + { + "name": "contentFiltered", + "value": "content_filter", + "description": "Completions generated a response that was identified as potentially sensitive per content\nmoderation policies." + }, + { + "name": "functionCall", + "value": "function_call", + "description": "Completion ended normally, with the model requesting a function to be called." + }, + { + "name": "toolCalls", + "value": "tool_calls", + "description": "Completion ended with the model calling a provided tool for output." + } + ] + } + }, + "CompletionsLogProbabilityModel": { + "type": "object", + "description": "Representation of a log probabilities model for a completions generation.", + "properties": { + "tokens": { + "type": "array", + "description": "The textual forms of tokens evaluated in this probability model.", + "items": { + "type": "string" + } + }, + "token_logprobs": { + "type": "array", + "description": "A collection of log probability values for the tokens in this completions data.", + "items": { + "type": "number", + "format": "float", + "x-nullable": true + }, + "x-ms-client-name": "tokenLogprobs" + }, + "top_logprobs": { + "type": "array", + "description": "A mapping of tokens to maximum log probability values in this completions data.", + "items": { + "type": "object", + "additionalProperties": { + "format": "float", + "type": "number", + "x-nullable": true + } + }, + "x-ms-client-name": "topLogprobs", + "x-ms-identifiers": [] + }, + "text_offset": { + "type": "array", + "description": "The text offsets associated with tokens in this completions data.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-ms-client-name": "textOffset" + } + }, + "required": [ + "tokens", + "token_logprobs", + "top_logprobs", + "text_offset" + ] + }, + "CompletionsOptions": { + "type": "object", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "prompt": { + "type": "array", + "description": "The prompts to generate completions from.", + "items": { + "type": "string" + } + }, + "max_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tokens to generate.", + "x-ms-client-name": "maxTokens" + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature to use that controls the apparent creativity of generated completions.\nHigher values will make output more random while lower values will make results more focused\nand deterministic.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict." + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature called nucleus sampling. This value causes the\nmodel to consider the results of tokens with the provided probability mass. As an example, a\nvalue of 0.15 will cause only the tokens comprising the top 15% of probability mass to be\nconsidered.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", + "x-ms-client-name": "topP" + }, + "logit_bias": { + "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-ms-client-name": "logitBias" + }, + "user": { + "type": "string", + "description": "An identifier for the caller or end user of the operation. This may be used for tracking\nor rate-limiting purposes." + }, + "n": { + "type": "integer", + "format": "int32", + "description": "The number of completions choices that should be generated per provided prompt as part of an\noverall completions response.\nBecause this setting can generate many completions, it may quickly consume your token quota.\nUse carefully and ensure reasonable settings for max_tokens and stop." + }, + "logprobs": { + "type": "integer", + "format": "int32", + "description": "A value that controls the emission of log probabilities for the provided number of most likely\ntokens within a completions response." + }, + "suffix": { + "type": "string", + "description": "The suffix that comes after a completion of inserted text" + }, + "echo": { + "type": "boolean", + "description": "A value specifying whether completions responses should include input prompts as prefixes to\ntheir generated output." + }, + "stop": { + "type": "array", + "description": "A collection of textual sequences that will end completions generation.", + "items": { + "type": "string" + } + }, + "presence_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their existing\npresence in generated text.\nPositive values will make tokens less likely to appear when they already exist and increase the\nmodel's likelihood to output new topics.", + "x-ms-client-name": "presencePenalty" + }, + "frequency_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their cumulative\nfrequency in generated text.\nPositive values will make tokens less likely to appear as their frequency increases and\ndecrease the likelihood of the model repeating the same statements verbatim.", + "x-ms-client-name": "frequencyPenalty" + }, + "best_of": { + "type": "integer", + "format": "int32", + "description": "A value that controls how many completions will be internally generated prior to response\nformulation.\nWhen used together with n, best_of controls the number of candidate completions and must be\ngreater than n.\nBecause this setting can generate many completions, it may quickly consume your token quota.\nUse carefully and ensure reasonable settings for max_tokens and stop.", + "x-ms-client-name": "bestOf" + }, + "stream": { + "type": "boolean", + "description": "A value indicating whether chat completions should be streamed for this request." + }, + "model": { + "type": "string", + "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." + } + }, + "required": [ + "prompt" + ] + }, + "CompletionsUsage": { + "type": "object", + "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", + "properties": { + "completion_tokens": { + "type": "integer", + "format": "int32", + "description": "The number of tokens generated across all completions emissions.", + "x-ms-client-name": "completionTokens" + }, + "prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "The number of tokens in the provided prompts for the completions request.", + "x-ms-client-name": "promptTokens" + }, + "total_tokens": { + "type": "integer", + "format": "int32", + "description": "The total number of tokens processed for the completions request and response.", + "x-ms-client-name": "totalTokens" + } + }, + "required": [ + "completion_tokens", + "prompt_tokens", + "total_tokens" + ] + }, + "ContentFilterBlocklistIdResult": { + "type": "object", + "description": "Represents the outcome of an evaluation against a custom blocklist as performed by content filtering.", + "properties": { + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + }, + "id": { + "type": "string", + "description": "The ID of the custom blocklist evaluated." + } + }, + "required": [ + "filtered", + "id" + ] + }, + "ContentFilterCitedDetectionResult": { + "type": "object", + "description": "Represents the outcome of a detection operation against protected resources as performed by content filtering.", + "properties": { + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + }, + "detected": { + "type": "boolean", + "description": "A value indicating whether detection occurred, irrespective of severity or whether the content was filtered." + }, + "URL": { + "type": "string", + "format": "uri", + "description": "The internet location associated with the detection.", + "x-ms-client-name": "url" + }, + "license": { + "type": "string", + "description": "The license description associated with the detection." + } + }, + "required": [ + "filtered", + "detected", + "license" + ] + }, + "ContentFilterDetailedResults": { + "type": "object", + "description": "Represents a structured collection of result details for content filtering.", + "properties": { + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + }, + "details": { + "type": "array", + "description": "The collection of detailed blocklist result information.", + "items": { + "$ref": "#/definitions/ContentFilterBlocklistIdResult" + } + } + }, + "required": [ + "filtered", + "details" + ] + }, + "ContentFilterDetectionResult": { + "type": "object", + "description": "Represents the outcome of a detection operation performed by content filtering.", + "properties": { + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + }, + "detected": { + "type": "boolean", + "description": "A value indicating whether detection occurred, irrespective of severity or whether the content was filtered." + } + }, + "required": [ + "filtered", + "detected" + ] + }, + "ContentFilterResult": { + "type": "object", + "description": "Information about filtered content severity level and if it has been filtered or not.", + "properties": { + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + }, + "severity": { + "$ref": "#/definitions/ContentFilterSeverity", + "description": "Ratings for the intensity and risk level of filtered content." + } + }, + "required": [ + "filtered", + "severity" + ] + }, + "ContentFilterResultDetailsForPrompt": { + "type": "object", + "description": "Information about content filtering evaluated against input data to Azure OpenAI.", + "properties": { + "sexual": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." + }, + "violence": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to hurt, injure, damage, or\nkill someone or something; describes weapons, etc." + }, + "hate": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language attacks or uses that include pejorative or discriminatory language\nwith reference to a person or identity group on the basis of certain differentiating\nattributes of these groups including but not limited to race, ethnicity, nationality,\ngender identity and expression, sexual orientation, religion, immigration status, ability\nstatus, personal appearance, and body size." + }, + "self_harm": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to purposely hurt, injure,\nor damage one’s body, or kill oneself.", + "x-ms-client-name": "selfHarm" + }, + "profanity": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Describes whether profanity was detected." + }, + "custom_blocklists": { + "$ref": "#/definitions/ContentFilterDetailedResults", + "description": "Describes detection results against configured custom blocklists.", + "x-ms-client-name": "customBlocklists" + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Describes an error returned if the content filtering system is\ndown or otherwise unable to complete the operation in time." + }, + "jailbreak": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Whether a jailbreak attempt was detected in the prompt." + }, + "indirect_attack": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Whether an indirect attack was detected in the prompt.", + "x-ms-client-name": "indirectAttack" + } + } + }, + "ContentFilterResultsForChoice": { + "type": "object", + "description": "Information about content filtering evaluated against generated model output.", + "properties": { + "sexual": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." + }, + "violence": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to hurt, injure, damage, or\nkill someone or something; describes weapons, etc." + }, + "hate": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language attacks or uses that include pejorative or discriminatory language\nwith reference to a person or identity group on the basis of certain differentiating\nattributes of these groups including but not limited to race, ethnicity, nationality,\ngender identity and expression, sexual orientation, religion, immigration status, ability\nstatus, personal appearance, and body size." + }, + "self_harm": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to purposely hurt, injure,\nor damage one’s body, or kill oneself.", + "x-ms-client-name": "selfHarm" + }, + "profanity": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Describes whether profanity was detected." + }, + "custom_blocklists": { + "$ref": "#/definitions/ContentFilterDetailedResults", + "description": "Describes detection results against configured custom blocklists.", + "x-ms-client-name": "customBlocklists" + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Describes an error returned if the content filtering system is\ndown or otherwise unable to complete the operation in time." + }, + "protected_material_text": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Information about detection of protected text material.", + "x-ms-client-name": "protectedMaterialText" + }, + "protected_material_code": { + "$ref": "#/definitions/ContentFilterCitedDetectionResult", + "description": "Information about detection of protected code material.", + "x-ms-client-name": "protectedMaterialCode" + } + } + }, + "ContentFilterResultsForPrompt": { + "type": "object", + "description": "Content filtering results for a single prompt in the request.", + "properties": { + "prompt_index": { + "type": "integer", + "format": "int32", + "description": "The index of this prompt in the set of prompt results", + "x-ms-client-name": "promptIndex" + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResultDetailsForPrompt", + "description": "Content filtering results for this prompt", + "x-ms-client-name": "contentFilterResults" + } + }, + "required": [ + "prompt_index", + "content_filter_results" + ] + }, + "ContentFilterSeverity": { + "type": "string", + "description": "Ratings for the intensity and risk level of harmful content.", + "enum": [ + "safe", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "ContentFilterSeverity", + "modelAsString": true, + "values": [ + { + "name": "safe", + "value": "safe", + "description": "Content may be related to violence, self-harm, sexual, or hate categories but the terms\nare used in general, journalistic, scientific, medical, and similar professional contexts,\nwhich are appropriate for most audiences." + }, + { + "name": "low", + "value": "low", + "description": "Content that expresses prejudiced, judgmental, or opinionated views, includes offensive\nuse of language, stereotyping, use cases exploring a fictional world (for example, gaming,\nliterature) and depictions at low intensity." + }, + { + "name": "medium", + "value": "medium", + "description": "Content that uses offensive, insulting, mocking, intimidating, or demeaning language\ntowards specific identity groups, includes depictions of seeking and executing harmful\ninstructions, fantasies, glorification, promotion of harm at medium intensity." + }, + { + "name": "high", + "value": "high", + "description": "Content that displays explicit and severe harmful instructions, actions,\ndamage, or abuse; includes endorsement, glorification, or promotion of severe\nharmful acts, extreme or illegal forms of harm, radicalization, or non-consensual\npower exchange or abuse." + } + ] + } + }, + "ElasticsearchChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat\nextension.", + "properties": { + "parameters": { + "$ref": "#/definitions/ElasticsearchChatExtensionParameters", + "description": "The parameters to use when configuring Elasticsearch®." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "elasticsearch" + }, + "ElasticsearchChatExtensionParameters": { + "type": "object", + "description": "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. The supported authentication types are KeyAndKeyId and EncodedAPIKey.", + "properties": { + "authentication": { + "$ref": "#/definitions/OnYourDataAuthenticationOptions", + "description": "The authentication method to use when accessing the defined data source.\nEach data source type supports a specific set of available authentication methods; please see the documentation of\nthe data source for supported mechanisms.\nIf not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential)\nauthentication." + }, + "top_n_documents": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query.", + "x-ms-client-name": "topNDocuments" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data.", + "x-ms-client-name": "inScope" + }, + "strictness": { + "type": "integer", + "format": "int32", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "minimum": 1, + "maximum": 5 + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.", + "x-ms-client-name": "roleInformation" + }, + "max_search_queries": { + "type": "integer", + "format": "int32", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified,\nthe system will decide the number of queries to send.", + "x-ms-client-name": "maxSearchQueries" + }, + "allow_partial_result": { + "type": "boolean", + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.\nIf not specified, or specified as false, the request will fail if any search query fails.", + "default": false, + "x-ms-client-name": "allowPartialResult" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/definitions/OnYourDataContextProperty" + }, + "x-ms-client-name": "includeContexts" + }, + "endpoint": { + "type": "string", + "format": "uri", + "description": "The endpoint of Elasticsearch®." + }, + "index_name": { + "type": "string", + "description": "The index name of Elasticsearch®.", + "x-ms-client-name": "indexName" + }, + "fields_mapping": { + "$ref": "#/definitions/ElasticsearchIndexFieldMappingOptions", + "description": "The index field mapping options of Elasticsearch®.", + "x-ms-client-name": "fieldsMapping" + }, + "query_type": { + "$ref": "#/definitions/ElasticsearchQueryType", + "description": "The query type of Elasticsearch®.", + "x-ms-client-name": "queryType" + }, + "embedding_dependency": { + "$ref": "#/definitions/OnYourDataVectorizationSource", + "description": "The embedding dependency for vector search.", + "x-ms-client-name": "embeddingDependency" + } + }, + "required": [ + "endpoint", + "index_name" + ] + }, + "ElasticsearchIndexFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Elasticsearch® resource.", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title.", + "x-ms-client-name": "titleField" + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL.", + "x-ms-client-name": "urlField" + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath.", + "x-ms-client-name": "filepathField" + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + }, + "x-ms-client-name": "contentFields" + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use.", + "x-ms-client-name": "contentFieldsSeparator" + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + }, + "x-ms-client-name": "vectorFields" + } + } + }, + "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." + } + ] + } + }, + "EmbeddingItem": { + "type": "object", + "description": "Representation of a single embeddings relatedness comparison.", + "properties": { + "embedding": { + "type": "array", + "description": "List of embeddings value for the input prompt. These represent a measurement of the\nvector-based relatedness of the provided input.", + "items": { + "type": "number", + "format": "float" + } + }, + "index": { + "type": "integer", + "format": "int32", + "description": "Index of the prompt to which the EmbeddingItem corresponds." + } + }, + "required": [ + "embedding", + "index" + ] + }, + "Embeddings": { + "type": "object", + "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "properties": { + "data": { + "type": "array", + "description": "Embedding values for the prompts submitted in the request.", + "items": { + "$ref": "#/definitions/EmbeddingItem" + }, + "x-ms-identifiers": [] + }, + "usage": { + "$ref": "#/definitions/EmbeddingsUsage", + "description": "Usage counts for tokens input using the embeddings API." + } + }, + "required": [ + "data", + "usage" + ] + }, + "EmbeddingsOptions": { + "type": "object", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "properties": { + "user": { + "type": "string", + "description": "An identifier for the caller or end user of the operation. This may be used for tracking\nor rate-limiting purposes." + }, + "model": { + "type": "string", + "description": "The model name to provide as part of this embeddings request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." + }, + "input": { + "type": "array", + "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", + "items": { + "type": "string" + } + }, + "encoding_format": { + "type": "string", + "description": "The response encoding format to use for embedding data.", + "default": "float", + "enum": [ + "float", + "base64" + ], + "x-ms-enum": { + "name": "EmbeddingEncodingFormat", + "modelAsString": true, + "values": [ + { + "name": "float", + "value": "float", + "description": "Specifies that responses should provide arrays of floats for each embedding." + }, + { + "name": "base64", + "value": "base64", + "description": "Specifies that responses should provide a base64-encoded string for each embedding." + } + ] + }, + "x-ms-client-name": "encodingFormat" + }, + "dimensions": { + "type": "integer", + "format": "int32", + "description": "The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models." + }, + "input_type": { + "type": "string", + "description": "When using Azure OpenAI, specifies the input type to use for embedding search.", + "x-ms-client-name": "inputType" + } + }, + "required": [ + "input" + ] + }, + "EmbeddingsUsage": { + "type": "object", + "description": "Measurement of the amount of tokens used in this request and response.", + "properties": { + "prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "Number of tokens sent in the original request.", + "x-ms-client-name": "promptTokens" + }, + "total_tokens": { + "type": "integer", + "format": "int32", + "description": "Total number of tokens transacted in this request/response.", + "x-ms-client-name": "totalTokens" + } + }, + "required": [ + "prompt_tokens", + "total_tokens" + ] + }, + "FunctionCall": { + "type": "object", + "description": "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.\nNote that the model does not always generate valid JSON, and may hallucinate parameters\nnot defined by your function schema. Validate the arguments in your code before calling\nyour function." + } + }, + "required": [ + "name", + "arguments" + ] + }, + "FunctionDefinition": { + "type": "object", + "description": "The definition of a caller-specified function that chat completions may invoke in response to matching user input.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to be called." + }, + "description": { + "type": "string", + "description": "A description of what the function does. The model will use this description when selecting the function and\ninterpreting its parameters." + }, + "parameters": { + "description": "The parameters the function accepts, described as a JSON Schema object." + } + }, + "required": [ + "name" + ] + }, + "ImageGenerationContentFilterResults": { + "type": "object", + "description": "Describes the content filtering result for the image generation request.", + "properties": { + "sexual": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." + }, + "violence": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to hurt, injure, damage, or\nkill someone or something; describes weapons, etc." + }, + "hate": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language attacks or uses that include pejorative or discriminatory language\nwith reference to a person or identity group on the basis of certain differentiating\nattributes of these groups including but not limited to race, ethnicity, nationality,\ngender identity and expression, sexual orientation, religion, immigration status, ability\nstatus, personal appearance, and body size." + }, + "self_harm": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to purposely hurt, injure,\nor damage one’s body, or kill oneself.", + "x-ms-client-name": "selfHarm" + } + } + }, + "ImageGenerationData": { + "type": "object", + "description": "A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image\nmay be retrieved.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "The URL that provides temporary access to download the generated image." + }, + "b64_json": { + "type": "string", + "description": "The complete data for an image, represented as a base64-encoded string.", + "x-ms-client-name": "base64Data" + }, + "content_filter_results": { + "$ref": "#/definitions/ImageGenerationContentFilterResults", + "description": "Information about the content filtering results.", + "x-ms-client-name": "contentFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The final prompt used by the model to generate the image.\nOnly provided with dall-3-models and only when revisions were made to the prompt.", + "x-ms-client-name": "revisedPrompt" + }, + "prompt_filter_results": { + "$ref": "#/definitions/ImageGenerationPromptFilterResults", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if\nit has been detected, as well as the severity level (very_low, low, medium, high-scale\nthat determines the intensity and risk level of harmful content) and if it has been\nfiltered or not. Information about jailbreak content and profanity, if it has been detected,\nand if it has been filtered or not. And information about customer block list, if it has\nbeen filtered and its id.", + "x-ms-client-name": "promptFilterResults" + } + } + }, + "ImageGenerationOptions": { + "type": "object", + "description": "Represents the request data used to generate images.", + "properties": { + "model": { + "type": "string", + "description": "The model name or Azure OpenAI model deployment name to use for image generation. If not specified, dall-e-2 will be\ninferred as a default." + }, + "prompt": { + "type": "string", + "description": "A description of the desired images." + }, + "n": { + "type": "integer", + "format": "int32", + "description": "The number of images to generate.\nDall-e-2 models support values between 1 and 10.\nDall-e-3 models only support a value of 1.", + "default": 1 + }, + "size": { + "type": "string", + "description": "The desired dimensions for generated images.\nDall-e-2 models support 256x256, 512x512, or 1024x1024.\nDall-e-3 models support 1024x1024, 1792x1024, or 1024x1792.", + "default": "1024x1024", + "enum": [ + "256x256", + "512x512", + "1024x1024", + "1792x1024", + "1024x1792" + ], + "x-ms-enum": { + "name": "ImageSize", + "modelAsString": true, + "values": [ + { + "name": "size256x256", + "value": "256x256", + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size512x512", + "value": "512x512", + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size1024x1024", + "value": "1024x1024", + "description": "A standard, square image size of 1024x1024 pixels.\nSupported by both dall-e-2 and dall-e-3 models." + }, + { + "name": "size1792x1024", + "value": "1792x1024", + "description": "A wider image size of 1024x1792 pixels.\nOnly supported with dall-e-3 models." + }, + { + "name": "size1024x1792", + "value": "1024x1792", + "description": "A taller image size of 1792x1024 pixels.\nOnly supported with dall-e-3 models." + } + ] + } + }, + "response_format": { + "type": "string", + "description": "The format in which image generation response items should be presented.", + "default": "url", + "enum": [ + "url", + "b64_json" + ], + "x-ms-enum": { + "name": "ImageGenerationResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "url", + "value": "url", + "description": "Image generation response items should provide a URL from which the image may be retrieved." + }, + { + "name": "base64", + "value": "b64_json", + "description": "Image generation response items should provide image data as a base64-encoded string." + } + ] + }, + "x-ms-client-name": "responseFormat" + }, + "quality": { + "type": "string", + "description": "The desired image generation quality level to use.\nOnly configurable with dall-e-3 models.", + "default": "standard", + "enum": [ + "standard", + "hd" + ], + "x-ms-enum": { + "name": "ImageGenerationQuality", + "modelAsString": true, + "values": [ + { + "name": "standard", + "value": "standard", + "description": "Requests image generation with standard, balanced characteristics of quality, cost, and speed." + }, + { + "name": "hd", + "value": "hd", + "description": "Requests image generation with higher quality, higher cost and lower speed relative to standard." + } + ] + } + }, + "style": { + "type": "string", + "description": "The desired image generation style to use.\nOnly configurable with dall-e-3 models.", + "default": "vivid", + "enum": [ + "natural", + "vivid" + ], + "x-ms-enum": { + "name": "ImageGenerationStyle", + "modelAsString": true, + "values": [ + { + "name": "natural", + "value": "natural", + "description": "Requests image generation in a natural style with less preference for dramatic and hyper-realistic characteristics." + }, + { + "name": "vivid", + "value": "vivid", + "description": "Requests image generation in a vivid style with a higher preference for dramatic and hyper-realistic\ncharacteristics." + } + ] + } + }, + "user": { + "type": "string", + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse." + } + }, + "required": [ + "prompt" + ] + }, + "ImageGenerationPromptFilterResults": { + "type": "object", + "description": "Describes the content filtering results for the prompt of a image generation request.", + "properties": { + "sexual": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." + }, + "violence": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to hurt, injure, damage, or\nkill someone or something; describes weapons, etc." + }, + "hate": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language attacks or uses that include pejorative or discriminatory language\nwith reference to a person or identity group on the basis of certain differentiating\nattributes of these groups including but not limited to race, ethnicity, nationality,\ngender identity and expression, sexual orientation, religion, immigration status, ability\nstatus, personal appearance, and body size." + }, + "self_harm": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to purposely hurt, injure,\nor damage one’s body, or kill oneself.", + "x-ms-client-name": "selfHarm" + }, + "profanity": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Describes whether profanity was detected." + }, + "jailbreak": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Whether a jailbreak attempt was detected in the prompt." + }, + "custom_blocklists": { + "$ref": "#/definitions/ContentFilterDetailedResults", + "description": "Information about customer block lists and if something was detected the associated list ID.", + "x-ms-client-name": "customBlocklists" + } + } + }, + "ImageGenerations": { + "type": "object", + "description": "The result of a successful image generation operation.", + "properties": { + "created": { + "type": "integer", + "format": "unixtime", + "description": "A timestamp representing when this operation was started.\nExpressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000." + }, + "data": { + "type": "array", + "description": "The images generated by the operation.", + "items": { + "$ref": "#/definitions/ImageGenerationData" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "created", + "data" + ] + }, + "MaxTokensFinishDetails": { + "type": "object", + "description": "A structured representation of a stop reason that signifies a token limit was reached before the model could naturally\ncomplete.", + "allOf": [ + { + "$ref": "#/definitions/ChatFinishDetails" + } + ], + "x-ms-discriminator-value": "max_tokens" + }, + "OnYourDataAccessTokenAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using access token.", + "properties": { + "access_token": { + "type": "string", + "description": "The access token to use for authentication.", + "x-ms-client-name": "accessToken" + } + }, + "required": [ + "access_token" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "access_token" + }, + "OnYourDataApiKeyAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", + "properties": { + "key": { + "type": "string", + "description": "The API key to use for authentication." + } + }, + "required": [ + "key" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "api_key" + }, + "OnYourDataAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data.", + "properties": { + "type": { + "$ref": "#/definitions/OnYourDataAuthenticationType", + "description": "The authentication type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "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" + ], + "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." + } + ] + } + }, + "OnYourDataConnectionStringAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using a connection string.", + "properties": { + "connection_string": { + "type": "string", + "description": "The connection string to use for authentication.", + "x-ms-client-name": "connectionString" + } + }, + "required": [ + "connection_string" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "connection_string" + }, + "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." + } + ] + } + }, + "OnYourDataDeploymentNameVectorizationSource": { + "type": "object", + "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.", + "properties": { + "deployment_name": { + "type": "string", + "description": "The embedding model deployment name within the same Azure OpenAI resource. This enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.", + "x-ms-client-name": "deploymentName" + }, + "dimensions": { + "type": "integer", + "format": "int32", + "description": "The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models." + } + }, + "required": [ + "deployment_name" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataVectorizationSource" + } + ], + "x-ms-discriminator-value": "deployment_name" + }, + "OnYourDataEncodedApiKeyAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.", + "properties": { + "encoded_api_key": { + "type": "string", + "description": "The encoded API key to use for authentication.", + "x-ms-client-name": "encodedApiKey" + } + }, + "required": [ + "encoded_api_key" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "encoded_api_key" + }, + "OnYourDataEndpointVectorizationSource": { + "type": "object", + "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.", + "properties": { + "endpoint": { + "type": "string", + "format": "uri", + "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." + }, + "authentication": { + "$ref": "#/definitions/OnYourDataVectorSearchAuthenticationOptions", + "description": "Specifies the authentication options to use when retrieving embeddings from the specified endpoint." + } + }, + "required": [ + "endpoint", + "authentication" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataVectorizationSource" + } + ], + "x-ms-discriminator-value": "endpoint" + }, + "OnYourDataKeyAndKeyIdAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.", + "properties": { + "key": { + "type": "string", + "description": "The key to use for authentication." + }, + "key_id": { + "type": "string", + "description": "The key ID to use for authentication.", + "x-ms-client-name": "keyId" + } + }, + "required": [ + "key", + "key_id" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "key_and_key_id" + }, + "OnYourDataModelIdVectorizationSource": { + "type": "object", + "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®.", + "properties": { + "model_id": { + "type": "string", + "description": "The embedding model ID build inside the search service. Currently only supported by Elasticsearch®.", + "x-ms-client-name": "modelId" + } + }, + "required": [ + "model_id" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataVectorizationSource" + } + ], + "x-ms-discriminator-value": "model_id" + }, + "OnYourDataSystemAssignedManagedIdentityAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.", + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "system_assigned_managed_identity" + }, + "OnYourDataUserAssignedManagedIdentityAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.", + "properties": { + "managed_identity_resource_id": { + "type": "string", + "description": "The resource ID of the user-assigned managed identity to use for authentication.", + "x-ms-client-name": "managedIdentityResourceId" + } + }, + "required": [ + "managed_identity_resource_id" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "user_assigned_managed_identity" + }, + "OnYourDataVectorSearchAccessTokenAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data vector search when using access token.", + "properties": { + "access_token": { + "type": "string", + "description": "The access token to use for authentication.", + "x-ms-client-name": "accessToken" + } + }, + "required": [ + "access_token" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataVectorSearchAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "access_token" + }, + "OnYourDataVectorSearchApiKeyAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", + "properties": { + "key": { + "type": "string", + "description": "The API key to use for authentication." + } + }, + "required": [ + "key" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataVectorSearchAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "api_key" + }, + "OnYourDataVectorSearchAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data vector search.", + "properties": { + "type": { + "$ref": "#/definitions/OnYourDataVectorSearchAuthenticationType", + "description": "The type of authentication to use." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "OnYourDataVectorSearchAuthenticationType": { + "type": "string", + "description": "The authentication types supported with Azure OpenAI On Your Data vector search.", + "enum": [ + "api_key", + "access_token" + ], + "x-ms-enum": { + "name": "OnYourDataVectorSearchAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "api_key", + "description": "Authentication via API key." + }, + { + "name": "accessToken", + "value": "access_token", + "description": "Authentication via access token." + } + ] + } + }, + "OnYourDataVectorizationSource": { + "type": "object", + "description": "An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search.", + "properties": { + "type": { + "$ref": "#/definitions/OnYourDataVectorizationSourceType", + "description": "The type of vectorization source to use." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "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", + "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": "modelId", + "value": "model_id", + "description": "Represents a specific embedding model ID as defined in the search service.\nCurrently only supported by Elasticsearch®." + } + ] + } + }, + "PineconeChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat\nextension.", + "properties": { + "parameters": { + "$ref": "#/definitions/PineconeChatExtensionParameters", + "description": "The parameters to use when configuring Azure OpenAI chat extensions." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "pinecone" + }, + "PineconeChatExtensionParameters": { + "type": "object", + "description": "Parameters for configuring Azure OpenAI Pinecone chat extensions. The supported authentication type is APIKey.", + "properties": { + "authentication": { + "$ref": "#/definitions/OnYourDataAuthenticationOptions", + "description": "The authentication method to use when accessing the defined data source.\nEach data source type supports a specific set of available authentication methods; please see the documentation of\nthe data source for supported mechanisms.\nIf not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential)\nauthentication." + }, + "top_n_documents": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query.", + "x-ms-client-name": "topNDocuments" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data.", + "x-ms-client-name": "inScope" + }, + "strictness": { + "type": "integer", + "format": "int32", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "minimum": 1, + "maximum": 5 + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.", + "x-ms-client-name": "roleInformation" + }, + "max_search_queries": { + "type": "integer", + "format": "int32", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified,\nthe system will decide the number of queries to send.", + "x-ms-client-name": "maxSearchQueries" + }, + "allow_partial_result": { + "type": "boolean", + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.\nIf not specified, or specified as false, the request will fail if any search query fails.", + "default": false, + "x-ms-client-name": "allowPartialResult" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/definitions/OnYourDataContextProperty" + }, + "x-ms-client-name": "includeContexts" + }, + "environment": { + "type": "string", + "description": "The environment name of Pinecone." + }, + "index_name": { + "type": "string", + "description": "The name of the Pinecone database index.", + "x-ms-client-name": "indexName" + }, + "fields_mapping": { + "$ref": "#/definitions/PineconeFieldMappingOptions", + "description": "Customized field mapping behavior to use when interacting with the search index.", + "x-ms-client-name": "fieldsMapping" + }, + "embedding_dependency": { + "$ref": "#/definitions/OnYourDataVectorizationSource", + "description": "The embedding dependency for vector search.", + "x-ms-client-name": "embeddingDependency" + } + }, + "required": [ + "environment", + "index_name", + "fields_mapping", + "embedding_dependency" + ] + }, + "PineconeFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Pinecone resource.", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title.", + "x-ms-client-name": "titleField" + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL.", + "x-ms-client-name": "urlField" + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath.", + "x-ms-client-name": "filepathField" + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + }, + "x-ms-client-name": "contentFields" + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use.", + "x-ms-client-name": "contentFieldsSeparator" + } + }, + "required": [ + "content_fields" + ] + }, + "SpeechGenerationOptions": { + "type": "object", + "description": "A representation of the request options that control the behavior of a text-to-speech operation.", + "properties": { + "input": { + "type": "string", + "description": "The text to generate audio for. The maximum length is 4096 characters.", + "maxLength": 4096 + }, + "voice": { + "$ref": "#/definitions/SpeechVoice", + "description": "The voice to use for text-to-speech." + }, + "response_format": { + "type": "string", + "description": "The audio output format for the spoken text. By default, the MP3 format will be used.", + "default": "mp3", + "enum": [ + "mp3", + "opus", + "aac", + "flac", + "wav", + "pcm" + ], + "x-ms-enum": { + "name": "SpeechGenerationResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "mp3", + "value": "mp3", + "description": "Use MP3 as the audio output format. MP3 is the default, general-purpose format." + }, + { + "name": "opus", + "value": "opus", + "description": "Use Opus as the audio output format. Opus is optimized for internet streaming and low latency." + }, + { + "name": "aac", + "value": "aac", + "description": "Use AAC as the audio output format. AAC is optimized for digital audio compression and is preferred by YouTube, Android, and iOS." + }, + { + "name": "flac", + "value": "flac", + "description": "Use FLAC as the audio output format. FLAC is a fully lossless format optimized for maximum quality at the expense of size." + }, + { + "name": "wav", + "value": "wav", + "description": "Use uncompressed WAV as the audio output format, suitable for low-latency applications to avoid decoding overhead." + }, + { + "name": "pcm", + "value": "pcm", + "description": "Use uncompressed PCM as the audio output format, which is similar to WAV but contains raw samples in 24kHz (16-bit signed, low-endian), without the header." + } + ] + }, + "x-ms-client-name": "responseFormat" + }, + "speed": { + "type": "number", + "format": "float", + "description": "The speed of speech for generated audio. Values are valid in the range from 0.25 to 4.0, with 1.0 the default and higher values corresponding to faster speech.", + "default": 1, + "minimum": 0.25, + "maximum": 4 + }, + "model": { + "type": "string", + "description": "The model to use for this text-to-speech request." + } + }, + "required": [ + "input", + "voice" + ] + }, + "SpeechVoice": { + "type": "string", + "description": "The available voices for text-to-speech.", + "enum": [ + "alloy", + "echo", + "fable", + "onyx", + "nova", + "shimmer" + ], + "x-ms-enum": { + "name": "SpeechVoice", + "modelAsString": true, + "values": [ + { + "name": "alloy", + "value": "alloy", + "description": "The Alloy voice." + }, + { + "name": "echo", + "value": "echo", + "description": "The Echo voice." + }, + { + "name": "fable", + "value": "fable", + "description": "The Fable voice." + }, + { + "name": "onyx", + "value": "onyx", + "description": "The Onyx voice." + }, + { + "name": "nova", + "value": "nova", + "description": "The Nova voice." + }, + { + "name": "shimmer", + "value": "shimmer", + "description": "The Shimmer voice." + } + ] + } + }, + "StopFinishDetails": { + "type": "object", + "description": "A structured representation of a stop reason that signifies natural termination by the model.", + "properties": { + "stop": { + "type": "string", + "description": "The token sequence that the model terminated with." + } + }, + "required": [ + "stop" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatFinishDetails" + } + ], + "x-ms-discriminator-value": "stop" + } + }, + "parameters": { + "AudioTranscriptionOptions.file": { + "name": "file", + "in": "formData", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file", + "x-ms-parameter-location": "method" + }, + "AudioTranscriptionOptions.filename": { + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AudioTranscriptionOptions.language": { + "name": "language", + "in": "formData", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AudioTranscriptionOptions.model": { + "name": "model", + "in": "formData", + "description": "The model to use for this transcription request.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AudioTranscriptionOptions.prompt": { + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AudioTranscriptionOptions.responseFormat": { + "name": "response_format", + "in": "formData", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-parameter-location": "method", + "x-ms-client-name": "responseFormat" + }, + "AudioTranscriptionOptions.temperature": { + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "AudioTranscriptionOptions.timestampGranularities": { + "name": "timestamp_granularities", + "in": "formData", + "description": "The timestamp granularities to populate for this transcription.\n`response_format` must be set `verbose_json` to use timestamp granularities.\nEither or both of these options are supported: `word`, or `segment`.\nNote: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "word", + "segment" + ], + "x-ms-enum": { + "name": "AudioTranscriptionTimestampGranularity", + "modelAsString": true, + "values": [ + { + "name": "word", + "value": "word", + "description": "Indicates that responses should include timing information about each transcribed word. Note that generating word\ntimestamp information will incur additional response latency." + }, + { + "name": "segment", + "value": "segment", + "description": "Indicates that responses should include timing and other information about each transcribed audio segment. Audio\nsegment timestamp information does not incur any additional latency." + } + ] + } + }, + "default": [ + "segment" + ], + "x-ms-parameter-location": "method", + "x-ms-client-name": "timestampGranularities" + }, + "AudioTranslationOptions.file": { + "name": "file", + "in": "formData", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file", + "x-ms-parameter-location": "method" + }, + "AudioTranslationOptions.filename": { + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AudioTranslationOptions.model": { + "name": "model", + "in": "formData", + "description": "The model to use for this translation request.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AudioTranslationOptions.prompt": { + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AudioTranslationOptions.responseFormat": { + "name": "response_format", + "in": "formData", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-parameter-location": "method", + "x-ms-client-name": "responseFormat" + }, + "AudioTranslationOptions.temperature": { + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float", + "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/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md index 614fb534747d..c627e1fb7cfd 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md @@ -203,3 +203,10 @@ These settings apply only when `--tag=release_2024_05_01_preview` is specified o ``` yaml $(tag) == 'release_2024_05_01_preview' input-file: preview/2024-05-01-preview/inference.json ``` + +## AzureOpenAI 2024-05-01-preview +These settings apply only when `--tag=release_2024_05_01_preview_autogen` is specified on the command line. + +``` yaml $(tag) == 'release_2024_05_01_preview_autogen' +input-file: preview/2024-05-01-preview/generated.json +``` From 1c0fd99e98a38940e6d1b5220709dd83c900b4ed Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Tue, 4 Jun 2024 22:04:04 +0200 Subject: [PATCH 34/49] Add v3.2 for Speech to text (3.2p2 as base) (#28664) * Add v3.2 for Speech to text (3.2p2 as base) * Update swagger with new changes and updated version number * Update readme.md with new version * Added evaluation token errors * Revert ttl changes for transcriptions * Finalized api changes for GA * Try fix avocado error --- .../data-plane/Speech/SpeechToText/readme.md | 39 +- .../v3.2/examples/commit_block_list.json | 26 + .../copy_model_with_authorization.json | 30 + .../create_container_transcription.json | 55 + .../create_copy_model_authorization.json | 23 + .../examples/create_dataset_with_blocks.json | 33 + .../create_dataset_with_content_url.json | 40 + .../stable/v3.2/examples/create_endpoint.json | 50 + .../v3.2/examples/create_evaluation.json | 116 + .../examples/create_lid_transcription.json | 85 + .../stable/v3.2/examples/create_model.json | 64 + .../examples/create_model_with_weight.json | 69 + ...ultispeaker_diarization_transcription.json | 71 + .../stable/v3.2/examples/create_project.json | 36 + ...eate_simple_diarization_transcription.json | 59 + .../examples/create_uri_transcription.json | 56 + .../stable/v3.2/examples/create_web_hook.json | 45 + .../v3.2/examples/delete_base_model_log.json | 13 + .../v3.2/examples/delete_base_model_logs.json | 13 + .../stable/v3.2/examples/delete_dataset.json | 12 + .../stable/v3.2/examples/delete_endpoint.json | 12 + .../v3.2/examples/delete_endpoint_log.json | 13 + .../v3.2/examples/delete_endpoint_logs.json | 13 + .../v3.2/examples/delete_evaluation.json | 12 + .../stable/v3.2/examples/delete_model.json | 12 + .../stable/v3.2/examples/delete_project.json | 12 + .../v3.2/examples/delete_transcription.json | 12 + .../stable/v3.2/examples/delete_web_hook.json | 12 + .../v3.2/examples/get_acoustic_datasets.json | 37 + .../stable/v3.2/examples/get_base_model.json | 43 + .../v3.2/examples/get_base_model_log.json | 26 + .../v3.2/examples/get_base_model_logs.json | 44 + .../examples/get_base_model_manifest.json | 53 + .../stable/v3.2/examples/get_dataset.json | 31 + .../v3.2/examples/get_dataset_blocks.json | 28 + .../v3.2/examples/get_dataset_file.json | 26 + .../v3.2/examples/get_dataset_files.json | 45 + .../examples/get_dataset_report_files.json | 32 + .../stable/v3.2/examples/get_datasets.json | 56 + .../stable/v3.2/examples/get_endpoint.json | 37 + .../v3.2/examples/get_endpoint_log.json | 26 + .../v3.2/examples/get_endpoint_logs.json | 44 + .../stable/v3.2/examples/get_endpoints.json | 69 + .../examples/get_english_base_models.json | 49 + .../stable/v3.2/examples/get_evaluation.json | 100 + .../v3.2/examples/get_evaluation_file.json | 26 + .../v3.2/examples/get_evaluation_files.json | 44 + .../stable/v3.2/examples/get_evaluations.json | 194 + .../get_evaluations_with_status_running.json | 74 + .../examples/get_failed_transcriptions.json | 51 + .../stable/v3.2/examples/get_model.json | 49 + .../stable/v3.2/examples/get_model_file.json | 26 + .../stable/v3.2/examples/get_model_files.json | 33 + .../v3.2/examples/get_model_manifest.json | 53 + .../v3.2/examples/get_model_with_weight.json | 49 + .../examples/get_not_started_endpoints.json | 43 + .../examples/get_operation_copy_model.json | 22 + .../get_operation_copy_model_pending.json | 19 + .../stable/v3.2/examples/get_project.json | 32 + .../v3.2/examples/get_project_datasets.json | 57 + .../v3.2/examples/get_project_endpoints.json | 70 + .../examples/get_project_evaluations.json | 195 + .../v3.2/examples/get_project_models.json | 94 + .../examples/get_project_transcriptions.json | 82 + .../stable/v3.2/examples/get_projects.json | 78 + .../get_projects_from_2018_and_2019.json | 79 + .../v3.2/examples/get_running_models.json | 93 + .../get_supported_dataset_locales.json | 25 + .../get_supported_endpoint_locales.json | 15 + .../get_supported_evaluations_locales.json | 15 + .../examples/get_supported_model_locales.json | 15 + .../get_supported_project_locales.json | 15 + .../get_supported_transcription_locales.json | 15 + .../v3.2/examples/get_transcription.json | 41 + .../v3.2/examples/get_transcription_file.json | 26 + .../examples/get_transcription_files.json | 45 + ..._transcription_files_filtered_by_name.json | 32 + .../v3.2/examples/get_transcriptions.json | 81 + .../stable/v3.2/examples/get_web_hook.json | 32 + .../stable/v3.2/examples/get_web_hooks.json | 59 + .../get_web_hooks_from_march_2020.json | 59 + .../stable/v3.2/examples/ping_web_hook.json | 12 + .../stable/v3.2/examples/test_web_hook.json | 15 + .../stable/v3.2/examples/update_dataset.json | 39 + .../stable/v3.2/examples/update_endpoint.json | 50 + .../v3.2/examples/update_evaluation.json | 105 + .../stable/v3.2/examples/update_model.json | 57 + .../stable/v3.2/examples/update_project.json | 39 + .../v3.2/examples/update_transcription.json | 49 + .../stable/v3.2/examples/update_web_hook.json | 50 + .../stable/v3.2/examples/upload_block.json | 14 + .../stable/v3.2/examples/upload_dataset.json | 40 + .../stable/v3.2/speechtotext.json | 6810 +++++++++++++++++ 93 files changed, 10989 insertions(+), 8 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/commit_block_list.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/copy_model_with_authorization.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_container_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_copy_model_authorization.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_blocks.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_content_url.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_evaluation.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_lid_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model_with_weight.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_multispeaker_diarization_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_project.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_simple_diarization_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_uri_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_log.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_logs.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_log.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_logs.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_evaluation.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_project.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_acoustic_datasets.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_log.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_logs.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_manifest.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_blocks.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_file.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_report_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_datasets.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_log.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_logs.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoints.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_english_base_models.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_file.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations_with_status_running.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_failed_transcriptions.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_file.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_manifest.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_with_weight.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_not_started_endpoints.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model_pending.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_datasets.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_endpoints.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_evaluations.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_models.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_transcriptions.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects_from_2018_and_2019.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_running_models.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_dataset_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_endpoint_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_evaluations_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_model_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_project_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_transcription_locales.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_file.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files_filtered_by_name.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcriptions.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks_from_march_2020.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/ping_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/test_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_endpoint.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_evaluation.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_model.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_project.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_transcription.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_web_hook.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_block.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_dataset.json create mode 100644 specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/speechtotext.json diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md index ece6eec1c090..880ec988957b 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md @@ -4,17 +4,17 @@ Configuration for generating SpeechToText SDK. -The current release for the SpeechToText is `release_3_1`. +The current release for the SpeechToText is `release_3_2`. ``` yaml -tag: release_3_1 +tag: release_3_2 add-credentials: true openapi-type: data-plane ``` # Releases -## SpeechToText 2.0 +## Tag: release_2_0 These settings apply only when `--tag=release_2_0` is specified on the command line. ``` yaml $(tag) == 'release_2_0' @@ -34,7 +34,7 @@ directive: --- -## SpeechToText 3.0 +## Tag: release_3_0 These settings apply only when `--tag=release_3_0` is specified on the command line. ``` yaml $(tag) == 'release_3_0' @@ -52,7 +52,7 @@ directive: --- -## SpeechToText 3.1-preview.1 +## Tag: release_3_1_preview_1 These settings apply only when `--tag=release_3_1_preview_1` is specified on the command line. ``` yaml $(tag) == 'release_3_1_preview_1' @@ -70,7 +70,7 @@ directive: --- -## SpeechToText 3.1 +## Tag: release_3_1 These settings apply only when `--tag=release_3_1` is specified on the command line. @@ -95,7 +95,7 @@ directive: --- -## SpeechToText 3.2-preview.1 +## Tag: release_3_2_preview_1 These settings apply only when `--tag=release_3_2_preview_1` is specified on the command line. @@ -118,7 +118,7 @@ directive: reason: Existing API, change would potentially be breaking. ``` -## SpeechToText 3.2-preview.2 +## Tag: release_3_2_preview_2 These settings apply only when `--tag=release_3_2_preview_2` is specified on the command line. @@ -129,6 +129,29 @@ input-file: AutoRest-Linter Suppressions +``` yaml +# Ignore autorest-linter issues that cannot be resolve without updates to the API implementation +directive: + - suppress: LongRunningOperationsWithLongRunningExtension + reason: Does not apply in those two places. The method is a DELETE which lazily deletes blobs, so it's Accepted, not NoContent. + - suppress: OperationIdNounVerb + where: $..paths[($..operationId["Models_*"])] + reason: There is a sub-route called /models/base/ that refers to the base models. Therefore, the correct operation ID seems to be "Models_GetBaseModel", for example. + - suppress: HostParametersValidation + reason: Existing API, change would potentially be breaking. +``` + +## Tag: release_3_2 + +These settings apply only when `--tag=release_3_2` is specified on the command line. + +```yaml $(tag) == 'release_3_2' +input-file: + - stable/v3.2/speechtotext.json +``` + +AutoRest-Linter Suppressions + ``` yaml # Ignore autorest-linter issues that cannot be resolve without updates to the API implementation directive: diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/commit_block_list.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/commit_block_list.json new file mode 100644 index 000000000000..6d3b1eeda575 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/commit_block_list.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "blockList": [ + { + "kind": "Uncommitted", + "id": "AAA=" + }, + { + "kind": "Uncommitted", + "id": "AAE=" + }, + { + "kind": "Uncommitted", + "id": "AAI=" + } + ] + }, + "responses": { + "200": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/copy_model_with_authorization.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/copy_model_with_authorization.json new file mode 100644 index 000000000000..3086102ed0c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/copy_model_with_authorization.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "modelCopyAuthorization": { + "targetResourceRegion": "westus2", + "targetResourceId": "/subscriptions/targetSubscriptionId/resourceGroups/targetResourceGroupName/providers/Microsoft.CognitiveServices/accounts/targetSpeechResourceName", + "targetResourceEndpoint": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models", + "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName", + "expirationDateTime": "2019-01-07T11:34:12Z", + "id": "d61573c6-788b-4eff-b3f5-38a1c7a9585b" + }, + "Content-Type": "application/json" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF", + "createdDateTime": "2019-01-07T11:34:12Z", + "lastActionDateTime": "2019-01-07T11:34:12Z", + "status": "NotStarted", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_container_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_container_transcription.json new file mode 100644 index 000000000000..ac5ea7d80921 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_container_transcription.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "transcription": { + "contentContainerUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/audiofiles/", + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked" + }, + "locale": "en-US", + "displayName": "Transcription of storage container using default model for en-US" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_copy_model_authorization.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_copy_model_authorization.json new file mode 100644 index 000000000000..dc2b86b0535f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_copy_model_authorization.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "modelCopyAuthorizationDefinition": { + "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName" + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "targetResourceRegion": "westus2", + "targetResourceId": "/subscriptions/targetSubscriptionId/resourceGroups/targetResourceGroupName/providers/Microsoft.CognitiveServices/accounts/targetSpeechResourceName", + "targetResourceEndpoint": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models", + "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName", + "expirationDateTime": "2019-01-07T11:34:12Z", + "id": "d61573c6-788b-4eff-b3f5-38a1c7a9585b" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_blocks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_blocks.json new file mode 100644 index 000000000000..ca1564026c0d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_blocks.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "dataset": { + "kind": "Acoustic", + "locale": "en-US", + "displayName": "My speech dataset name", + "description": "My speech dataset description" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files", + "commitBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks:commit", + "listBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks", + "uploadBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_content_url.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_content_url.json new file mode 100644 index 000000000000..2993368b97be --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_dataset_with_content_url.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "dataset": { + "kind": "Acoustic", + "contentUrl": "https://contoso.com/location", + "locale": "en-US", + "displayName": "My speech dataset name", + "description": "My speech dataset description" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_endpoint.json new file mode 100644 index 000000000000..5c81757ceb7c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_endpoint.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "endpoint": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "properties": { + "loggingEnabled": true + }, + "locale": "en-US", + "displayName": "Speech endpoint definition", + "description": "This is a speech endpoint" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_evaluation.json new file mode 100644 index 000000000000..631b0872b7eb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_evaluation.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "evaluation": { + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "locale": "en-US", + "displayName": "My new evaluation", + "description": "The description of the evaluation" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evaluation of one model against another model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_lid_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_lid_transcription.json new file mode 100644 index 000000000000..911ece0b2afb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_lid_transcription.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation" + ], + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "languageIdentification": { + "mode": "Single", + "candidateLocales": [ + "fr-FR", + "nl-NL", + "el-GR" + ], + "speechModelMapping": { + "nl-NL": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + } + } + } + }, + "locale": "fr-FR", + "displayName": "Transcription using language identification with three candidate languages, 'fr-FR' as fallback locale and a custom model for transcribing utterances that were classified as 'nl-NL' locale." + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "languageIdentification": { + "mode": "Single", + "candidateLocales": [ + "fr-FR", + "nl-NL", + "el-GR" + ], + "speechModelMapping": { + "nl-NL": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + } + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "fr-FR", + "displayName": "Transcription using language identification with three candidate languages, 'fr-FR' as fallback locale and a custom model for transcribing utterances that were classified as 'nl-NL' locale.", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model.json new file mode 100644 index 000000000000..2b6fbde5e7d1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "model": { + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "locale": "en-US", + "displayName": "Model with acoustic and language datasets" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model_with_weight.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model_with_weight.json new file mode 100644 index 000000000000..e98abd9cc543 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_model_with_weight.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "model": { + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "properties": { + "customModelWeightPercent": 42 + }, + "locale": "en-US", + "displayName": "Model with acoustic and language datasets" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 42, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_multispeaker_diarization_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_multispeaker_diarization_transcription.json new file mode 100644 index 000000000000..aceb1010f7d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_multispeaker_diarization_transcription.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation" + ], + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "diarization": { + "speakers": { + "minCount": 3, + "maxCount": 5 + } + } + }, + "locale": "en-US", + "displayName": "Transcription using diarization for audio that is known to contain speech from 3-5 speakers" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "diarization": { + "speakers": { + "minCount": 3, + "maxCount": 5 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using diarization for audio that is known to contain speech from 3-5 speakers", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_project.json new file mode 100644 index 000000000000..4f01480f899a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_project.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "project": { + "locale": "en-US", + "displayName": "My speech project" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_simple_diarization_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_simple_diarization_transcription.json new file mode 100644 index 000000000000..110033c9ab40 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_simple_diarization_transcription.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation" + ], + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked" + }, + "locale": "en-US", + "displayName": "Transcription using basic two-speaker diarization" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using basic two-speaker diarization", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_uri_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_uri_transcription.json new file mode 100644 index 000000000000..cec1ff91787e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_uri_transcription.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation", + "https://contoso.com/myotherstoragelocation" + ], + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked" + }, + "locale": "en-US", + "displayName": "Transcription using default model for en-US" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_web_hook.json new file mode 100644 index 000000000000..ac660aa02e17 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/create_web_hook.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "webHook": { + "displayName": "TranscriptionCompletionWebHook", + "properties": { + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription." + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "NotStarted" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_log.json new file mode 100644 index 000000000000..44bff0317a1a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_log.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_logs.json new file mode 100644 index 000000000000..5f60e6048e14 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_base_model_logs.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "endDate": "2019-01-01" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_dataset.json new file mode 100644 index 000000000000..6c29b587a750 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_dataset.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint.json new file mode 100644 index 000000000000..d2c284860113 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_log.json new file mode 100644 index 000000000000..eff0e76962b8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_log.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_logs.json new file mode 100644 index 000000000000..5bb1d4bd4e2c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_endpoint_logs.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "endDate": "2019-01-01" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_evaluation.json new file mode 100644 index 000000000000..22349ee5cc12 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_evaluation.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_model.json new file mode 100644 index 000000000000..621d39d9c341 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_model.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_project.json new file mode 100644 index 000000000000..1e73e0f3bc0b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_project.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_transcription.json new file mode 100644 index 000000000000..ec68edb84756 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_transcription.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_web_hook.json new file mode 100644 index 000000000000..23a047a55361 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/delete_web_hook.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_acoustic_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_acoustic_datasets.json new file mode 100644 index 000000000000..f719c51cb90e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_acoustic_datasets.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 10, + "filter": "kind%20eq%20'Acoustic'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model.json new file mode 100644 index 000000000000..832dad6227c1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T00:00:00Z", + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": true, + "supportsAdaptationsWith": [ + "Language", + "Acoustic" + ], + "supportedOutputFormats": [ + "Display", + "Lexical" + ] + }, + "chargeForAdaptation": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "en-US Base model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_log.json new file mode 100644 index 000000000000..d2dd6080f619 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_log.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_logs.json new file mode 100644 index 000000000000..eea139cdf45c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_logs.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "locale": "Acoustic", + "sasValidityInSeconds": 120, + "skipToken": "2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--", + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "kind": "Transcription", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/base/en-us/files/logs?top=2&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_manifest.json new file mode 100644 index 000000000000..8b0a567f99d2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_base_model_manifest.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/02231df2-012f-45d4-9af0-8a3e4ccc877c" + }, + "modelFiles": [ + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe", + "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/graphV2/base.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + } + ], + "properties": { + "IN_FESpec": "audio(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe,8kHz16kHzLFB80EnergyMLPVADRuntime)", + "IN_DNNSpec": "dnn_spec(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am,40,20),allValidInUtt(1),frameCopyCount(1),resetOnSegmentation(1)", + "IN_HCLGSpecBase": "interpolated_lm_base(%MODELSPATH%0_EN_US_V4.14_UNI/graphV2/base.lms)", + "IN_HCLGSpec": "interpolated_lm_custom(0.9,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.hclg,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.lms,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.lms)", + "IN_BeamSize": 5000, + "IN_BeamThreshold": 190, + "IN_NBestBeamSize": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset.json new file mode 100644 index 000000000000..5dba326a0fa8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_blocks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_blocks.json new file mode 100644 index 000000000000..05066a8753c1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_blocks.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "uncommittedBlocks": [ + { + "name": "AAA=", + "size": 123 + }, + { + "name": "AAE=", + "size": 234 + }, + { + "name": "AAI=", + "size": 345 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_file.json new file mode 100644 index 000000000000..735e89d754cd --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_file.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "report.json", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_files.json new file mode 100644 index 000000000000..b0e0e9353538 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_files.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "report.json", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/f035cf2d-4051-4131-85e7-97e3a7349c86", + "name": "language_data.txt", + "kind": "LanguageData", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/language_data.txt?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_report_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_report_files.json new file mode 100644 index 000000000000..24b41a48bcb0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_dataset_report_files.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 10, + "filter": "kind%20eq%20'DatasetReport'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "report.json", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_datasets.json new file mode 100644 index 000000000000..eaab758ced4f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_datasets.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c", + "kind": "Language", + "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2 + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language dataset" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint.json new file mode 100644 index 000000000000..5d861ed7b2e6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_log.json new file mode 100644 index 000000000000..6d87f13a4ab2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_log.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_logs.json new file mode 100644 index 000000000000..6c5e59279812 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoint_logs.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "sasValidityInSeconds": 120, + "skipToken": "2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--", + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "kind": "Transcription", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?top=2&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoints.json new file mode 100644 index 000000000000..7b95789f23be --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_endpoints.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": false + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_english_base_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_english_base_models.json new file mode 100644 index 000000000000..43a63f9c99dc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_english_base_models.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "locale%20eq%20'en-US'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T00:00:00Z", + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": true, + "supportsAdaptationsWith": [ + "Language", + "Acoustic" + ], + "supportedOutputFormats": [ + "Display", + "Lexical" + ] + }, + "chargeForAdaptation": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "en-US Base model" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation.json new file mode 100644 index 000000000000..fe2023e32424 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evaluation of one model against another model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_file.json new file mode 100644 index 000000000000..f5d0fa14de06 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_file.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "mywavefile1.wav.model2_score.json", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_files.json new file mode 100644 index 000000000000..5a51ed3395ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluation_files.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/8ad6c551-9d6e-43f7-9649-94680899e77a", + "name": "mywavefile1.wav.model1_score.json", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model1_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "mywavefile1.wav.model2_score.json", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations.json new file mode 100644 index 000000000000..9e0facaa4f97 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/a55a327b-c866-40b3-a08d-9c0945738633", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evaluation of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evaluation of one model against another model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations_with_status_running.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations_with_status_running.json new file mode 100644 index 000000000000..cea52ccbe8bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_evaluations_with_status_running.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Running'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/f85a328c-c866-40b3-a08d-9c0945738633", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate1": 0.89, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "wordErrorRate2": 0.98, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0 + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evaluation of one model against another model" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_failed_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_failed_transcriptions.json new file mode 100644 index 000000000000..1f20e3a904b2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_failed_transcriptions.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Failed'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": true, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Failed", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model.json new file mode 100644 index 000000000000..b70d3923cdfa --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_file.json new file mode 100644 index 000000000000..d7eb6f82f606 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_file.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "report.json", + "kind": "ModelReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_files.json new file mode 100644 index 000000000000..25f67bc88f55 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_files.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "report.json", + "kind": "ModelReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_manifest.json new file mode 100644 index 000000000000..8b0a567f99d2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_manifest.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/02231df2-012f-45d4-9af0-8a3e4ccc877c" + }, + "modelFiles": [ + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe", + "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/graphV2/base.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + } + ], + "properties": { + "IN_FESpec": "audio(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe,8kHz16kHzLFB80EnergyMLPVADRuntime)", + "IN_DNNSpec": "dnn_spec(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am,40,20),allValidInUtt(1),frameCopyCount(1),resetOnSegmentation(1)", + "IN_HCLGSpecBase": "interpolated_lm_base(%MODELSPATH%0_EN_US_V4.14_UNI/graphV2/base.lms)", + "IN_HCLGSpec": "interpolated_lm_custom(0.9,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.hclg,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.lms,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.lms)", + "IN_BeamSize": 5000, + "IN_BeamThreshold": 190, + "IN_NBestBeamSize": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_with_weight.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_with_weight.json new file mode 100644 index 000000000000..aac424e7355a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_model_with_weight.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 42, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_not_started_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_not_started_endpoints.json new file mode 100644 index 000000000000..6577132a6818 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_not_started_endpoints.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'NotStarted'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": false + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model.json new file mode 100644 index 000000000000..2f07e9e55d1b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/operations/models/copy/e30f6a27-82be-4cca-9258-0399c70489ff", + "createdDateTime": "2019-01-07T11:34:12Z", + "lastActionDateTime": "2019-01-07T11:34:12Z", + "status": "Succeeded", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff", + "result": { + "link": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/be640db7-c44b-47f2-bf6c-47e431d23d63" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model_pending.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model_pending.json new file mode 100644 index 000000000000..180746d579e6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_operation_copy_model_pending.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF", + "createdDateTime": "2019-01-07T11:34:12Z", + "lastActionDateTime": "2019-01-07T11:34:12Z", + "status": "NotStarted", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project.json new file mode 100644 index 000000000000..2e6762906bab --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_datasets.json new file mode 100644 index 000000000000..360c2bb518d5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_datasets.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c", + "kind": "Language", + "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2 + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language dataset" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_endpoints.json new file mode 100644 index 000000000000..5b27748bbd12 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_endpoints.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": false + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_evaluations.json new file mode 100644 index 000000000000..cf835b16be55 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_evaluations.json @@ -0,0 +1,195 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/a55a327b-c866-40b3-a08d-9c0945738633", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evaluation of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evaluation of one model against another model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_models.json new file mode 100644 index 000000000000..3d79a1a5c90e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_models.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Running'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic model", + "description": "Example for an acoustic model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models?skip=2&top=2&filter=status%20eq%20'Running'" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_transcriptions.json new file mode 100644 index 000000000000..15cbe6f25055 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_project_transcriptions.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": true, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Failed", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects.json new file mode 100644 index 000000000000..dd0accbcfab6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 3 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects?skip=3&top=3" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects_from_2018_and_2019.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects_from_2018_and_2019.json new file mode 100644 index 000000000000..65c9b99b1107 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_projects_from_2018_and_2019.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 3, + "filter": "createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2018-03-03T12:45:27Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2018-12-19T17:54:57Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-02-01T00:45:27Z", + "locale": "en-US", + "displayName": "My speech project" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects?skip=6&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_running_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_running_models.json new file mode 100644 index 000000000000..fd78a426b801 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_running_models.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Running'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic model", + "description": "Example for an acoustic model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models?skip=2&top=2&filter=status%20eq%20'Running'" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_dataset_locales.json new file mode 100644 index 000000000000..8c2907544038 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_dataset_locales.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "en-US": [ + "Acoustic", + "Language", + "Pronunciation", + "AudioFiles", + "LanguageMarkdown" + ], + "de-DE": [ + "Acoustic", + "Language", + "AudioFiles" + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_endpoint_locales.json new file mode 100644 index 000000000000..c1659390e825 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_endpoint_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_evaluations_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_evaluations_locales.json new file mode 100644 index 000000000000..c1659390e825 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_evaluations_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_model_locales.json new file mode 100644 index 000000000000..c1659390e825 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_model_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_project_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_project_locales.json new file mode 100644 index 000000000000..c1659390e825 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_project_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_transcription_locales.json new file mode 100644 index 000000000000..c1659390e825 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_supported_transcription_locales.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription.json new file mode 100644 index 000000000000..2c12db4e7cd1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_file.json new file mode 100644 index 000000000000..ef808a3e40c6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_file.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "sasValidityInSeconds": 120, + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "mywavefile1.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files.json new file mode 100644 index 000000000000..7051221e8550 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "mywavefile1.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/28bc946b-c251-4a86-84f6-ea0f0a2373ef", + "name": "mywavefile2.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile2.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?skip=2&top=2" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files_filtered_by_name.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files_filtered_by_name.json new file mode 100644 index 000000000000..faa6dbc7fac9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcription_files_filtered_by_name.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 10, + "filter": "name%20eq%20'mywavefile1.wav.json'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29", + "name": "mywavefile1.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcriptions.json new file mode 100644 index 000000000000..483bee215b91 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_transcriptions.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": true, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Failed", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hook.json new file mode 100644 index 000000000000..5a57a39389ac --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hook.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks.json new file mode 100644 index 000000000000..22edfd5e434b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/aff13a6e-17c4-4247-862f-70e99469c553", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2019-02-11T00:00:00Z", + "lastActionDateTime": "2019-02-28T00:00:00Z", + "status": "Succeeded" + }, + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks_from_march_2020.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks_from_march_2020.json new file mode 100644 index 000000000000..b62fb607d172 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/get_web_hooks_from_march_2020.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "displayName": "A test web hook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/aff13a6e-17c4-4247-862f-70e99469c553", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2020-03-11T14:13:12Z", + "lastActionDateTime": "2020-03-11T14:13:12Z", + "status": "Succeeded" + }, + { + "displayName": "Beta version web hook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2020-03-21T09:07:43Z", + "lastActionDateTime": "2020-03-21T09:07:43Z", + "status": "Succeeded" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/ping_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/ping_web_hook.json new file mode 100644 index 000000000000..c5754949767f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/ping_web_hook.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/test_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/test_web_hook.json new file mode 100644 index 000000000000..47ce05014dc8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/test_web_hook.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "202": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_dataset.json new file mode 100644 index 000000000000..1b54ffd1c984 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_dataset.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "datasetUpdate": { + "displayName": "Updated dataset name", + "description": "Updated dataset description", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_endpoint.json new file mode 100644 index 000000000000..5237c6294005 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_endpoint.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "endpointUpdate": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "properties": { + "contentLoggingEnabled": true + }, + "displayName": "Updated endpoint with new model", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_evaluation.json new file mode 100644 index 000000000000..f337de02cb88 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_evaluation.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "evaluationUpdate": { + "displayName": "Updated evaluation", + "description": "Updated evaluation description" + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/evaluations/00000000-0000-0000-0000-000000000000/files" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evaluation of one model against another model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_model.json new file mode 100644 index 000000000000..a3078bbbf6bb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_model.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "modelUpdate": { + "displayName": "Language model update", + "description": "This is a language model update", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptions": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_project.json new file mode 100644 index 000000000000..080a2e6c23ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_project.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "projectUpdate": { + "displayName": "My updated speech project", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions" + }, + "properties": { + "datasetCount": 23, + "evaluationCount": 42, + "modelCount": 2, + "transcriptionCount": 1994, + "endpointCount": 12 + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_transcription.json new file mode 100644 index 000000000000..2b847b8148ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_transcription.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "transcriptionUpdate": { + "displayName": "Updated transcription name", + "description": "Updated transcription description", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_web_hook.json new file mode 100644 index 000000000000..47514faa1737 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/update_web_hook.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d", + "webHookUpdate": { + "properties": { + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "events": { + "evaluationCreation": true, + "evaluationProcessing": true, + "evaluationCompletion": true, + "evaluationDeletion": true + }, + "webUrl": "https://contoso.com/call/me/back", + "displayName": "TranscriptionCompletionWebHook", + "description": "I registered this URL to get a POST request for each completed transcription.", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping" + }, + "properties": { + "apiVersion": "v3.2", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_block.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_block.json new file mode 100644 index 000000000000..61041ac3785c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_block.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "blockid": "AAE=", + "body": "{binary}" + }, + "responses": { + "201": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_dataset.json new file mode 100644 index 000000000000..3114be1f2e5e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/examples/upload_dataset.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "project": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0", + "Content-Type": "multipart/form-data", + "displayName": "My speech dataset name", + "description": "My speech dataset description", + "locale": "en-us", + "kind": "Acoustic", + "customProperties": "{ \"property\": \"true\" }", + "email": "info@contoso.com" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/speechtotext.json new file mode 100644 index 000000000000..1e7a4aab001b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.2/speechtotext.json @@ -0,0 +1,6810 @@ +{ + "swagger": "2.0", + "info": { + "title": "Speech Services API version 3.2", + "description": "Speech Services API version 3.2.", + "contact": { + "name": "Cognitive Services - Speech Services", + "url": "https://learn.microsoft.com/azure/cognitive-services/speech-service/support" + }, + "version": "3.2" + }, + "paths": { + "/datasets/locales": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of supported locales for datasets.", + "operationId": "Datasets_ListSupportedLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatasetLocales" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_dataset_locales.json" + } + } + } + }, + "/datasets": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of datasets for the authenticated subscription.", + "operationId": "Datasets_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available datasets.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n -Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z and displayName eq 'My dataset'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedDatasets" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all datasets": { + "$ref": "./examples/get_datasets.json" + }, + "Get all acoustic datasets": { + "$ref": "./examples/get_acoustic_datasets.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Uploads and creates a new dataset by getting the data from a specified URL or starts waiting for data blocks to be uploaded.", + "operationId": "Datasets_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "dataset", + "description": "Definition for the new dataset.", + "required": true, + "schema": { + "$ref": "#/definitions/Dataset" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a dataset with content url": { + "$ref": "./examples/create_dataset_with_content_url.json" + }, + "Create dataset from data blocks": { + "$ref": "./examples/create_dataset_with_blocks.json" + } + } + } + }, + "/datasets/{id}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the dataset identified by the given ID.", + "operationId": "Datasets_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a dataset": { + "$ref": "./examples/get_dataset.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Updates the mutable details of the dataset identified by its ID.", + "operationId": "Datasets_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "datasetUpdate", + "description": "The updated values for the dataset.", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a dataset": { + "$ref": "./examples/update_dataset.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Deletes the specified dataset.", + "operationId": "Datasets_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The dataset was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a dataset": { + "$ref": "./examples/delete_dataset.json" + } + } + } + }, + "/datasets/{id}/blocks": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the list of uploaded blocks for this dataset.", + "operationId": "Datasets_GetBlocks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UploadedBlocks" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get uploaded blocks for dataset": { + "$ref": "./examples/get_dataset_blocks.json" + } + } + }, + "put": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Upload a block of data for the dataset. The maximum size of the block is 8MiB.", + "operationId": "Datasets_UploadBlock", + "consumes": [ + "application/octet-stream" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "blockid", + "description": "A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. Note that the Base64 string must be URL-encoded.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "The data block was uploaded successfully." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Upload a block for a dataset": { + "$ref": "./examples/upload_block.json" + } + } + } + }, + "/datasets/upload": { + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Uploads data and creates a new dataset.", + "operationId": "Datasets_Upload", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "formData", + "name": "project", + "description": "The optional string representation of the url of a project. If set, the dataset will be associated with that project.", + "type": "string" + }, + { + "in": "formData", + "name": "displayName", + "description": "The name of this dataset.", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "description", + "description": "Optional description of this dataset.", + "type": "string" + }, + { + "in": "formData", + "name": "locale", + "description": "The locale of this dataset.", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "kind", + "description": "The kind of the dataset. Possible values are \"Language\", \"Acoustic\", \"Pronunciation\", \"AudioFiles\", \"LanguageMarkdown\", \"OutputFormatting\".", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "customProperties", + "description": "The optional custom properties of this entity. The maximum allowed key length is 64 characters, the maximum allowed value length is 256 characters and the count of allowed entries is 10.", + "type": "string" + }, + { + "in": "formData", + "name": "data", + "description": "For acoustic datasets, a zip file containing the audio data and a text file containing the transcriptions for the audio data. For language datasets, a text file containing the language or pronunciation data. Required in both cases.", + "type": "file" + }, + { + "in": "formData", + "name": "email", + "description": "An optional string containing the email address to send email notifications to in case the operation completes. The value will be removed after successfully sending the email.", + "type": "string" + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "Upload a dataset": { + "$ref": "./examples/upload_dataset.json" + } + } + } + }, + "/datasets/{id}/blocks:commit": { + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Commit block list to complete the upload of the dataset.", + "operationId": "Datasets_CommitBlocks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "blockList", + "description": "The list of blocks that compile the dataset.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CommitBlocksEntry" + } + } + } + ], + "responses": { + "200": { + "description": "The block list is accepted and the data import process can continue." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Commit uploaded blocks to dataset": { + "$ref": "./examples/commit_block_list.json" + } + } + } + }, + "/datasets/{id}/files": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the files of the dataset identified by the given ID.", + "operationId": "Datasets_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_dataset_files.json" + }, + "Get all dataset report files": { + "$ref": "./examples/get_dataset_report_files.json" + } + } + } + }, + "/datasets/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets one specific file (identified with fileId) from a dataset (identified with id).", + "operationId": "Datasets_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_dataset_file.json" + } + } + } + }, + "/endpoints/locales": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a list of supported locales for endpoint creations.", + "operationId": "Endpoints_ListSupportedLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_endpoint_locales.json" + } + } + } + }, + "/endpoints": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of endpoints for the authenticated subscription.", + "operationId": "Endpoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available endpoints.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=locale eq 'en-US'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEndpoints" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoints": { + "$ref": "./examples/get_endpoints.json" + }, + "Get all queued endpoints.": { + "$ref": "./examples/get_not_started_endpoints.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Creates a new endpoint.", + "operationId": "Endpoints_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "endpoint", + "description": "The details of the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create an endpoint": { + "$ref": "./examples/create_endpoint.json" + } + } + } + }, + "/endpoints/{id}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the endpoint identified by the given ID.", + "operationId": "Endpoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get an endpoint": { + "$ref": "./examples/get_endpoint.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the endpoint identified by the given ID.", + "operationId": "Endpoints_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The model endpoint was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete an endpoint": { + "$ref": "./examples/delete_endpoint.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Updates the metadata of the endpoint identified by the given ID.", + "operationId": "Endpoints_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "endpointUpdate", + "description": "The updated values for the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update an endpoint": { + "$ref": "./examples/update_endpoint.json" + } + } + } + }, + "/endpoints/{id}/files/logs": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of audio and transcription logs that have been stored for a given endpoint.", + "operationId": "Endpoints_ListLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "in": "query", + "name": "skipToken", + "description": "Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.", + "type": "string" + }, + { + "$ref": "#/parameters/topQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoint logs": { + "$ref": "./examples/get_endpoint_logs.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the specified audio and transcription logs that have been stored for a given endpoint. It deletes all logs before (and including) a specific day.", + "description": "The deletion process is done asynchronously and can take up to one day depending on the amount of log files.", + "operationId": "Endpoints_DeleteLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "endDate", + "description": "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2023-03-15\" results in deleting all logs on March 15th, 2023 and before.\r\n Deletes all existing logs when date is not specified.", + "type": "string" + } + ], + "responses": { + "202": { + "description": "The logs will be deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete all endpoint logs": { + "$ref": "./examples/delete_endpoint_logs.json" + } + } + } + }, + "/endpoints/{id}/files/logs/{logId}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a specific audio or transcription log for a given endpoint.", + "operationId": "Endpoints_GetLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get an endpoint log": { + "$ref": "./examples/get_endpoint_log.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes one audio or transcription log that have been stored for a given endpoint.", + "operationId": "Endpoints_DeleteLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "The log was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete an endpoint log": { + "$ref": "./examples/delete_endpoint_log.json" + } + } + } + }, + "/endpoints/base/{locale}/files/logs": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of audio and transcription logs that have been stored when using the default base model of a given language.", + "operationId": "Endpoints_ListBaseModelLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "in": "query", + "name": "skipToken", + "description": "Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.", + "type": "string" + }, + { + "$ref": "#/parameters/topQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all base model logs": { + "$ref": "./examples/get_base_model_logs.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the specified audio and transcription logs that have been stored when using the default base model of a given language. It deletes all logs before (and including) a specific day.", + "description": "Deletion process is done asynchronously and can take up to one day depending on the amount of log files.", + "operationId": "Endpoints_DeleteBaseModelLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "endDate", + "description": "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2023-03-15\" results in deleting all logs on March 15th, 2023 and before.\r\n Deletes all existing logs when date is not specified.", + "type": "string" + } + ], + "responses": { + "202": { + "description": "The logs will be deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete all base model logs": { + "$ref": "./examples/delete_base_model_logs.json" + } + } + } + }, + "/endpoints/base/{locale}/files/logs/{logId}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a specific audio or transcription log for the default base model in a given language.", + "operationId": "Endpoints_GetBaseModelLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a base model log": { + "$ref": "./examples/get_base_model_log.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes one audio or transcription log that have been stored when using the default base model of a given language.", + "operationId": "Endpoints_DeleteBaseModelLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "The log was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a base model log": { + "$ref": "./examples/delete_base_model_log.json" + } + } + } + }, + "/evaluations/locales": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets a list of supported locales for evaluations.", + "operationId": "Evaluations_ListSupportedLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_evaluations_locales.json" + } + } + } + }, + "/evaluations": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the list of evaluations for the authenticated subscription.", + "operationId": "Evaluations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available evaluations.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'My evaluation'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEvaluations" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all evaluations": { + "$ref": "./examples/get_evaluations.json" + }, + "Get all evaluations with where status is equal to 'Running'": { + "$ref": "./examples/get_evaluations_with_status_running.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Creates a new evaluation.", + "operationId": "Evaluations_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "evaluation", + "description": "The details of the new evaluation.", + "required": true, + "schema": { + "$ref": "#/definitions/Evaluation" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a evaluation": { + "$ref": "./examples/create_evaluation.json" + } + } + } + }, + "/evaluations/{id}/files": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the files of the evaluation identified by the given ID.", + "operationId": "Evaluations_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_evaluation_files.json" + } + } + } + }, + "/evaluations/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets one specific file (identified with fileId) from an evaluation (identified with id).", + "operationId": "Evaluations_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_evaluation_file.json" + } + } + } + }, + "/evaluations/{id}": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the evaluation identified by the given ID.", + "operationId": "Evaluations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a evaluation": { + "$ref": "./examples/get_evaluation.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Updates the mutable details of the evaluation identified by its id.", + "operationId": "Evaluations_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "evaluationUpdate", + "description": "The object containing the updated fields of the evaluation.", + "required": true, + "schema": { + "$ref": "#/definitions/EvaluationUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a evaluation": { + "$ref": "./examples/update_evaluation.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Deletes the evaluation identified by the given ID.", + "operationId": "Evaluations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The evaluation was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a evaluation": { + "$ref": "./examples/delete_evaluation.json" + } + } + } + }, + "/models/locales": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets a list of supported locales for model adaptation.", + "operationId": "Models_ListSupportedLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_model_locales.json" + } + } + } + }, + "/models": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of custom models for the authenticated subscription.", + "operationId": "Models_ListCustomModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedCustomModels" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all models in state 'Running'": { + "$ref": "./examples/get_running_models.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Creates a new model.", + "operationId": "Models_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "model", + "description": "The details of the new model.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomModel" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/CustomModel" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a model": { + "$ref": "./examples/create_model.json" + }, + "Create a model with custom model weight": { + "$ref": "./examples/create_model_with_weight.json" + } + } + } + }, + "/models/base": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of base models for the authenticated subscription.", + "operationId": "Models_ListBaseModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available base models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedBaseModels" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all english base models": { + "$ref": "./examples/get_english_base_models.json" + } + } + } + }, + "/models/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the model identified by the given ID.", + "operationId": "Models_GetCustomModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomModel" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a model": { + "$ref": "./examples/get_model.json" + }, + "Get a model with custom model weight": { + "$ref": "./examples/get_model_with_weight.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Updates the metadata of the model identified by the given ID.", + "operationId": "Models_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "modelUpdate", + "description": "The updated values for the model.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomModel" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a model": { + "$ref": "./examples/update_model.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Deletes the model identified by the given ID.", + "operationId": "Models_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The model was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a model": { + "$ref": "./examples/delete_model.json" + } + } + } + }, + "/models/base/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the base model identified by the given ID.", + "operationId": "Models_GetBaseModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the base model.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseModel" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a base model": { + "$ref": "./examples/get_base_model.json" + } + } + } + }, + "/models/{id}:copy": { + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Copies a model from one subscription to another.", + "description": "This method can be used to copy a model from this speech resource to a target one.\r\nThe authorization is obtained on the target speech resource.\r\nOnly custom models can be copied to another speech resource.", + "operationId": "Models_Copy", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model that will be copied.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "modelCopyAuthorization", + "description": "The body contains the authorization to copy to the target speech resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCopyAuthorization" + } + } + ], + "responses": { + "202": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Operation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer", + "format": "int32" + }, + "Operation-Location": { + "description": "The location of the operation to track progress.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Copy a model from source resource to target resource": { + "$ref": "./examples/copy_model_with_authorization.json" + } + } + } + }, + "/models:authorizecopy": { + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Allows another speech resource (source) to copy a model to this speech resource (target).", + "description": "This method can be used to allow copying a model from another speech resource.\r\nOnly custom models can be copied from another speech resource.", + "operationId": "Models_AuthorizeCopy", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "modelCopyAuthorizationDefinition", + "description": "The body contains the Azure Resource ID of the source speech resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCopyAuthorizationDefinition" + } + } + ], + "responses": { + "200": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/ModelCopyAuthorization" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a copy model authorization on target resource": { + "$ref": "./examples/create_copy_model_authorization.json" + } + } + } + }, + "/models/{id}/manifest": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Returns an manifest for this model which can be used in an on-premise container.", + "operationId": "Models_GetCustomModelManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the model to generate a manifest for.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "Successfully generated a model manifest.", + "schema": { + "$ref": "#/definitions/ModelManifest" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a model manifest": { + "$ref": "./examples/get_model_manifest.json" + } + } + } + }, + "/models/base/{id}/manifest": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Returns an manifest for this base model which can be used in an on-premise container.", + "operationId": "Models_GetBaseModelManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the model to generate a manifest for.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "Successfully generated a model manifest.", + "schema": { + "$ref": "#/definitions/ModelManifest" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a base model manifest": { + "$ref": "./examples/get_base_model_manifest.json" + } + } + } + }, + "/models/{id}/files": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the files of the model identified by the given ID.", + "operationId": "Models_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_model_files.json" + } + } + } + }, + "/models/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets one specific file (identified with fileId) from a model (identified with id).", + "operationId": "Models_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_model_file.json" + } + } + } + }, + "/operations/models/copy/{id}": { + "get": { + "tags": [ + "Custom Speech operations:" + ], + "summary": "Gets the operation identified by the given ID.", + "operationId": "Operations_GetModelCopy", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the operation.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Operation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get model copy operation pending": { + "$ref": "./examples/get_operation_copy_model_pending.json" + }, + "Get model copy operation": { + "$ref": "./examples/get_operation_copy_model.json" + } + } + } + }, + "/projects/locales": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of supported locales.", + "operationId": "Projects_ListSupportedLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_project_locales.json" + } + } + } + }, + "/projects": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of projects for the authenticated subscription.", + "operationId": "Projects_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available projects.\r\n - Supported properties: displayName, description, createdDateTime, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'My test'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedProjects" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all projects": { + "$ref": "./examples/get_projects.json" + }, + "Get all projects created in 2018 or 2019": { + "$ref": "./examples/get_projects_from_2018_and_2019.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Creates a new project.", + "operationId": "Projects_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "project", + "description": "The details of the project.", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Project" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a project": { + "$ref": "./examples/create_project.json" + } + } + } + }, + "/projects/{id}": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the project identified by the given ID.", + "operationId": "Projects_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a project": { + "$ref": "./examples/get_project.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Updates the project identified by the given ID.", + "operationId": "Projects_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "projectUpdate", + "description": "The updated values for the project.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a project": { + "$ref": "./examples/update_project.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Deletes the project identified by the given ID.", + "operationId": "Projects_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The project was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a project": { + "$ref": "./examples/delete_project.json" + } + } + } + }, + "/projects/{id}/evaluations": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of evaluations for specified project.", + "operationId": "Projects_ListEvaluations", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available evaluations.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example\r\n filter=displayName eq 'My evaluation'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEvaluations" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all evaluations": { + "$ref": "./examples/get_project_evaluations.json" + } + } + } + }, + "/projects/{id}/datasets": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of datasets for specified project.", + "operationId": "Projects_ListDatasets", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available datasets.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedDatasets" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all datasets": { + "$ref": "./examples/get_project_datasets.json" + } + } + } + }, + "/projects/{id}/endpoints": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of endpoints for specified project.", + "operationId": "Projects_ListEndpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available endpoints.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=locale eq 'en-US'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEndpoints" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoints": { + "$ref": "./examples/get_project_endpoints.json" + } + } + } + }, + "/projects/{id}/models": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of models for specified project.", + "operationId": "Projects_ListModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedCustomModels" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all models": { + "$ref": "./examples/get_project_models.json" + } + } + } + }, + "/projects/{id}/transcriptions": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of transcriptions for specified project.", + "operationId": "Projects_ListTranscriptions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available transcriptions.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedTranscriptions" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all transcriptions": { + "$ref": "./examples/get_project_transcriptions.json" + } + } + } + }, + "/transcriptions/locales": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of supported locales for offline transcriptions.", + "operationId": "Transcriptions_ListSupportedLocales", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_transcription_locales.json" + } + } + } + }, + "/transcriptions": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of transcriptions for the authenticated subscription.", + "operationId": "Transcriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available transcriptions.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedTranscriptions" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all transcriptions": { + "$ref": "./examples/get_transcriptions.json" + }, + "Get all failed transcriptions": { + "$ref": "./examples/get_failed_transcriptions.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Creates a new transcription.", + "operationId": "Transcriptions_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "transcription", + "description": "The details of the new transcription.", + "required": true, + "schema": { + "$ref": "#/definitions/Transcription" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a transcription for URIs": { + "$ref": "./examples/create_uri_transcription.json" + }, + "Create a transcription with basic two-speaker diarization": { + "$ref": "./examples/create_simple_diarization_transcription.json" + }, + "Create a transcription with multispeaker diarization": { + "$ref": "./examples/create_multispeaker_diarization_transcription.json" + }, + "Create a transcription with language identification": { + "$ref": "./examples/create_lid_transcription.json" + }, + "Create a transcription from blob container": { + "$ref": "./examples/create_container_transcription.json" + } + } + } + }, + "/transcriptions/{id}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the transcription identified by the given ID.", + "operationId": "Transcriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a transcription": { + "$ref": "./examples/get_transcription.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Updates the mutable details of the transcription identified by its ID.", + "operationId": "Transcriptions_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "transcriptionUpdate", + "description": "The updated values for the transcription.", + "required": true, + "schema": { + "$ref": "#/definitions/TranscriptionUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a transcription": { + "$ref": "./examples/update_transcription.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Deletes the specified transcription task.", + "operationId": "Transcriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The transcription was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a transcription": { + "$ref": "./examples/delete_transcription.json" + } + } + } + }, + "/transcriptions/{id}/files": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the files of the transcription identified by the given ID.", + "operationId": "Transcriptions_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav.json' and kind eq 'Transcription'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_transcription_files.json" + }, + "Get all transcription files the name of which starts with the specified string": { + "$ref": "./examples/get_transcription_files_filtered_by_name.json" + } + } + } + }, + "/transcriptions/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets one specific file (identified with fileId) from a transcription (identified with id).", + "operationId": "Transcriptions_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_transcription_file.json" + } + } + } + }, + "/webhooks": { + "get": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Gets the list of web hooks for the authenticated subscription.", + "operationId": "WebHooks_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available hooks.\r\n Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and webUrl.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'test'", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedWebHooks" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all web hooks": { + "$ref": "./examples/get_web_hooks.json" + }, + "Get all web hooks created in 03/2020 ordered by their name": { + "$ref": "./examples/get_web_hooks_from_march_2020.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Creates a new web hook.", + "description": "If the property secret in the configuration is present and contains a non-empty string, it will be used to create a SHA256 hash of the payload with\r\nthe secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.\r\n \r\nWhen calling back into the registered URL, the request will contain a X-MicrosoftSpeechServices-Event header containing one of the registered event\r\ntypes. There will be one request per registered event type.\r\n \r\nAfter successfully registering the web hook, it will not be usable until a challenge/response is completed. To do this, a request with the event type\r\nchallenge will be made with a query parameter called validationToken. Respond to the challenge with a 200 OK containing the value of the validationToken\r\nquery parameter as the response body. When the challenge/response is successfully completed, the web hook will begin receiving events.", + "operationId": "WebHooks_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "webHook", + "description": "The details of the new web hook.", + "required": true, + "schema": { + "$ref": "#/definitions/WebHook" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a web hook": { + "$ref": "./examples/create_web_hook.json" + } + } + } + }, + "/webhooks/{id}": { + "get": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Gets the web hook identified by the given ID.", + "operationId": "WebHooks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a web hook": { + "$ref": "./examples/get_web_hook.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Updates the web hook identified by the given ID.", + "description": "If the property secret in the configuration is omitted or contains an empty string, future callbacks won't contain X-MicrosoftSpeechServices-Signature\r\nheaders. If the property contains a non-empty string, it will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash\r\nwill be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.\r\n \r\nIf the URL changes, the web hook will stop receiving events until a\r\nchallenge/response is completed. To do this, a request with the event type challenge will be made with a query parameter called validationToken.\r\nRespond to the challenge with a 200 OK containing the value of the validationToken query parameter as the response body. When the challenge/response\r\nis successfully completed, the web hook will begin receiving events.", + "operationId": "WebHooks_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "webHookUpdate", + "description": "The updated values for the web hook.", + "required": true, + "schema": { + "$ref": "#/definitions/WebHookUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a web hook": { + "$ref": "./examples/update_web_hook.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Deletes the web hook identified by the given ID.", + "operationId": "WebHooks_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "The web hook was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a web hook": { + "$ref": "./examples/delete_web_hook.json" + } + } + } + }, + "/webhooks/{id}:ping": { + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Sends a ping event to the registered URL.", + "description": "The request body of the POST request sent to the registered web hook URL is of the same shape as in the GET request for a specific hook.\r\nThe Swagger Schema ID of the model is WebHookV3.\r\n \r\nThe request will contain a X-MicrosoftSpeechServices-Event header with the value ping. If the web hook was registered with\r\na secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with\r\nthe secret as HMAC key. The hash is base64 encoded.", + "operationId": "WebHooks_Ping", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook to ping.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "202": { + "description": "Started trying to send a ping request to the web hook.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Ping a web hook": { + "$ref": "./examples/ping_web_hook.json" + } + } + } + }, + "/webhooks/{id}:test": { + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Sends a request for each registered event type to the registered URL.", + "description": "The payload will be generated from the last entity that would have invoked the web hook. If no entity is present for none of the registered event types,\r\nthe POST will respond with 204. If a test request can be made, it will respond with 200.\r\nThe request will contain a X-MicrosoftSpeechServices-Event header with the respective registered event type.\r\nIf the web hook was registered with a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with\r\nthe secret as HMAC key. The hash is base64 encoded.", + "operationId": "WebHooks_Test", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook to ping.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "202": { + "description": "A test request with the last entity is sent to the registered web hook.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "No entity could be found for any event type, so no test request is sent to the registered web hook." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Test a web hook": { + "$ref": "./examples/test_web_hook.json" + } + } + } + } + }, + "definitions": { + "BaseModel": { + "title": "BaseModel", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModel" + } + ], + "properties": { + "links": { + "$ref": "#/definitions/BaseModelLinks" + }, + "properties": { + "$ref": "#/definitions/BaseModelProperties" + } + } + }, + "BaseModelDeprecationDates": { + "title": "BaseModelDeprecationDates", + "type": "object", + "properties": { + "adaptationDateTime": { + "format": "date-time", + "description": "The date when adaptation becomes deprecated.", + "type": "string", + "readOnly": true + }, + "transcriptionDateTime": { + "format": "date-time", + "description": "The date when transcription becomes deprecated.", + "type": "string", + "readOnly": true + } + } + }, + "BaseModelFeatures": { + "title": "BaseModelFeatures", + "description": "Features supported by the model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModelFeatures" + } + ], + "properties": { + "supportsAdaptationsWith": { + "description": "Supported dataset kinds to adapt the model.", + "type": "array", + "items": { + "$ref": "#/definitions/DatasetKind" + }, + "readOnly": true + } + } + }, + "BaseModelLinks": { + "title": "BaseModelLinks", + "type": "object", + "properties": { + "manifest": { + "format": "uri", + "description": "The location to get a manifest for this model to be used in the on-prem container. See operation \"Models_GetCustomModelManifest\" for more details.", + "type": "string", + "readOnly": true + } + } + }, + "BaseModelProperties": { + "title": "BaseModelProperties", + "type": "object", + "properties": { + "deprecationDates": { + "$ref": "#/definitions/BaseModelDeprecationDates" + }, + "features": { + "$ref": "#/definitions/BaseModelFeatures" + }, + "chargeForAdaptation": { + "description": "A value indicating whether model adaptation is charged.", + "type": "boolean", + "readOnly": true + } + } + }, + "BlockKind": { + "title": "BlockKind", + "description": "Type of data block.", + "enum": [ + "Committed", + "Uncommitted", + "Latest" + ], + "type": "string", + "x-ms-enum": { + "name": "BlockKind", + "modelAsString": true, + "values": [ + { + "value": "Committed", + "description": "A data block from the committed block list." + }, + { + "value": "Uncommitted", + "description": "A data block from the uncommitted block list." + }, + { + "value": "Latest", + "description": "A data block from the uncommitted block list, if present, otherwise from the committed block list." + } + ] + } + }, + "CommitBlocksEntry": { + "title": "CommitBlocksEntry", + "description": "Entry of the commit block list.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/BlockKind" + }, + "id": { + "type": "string" + } + } + }, + "CustomModel": { + "title": "CustomModel", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModel" + } + ], + "properties": { + "links": { + "$ref": "#/definitions/CustomModelLinks" + }, + "properties": { + "$ref": "#/definitions/CustomModelProperties" + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "text": { + "description": "The text used to adapt this language model.", + "type": "string" + }, + "baseModel": { + "$ref": "#/definitions/EntityReference" + }, + "datasets": { + "description": "Datasets used for adaptation.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityReference" + } + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CustomModelDeprecationDates": { + "title": "CustomModelDeprecationDates", + "type": "object", + "properties": { + "transcriptionDateTime": { + "format": "date-time", + "description": "The date when transcription becomes deprecated.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "CustomModelFeatures": { + "title": "CustomModelFeatures", + "description": "Features supported by the model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModelFeatures" + } + ], + "readOnly": true + }, + "CustomModelLinks": { + "title": "CustomModelLinks", + "type": "object", + "properties": { + "copy": { + "format": "uri", + "description": "The location to the model copy action. See operation \"Models_Copy\" for more details.", + "type": "string", + "readOnly": true + }, + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Models_ListFiles\" for more details.", + "type": "string", + "readOnly": true + }, + "manifest": { + "format": "uri", + "description": "The location to get a manifest for this model to be used in the on-prem container. See operation \"Models_GetCustomModelManifest\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "CustomModelProperties": { + "title": "CustomModelProperties", + "type": "object", + "properties": { + "customModelWeightPercent": { + "format": "int32", + "description": "The weight of custom model between 1 (1% custom model and 99% base model) and 100 (100% custom model and 0% base model).\r\nWhen this property is not set, the service chooses a suitable value (get the model to retrieve the selected weight).\r\nStart without using this property. If needed, choose a larger (or smaller) weight to increase (or decrease) the impact of the custom model.", + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "deprecationDates": { + "$ref": "#/definitions/CustomModelDeprecationDates" + }, + "features": { + "$ref": "#/definitions/CustomModelFeatures" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + } + }, + "Dataset": { + "title": "Dataset", + "required": [ + "displayName", + "kind", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/DatasetLinks" + }, + "properties": { + "$ref": "#/definitions/DatasetProperties" + }, + "kind": { + "$ref": "#/definitions/DatasetKind" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "contentUrl": { + "format": "uri", + "description": "The URL of the data for the dataset.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "DatasetKind": { + "title": "DatasetKind", + "description": "Type of data import.", + "enum": [ + "Language", + "Acoustic", + "Pronunciation", + "AudioFiles", + "LanguageMarkdown", + "OutputFormatting" + ], + "type": "string", + "x-ms-enum": { + "name": "DatasetKind", + "modelAsString": true, + "values": [ + { + "value": "Language", + "description": "A language dataset." + }, + { + "value": "Acoustic", + "description": "An acoustic dataset." + }, + { + "value": "Pronunciation", + "description": "A pronunciation dataset." + }, + { + "value": "AudioFiles", + "description": "An audio files dataset." + }, + { + "value": "LanguageMarkdown", + "description": "A language markdown dataset." + }, + { + "value": "OutputFormatting", + "description": "Dataset that contains rules to customize inverse text normalization, capitalization, reformulation, profanity and also defines tests for dataset validation" + } + ] + } + }, + "DatasetLinks": { + "title": "DatasetLinks", + "type": "object", + "properties": { + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Datasets_ListFiles\" for more details.", + "type": "string", + "readOnly": true + }, + "commitBlocks": { + "format": "uri", + "description": "The location to commit the list of blocks when uploading a dataset using blocks. See operation \"Datasets_CommitBlocks\" for more details.", + "type": "string", + "readOnly": true + }, + "listBlocks": { + "format": "uri", + "description": "The location to list the already uploaded blocks of this entity when uploading a dataset using blocks. See operation \"Datasets_GetBlocks\" for more details.", + "type": "string", + "readOnly": true + }, + "uploadBlocks": { + "format": "uri", + "description": "The location to upload blocks to when uploading a dataset using blocks. See operation \"Datasets_UploadBlock\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "DatasetLocales": { + "title": "DatasetLocales", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/DatasetKind" + } + } + }, + "DatasetProperties": { + "title": "DatasetProperties", + "type": "object", + "properties": { + "textNormalizationKind": { + "$ref": "#/definitions/TextNormalizationKind" + }, + "acceptedLineCount": { + "format": "int32", + "description": "The number of lines accepted for this data set.", + "type": "integer", + "readOnly": true + }, + "rejectedLineCount": { + "format": "int32", + "description": "The number of lines rejected for this data set.", + "type": "integer", + "readOnly": true + }, + "duration": { + "description": "The total duration of the datasets if it contains audio files. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + } + }, + "DatasetUpdate": { + "title": "DatasetUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "DetailedErrorCode": { + "title": "DetailedErrorCode", + "description": "Detailed error code enum.", + "enum": [ + "InvalidParameterValue", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputRecords", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "DataImportFailed", + "InUseViolation", + "InvalidLocale", + "InvalidBaseModel", + "InvalidAdaptationMapping", + "InvalidDataset", + "InvalidTest", + "FailedDataset", + "InvalidModel", + "InvalidTranscription", + "InvalidPayload", + "InvalidParameter", + "EndpointWithoutLogging", + "InvalidPermissions", + "InvalidPrerequisite", + "InvalidProductId", + "InvalidSubscription", + "InvalidProject", + "InvalidProjectKind", + "InvalidRecordingsUri", + "OnlyOneOfUrlsOrContainerOrDataset", + "ExceededNumberOfRecordingsUris", + "InvalidChannels", + "ModelMismatch", + "ProjectGenderMismatch", + "ModelDeprecated", + "ModelExists", + "ModelNotDeployable", + "EndpointNotUpdatable", + "SingleDefaultEndpoint", + "EndpointCannotBeDefault", + "InvalidModelUri", + "SubscriptionNotFound", + "QuotaViolation", + "UnsupportedDelta", + "UnsupportedFilter", + "UnsupportedPagination", + "UnsupportedDynamicConfiguration", + "UnsupportedOrderBy", + "NoUtf8WithBom", + "ModelDeploymentNotCompleteState", + "SkuLimitsExist", + "DeployingFailedModel", + "UnsupportedTimeRange", + "InvalidLogDate", + "InvalidLogId", + "InvalidLogStartTime", + "InvalidLogEndTime", + "InvalidTopForLogs", + "InvalidSkipTokenForLogs", + "DeleteNotAllowed", + "Forbidden", + "DeployNotAllowed", + "UnexpectedError", + "InvalidCollection", + "InvalidCallbackUri", + "InvalidSasValidityDuration", + "InaccessibleCustomerStorage", + "UnsupportedClassBasedAdaptation", + "InvalidWebHookEventKind", + "InvalidTimeToLive", + "InvalidSourceAzureResourceId", + "ModelCopyAuthorizationExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "DetailedErrorCode", + "modelAsString": true, + "values": [ + { + "value": "InvalidParameterValue", + "description": "Invalid parameter value." + }, + { + "value": "InvalidRequestBodyFormat", + "description": "Invalid request body format." + }, + { + "value": "EmptyRequest", + "description": "Empty Request." + }, + { + "value": "MissingInputRecords", + "description": "Missing Input Records." + }, + { + "value": "InvalidDocument", + "description": "Invalid Document." + }, + { + "value": "ModelVersionIncorrect", + "description": "Model Version Incorrect." + }, + { + "value": "InvalidDocumentBatch", + "description": "Invalid Document Batch." + }, + { + "value": "UnsupportedLanguageCode", + "description": "Unsupported language code." + }, + { + "value": "DataImportFailed", + "description": "Data import failed." + }, + { + "value": "InUseViolation", + "description": "In use violation." + }, + { + "value": "InvalidLocale", + "description": "Invalid locale." + }, + { + "value": "InvalidBaseModel", + "description": "Invalid base model." + }, + { + "value": "InvalidAdaptationMapping", + "description": "Invalid adaptation mapping." + }, + { + "value": "InvalidDataset", + "description": "Invalid dataset." + }, + { + "value": "InvalidTest", + "description": "Invalid test." + }, + { + "value": "FailedDataset", + "description": "Failed dataset." + }, + { + "value": "InvalidModel", + "description": "Invalid model." + }, + { + "value": "InvalidTranscription", + "description": "Invalid transcription." + }, + { + "value": "InvalidPayload", + "description": "Invalid payload." + }, + { + "value": "InvalidParameter", + "description": "Invalid parameter." + }, + { + "value": "EndpointWithoutLogging", + "description": "Endpoint without logging." + }, + { + "value": "InvalidPermissions", + "description": "Invalid permissions." + }, + { + "value": "InvalidPrerequisite", + "description": "Invalid prerequisite." + }, + { + "value": "InvalidProductId", + "description": "Invalid product id." + }, + { + "value": "InvalidSubscription", + "description": "Invalid subscription." + }, + { + "value": "InvalidProject", + "description": "Invalid project." + }, + { + "value": "InvalidProjectKind", + "description": "Invalid project kind." + }, + { + "value": "InvalidRecordingsUri", + "description": "Invalid recordings uri." + }, + { + "value": "OnlyOneOfUrlsOrContainerOrDataset", + "description": "Only one of urls or container or dataset." + }, + { + "value": "ExceededNumberOfRecordingsUris", + "description": "Exceeded number of recordings uris." + }, + { + "value": "InvalidChannels", + "description": "Invalid channels." + }, + { + "value": "ModelMismatch", + "description": "Model mismatch." + }, + { + "value": "ProjectGenderMismatch", + "description": "Project gender mismatch." + }, + { + "value": "ModelDeprecated", + "description": "Model deprecated." + }, + { + "value": "ModelExists", + "description": "Model exists." + }, + { + "value": "ModelNotDeployable", + "description": "Model not deployable." + }, + { + "value": "EndpointNotUpdatable", + "description": "Endpoint not updatable." + }, + { + "value": "SingleDefaultEndpoint", + "description": "Single default endpoint." + }, + { + "value": "EndpointCannotBeDefault", + "description": "Endpoint cannot be default." + }, + { + "value": "InvalidModelUri", + "description": "Invalid model uri." + }, + { + "value": "SubscriptionNotFound", + "description": "Subscription not found." + }, + { + "value": "QuotaViolation", + "description": "Quota violation." + }, + { + "value": "UnsupportedDelta", + "description": "Unsupported delta." + }, + { + "value": "UnsupportedFilter", + "description": "Unsupported filter." + }, + { + "value": "UnsupportedPagination", + "description": "Unsupported pagination." + }, + { + "value": "UnsupportedDynamicConfiguration", + "description": "Unsupported dynamic configuration." + }, + { + "value": "UnsupportedOrderBy", + "description": "Unsupported order by." + }, + { + "value": "NoUtf8WithBom", + "description": "No utf8 with bom." + }, + { + "value": "ModelDeploymentNotCompleteState", + "description": "Model deployment not complete state." + }, + { + "value": "SkuLimitsExist", + "description": "Sku limits exist." + }, + { + "value": "DeployingFailedModel", + "description": "Deploying failed model." + }, + { + "value": "UnsupportedTimeRange", + "description": "Unsupported time range." + }, + { + "value": "InvalidLogDate", + "description": "Invalid log date." + }, + { + "value": "InvalidLogId", + "description": "Invalid log id." + }, + { + "value": "InvalidLogStartTime", + "description": "Invalid log start time." + }, + { + "value": "InvalidLogEndTime", + "description": "Invalid log end time." + }, + { + "value": "InvalidTopForLogs", + "description": "Invalid top for logs." + }, + { + "value": "InvalidSkipTokenForLogs", + "description": "Invalid skip token for logs." + }, + { + "value": "DeleteNotAllowed", + "description": "Delete not allowed." + }, + { + "value": "Forbidden", + "description": "Forbidden." + }, + { + "value": "DeployNotAllowed", + "description": "Deploy not allowed." + }, + { + "value": "UnexpectedError", + "description": "Unexpected error." + }, + { + "value": "InvalidCollection", + "description": "Invalid collection." + }, + { + "value": "InvalidCallbackUri", + "description": "Invalid callback uri." + }, + { + "value": "InvalidSasValidityDuration", + "description": "Invalid sas validity duration." + }, + { + "value": "InaccessibleCustomerStorage", + "description": "Inaccessible customer storage." + }, + { + "value": "UnsupportedClassBasedAdaptation", + "description": "Unsupported class based adaptation." + }, + { + "value": "InvalidWebHookEventKind", + "description": "Invalid web hook event kind." + }, + { + "value": "InvalidTimeToLive", + "description": "Invalid time to live." + }, + { + "value": "InvalidSourceAzureResourceId", + "description": "Invalid source Azure resource ID." + }, + { + "value": "ModelCopyAuthorizationExpired", + "description": "Expired ModelCopyAuthorization." + } + ] + } + }, + "DiarizationProperties": { + "title": "DiarizationProperties", + "required": [ + "speakers" + ], + "type": "object", + "properties": { + "speakers": { + "$ref": "#/definitions/DiarizationSpeakersProperties" + } + } + }, + "DiarizationSpeakersProperties": { + "title": "DiarizationSpeakersProperties", + "type": "object", + "properties": { + "minCount": { + "format": "int32", + "description": "A hint for the minimum number of speakers for diarization. Must be smaller than or equal to the maxSpeakers property.", + "minimum": 1, + "type": "integer" + }, + "maxCount": { + "format": "int32", + "description": "The maximum number of speakers for diarization. Must be less than 36 and larger than or equal to the minSpeakers property.", + "minimum": 1, + "type": "integer" + } + } + }, + "EditsSummary": { + "title": "EditsSummary", + "type": "object", + "properties": { + "numberOfEdits": { + "format": "int32", + "description": "The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription.", + "type": "integer", + "readOnly": true + }, + "percentageOfAllEdits": { + "format": "double", + "description": "The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription.", + "type": "number", + "readOnly": true + } + }, + "readOnly": true + }, + "Endpoint": { + "title": "Endpoint", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/EndpointLinks" + }, + "properties": { + "$ref": "#/definitions/EndpointProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "text": { + "description": "The text used to adapt a language model for this endpoint.", + "type": "string" + }, + "model": { + "$ref": "#/definitions/EntityReference" + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "EndpointLinks": { + "title": "EndpointLinks", + "type": "object", + "properties": { + "restInteractive": { + "format": "uri", + "description": "The REST endpoint for short requests up to 15 seconds.", + "type": "string", + "readOnly": true + }, + "restConversation": { + "format": "uri", + "description": "The REST endpoint for requests up to 60 seconds.", + "type": "string", + "readOnly": true + }, + "restDictation": { + "format": "uri", + "description": "The REST endpoint for requests up to 60 seconds, supporting dictation of punctuation marks.", + "type": "string", + "readOnly": true + }, + "webSocketInteractive": { + "format": "uri", + "description": "The Speech SDK endpoint for short requests up to 15 seconds with a single final result.", + "type": "string", + "readOnly": true + }, + "webSocketConversation": { + "format": "uri", + "description": "The Speech SDK endpoint for long requests with multiple final results.", + "type": "string", + "readOnly": true + }, + "webSocketDictation": { + "format": "uri", + "description": "The Speech SDK endpoint for long requests with multiple final results, supporting dictation of\r\npunctuation marks.", + "type": "string", + "readOnly": true + }, + "logs": { + "format": "uri", + "description": "The audio and transcription logs for this endpoint. See operation \"Endpoints_ListLogs\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "EndpointProperties": { + "title": "EndpointProperties", + "type": "object", + "properties": { + "loggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.", + "type": "boolean" + }, + "timeToLive": { + "description": "How long the endpoint will be kept in the system. Once the endpoint reaches the time to live\r\nafter completion (successful or failed) it will be automatically deleted. Not setting this value or setting\r\nto 0 will disable automatic deletion. The longest supported duration is 31 days.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + } + }, + "EndpointPropertiesUpdate": { + "title": "EndpointPropertiesUpdate", + "type": "object", + "properties": { + "contentLoggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions)\r\nis being used for a deployment.", + "type": "boolean" + } + } + }, + "EndpointUpdate": { + "title": "EndpointUpdate", + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/EntityReference" + }, + "properties": { + "$ref": "#/definitions/EndpointPropertiesUpdate" + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "EntityError": { + "title": "EntityError", + "type": "object", + "properties": { + "code": { + "description": "The code of this error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message for this error.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "EntityReference": { + "title": "EntityReference", + "required": [ + "self" + ], + "type": "object", + "properties": { + "self": { + "format": "uri", + "description": "The location of the referenced entity.", + "type": "string" + } + } + }, + "Error": { + "title": "Error", + "description": "New format which conforms to the new Cognitive Services API guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains an outer error with error code, message, details, target and an inner error with more descriptive details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode" + }, + "details": { + "description": "Additional supportive details regarding the error and/or expected policies.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "message": { + "description": "High level error message.", + "type": "string" + }, + "target": { + "description": "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string" + }, + "innerError": { + "$ref": "#/definitions/InnerError" + } + } + }, + "ErrorCode": { + "title": "ErrorCode", + "description": "High level error codes.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "InternalServerError", + "ServiceUnavailable", + "NotFound", + "PipelineError", + "Conflict", + "InternalCommunicationFailed", + "Forbidden", + "NotAllowed", + "Unauthorized", + "UnsupportedMediaType", + "TooManyRequests", + "UnprocessableEntity" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "value": "InvalidRequest", + "description": "Representing the invalid request error code." + }, + { + "value": "InvalidArgument", + "description": "Representing the invalid argument error code." + }, + { + "value": "InternalServerError", + "description": "Representing the internal server error error code." + }, + { + "value": "ServiceUnavailable", + "description": "Representing the service unavailable error code." + }, + { + "value": "NotFound", + "description": "Representing the not found error code." + }, + { + "value": "PipelineError", + "description": "Representing the pipeline error error code." + }, + { + "value": "Conflict", + "description": "Representing the conflict error code." + }, + { + "value": "InternalCommunicationFailed", + "description": "Representing the internal communication failed error code." + }, + { + "value": "Forbidden", + "description": "Representing the forbidden error code." + }, + { + "value": "NotAllowed", + "description": "Representing the not allowed error code." + }, + { + "value": "Unauthorized", + "description": "Representing the unauthorized error code." + }, + { + "value": "UnsupportedMediaType", + "description": "Representing the unsupported media type error code." + }, + { + "value": "TooManyRequests", + "description": "Representing the too many requests error code." + }, + { + "value": "UnprocessableEntity", + "description": "Representing the unprocessable entity error code." + } + ] + } + }, + "Evaluation": { + "title": "Evaluation", + "required": [ + "dataset", + "displayName", + "locale", + "model1", + "model2" + ], + "type": "object", + "properties": { + "model1": { + "$ref": "#/definitions/EntityReference" + }, + "model2": { + "$ref": "#/definitions/EntityReference" + }, + "transcription1": { + "$ref": "#/definitions/EntityReference" + }, + "transcription2": { + "$ref": "#/definitions/EntityReference" + }, + "dataset": { + "$ref": "#/definitions/EntityReference" + }, + "links": { + "$ref": "#/definitions/EvaluationLinks" + }, + "properties": { + "$ref": "#/definitions/EvaluationProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "EvaluationLinks": { + "title": "EvaluationLinks", + "type": "object", + "properties": { + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Evaluations_ListFiles\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "EvaluationProperties": { + "title": "EvaluationProperties", + "type": "object", + "properties": { + "wordErrorRate1": { + "format": "double", + "description": "The word error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "sentenceErrorRate1": { + "format": "double", + "description": "The sentence error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "tokenErrorRate1": { + "format": "double", + "description": "The optional token error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "sentenceCount1": { + "format": "int32", + "description": "The number of processed sentences by model1.", + "type": "integer", + "readOnly": true + }, + "wordCount1": { + "format": "int32", + "description": "The number of processed words by model1.", + "type": "integer", + "readOnly": true + }, + "correctWordCount1": { + "format": "int32", + "description": "The number of correctly recognized words by model1.", + "type": "integer", + "readOnly": true + }, + "wordSubstitutionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "wordDeletionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are deletions.", + "type": "integer", + "readOnly": true + }, + "wordInsertionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenCount1": { + "format": "int32", + "description": "Optional the number of processed tokens by model1.", + "type": "integer", + "readOnly": true + }, + "correctTokenCount1": { + "format": "int32", + "description": "The optional number of correctly recognized tokens by model1.", + "type": "integer", + "readOnly": true + }, + "tokenSubstitutionCount1": { + "format": "int32", + "description": "The optional number of recognized tokens by model1, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "tokenDeletionCount1": { + "format": "int32", + "description": "The optional number of recognized tokens by model1, that are deletions.", + "type": "integer", + "readOnly": true + }, + "tokenInsertionCount1": { + "format": "int32", + "description": "The optional number of recognized tokens by model1, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenErrors1": { + "$ref": "#/definitions/TokenErrorDetails" + }, + "wordErrorRate2": { + "format": "double", + "description": "The word error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "sentenceErrorRate2": { + "format": "double", + "description": "The sentence error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "tokenErrorRate2": { + "format": "double", + "description": "The optional token error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "sentenceCount2": { + "format": "int32", + "description": "The number of processed sentences by model2.", + "type": "integer", + "readOnly": true + }, + "wordCount2": { + "format": "int32", + "description": "The number of processed words by model2.", + "type": "integer", + "readOnly": true + }, + "correctWordCount2": { + "format": "int32", + "description": "The number of correctly recognized words by model2.", + "type": "integer", + "readOnly": true + }, + "wordSubstitutionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "wordDeletionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are deletions.", + "type": "integer", + "readOnly": true + }, + "wordInsertionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenCount2": { + "format": "int32", + "description": "The optional number of processed tokens by model2.", + "type": "integer", + "readOnly": true + }, + "correctTokenCount2": { + "format": "int32", + "description": "The optional number of correctly recognized tokens by model2.", + "type": "integer", + "readOnly": true + }, + "tokenSubstitutionCount2": { + "format": "int32", + "description": "The optional number of recognized tokens by model2, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "tokenDeletionCount2": { + "format": "int32", + "description": "The optional number of recognized tokens by model2, that are deletions.", + "type": "integer", + "readOnly": true + }, + "tokenInsertionCount2": { + "format": "int32", + "description": "The optional number of recognized tokens by model2, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenErrors2": { + "$ref": "#/definitions/TokenErrorDetails" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + }, + "readOnly": true + }, + "EvaluationUpdate": { + "title": "EvaluationUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "File": { + "title": "File", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/FileKind" + }, + "links": { + "$ref": "#/definitions/FileLinks" + }, + "createdDateTime": { + "format": "date-time", + "description": "The creation time of this file.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/FileProperties" + }, + "name": { + "description": "The name of this file.", + "type": "string", + "readOnly": true + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + } + } + }, + "FileKind": { + "title": "FileKind", + "description": "Type of data.", + "enum": [ + "DatasetReport", + "Audio", + "LanguageData", + "PronunciationData", + "AcousticDataArchive", + "AcousticDataTranscriptionV2", + "Transcription", + "TranscriptionReport", + "EvaluationDetails", + "ModelReport", + "OutputFormattingData" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FileKind", + "modelAsString": true, + "values": [ + { + "value": "DatasetReport", + "description": "Type of data is dataset report." + }, + { + "value": "Audio", + "description": "Type of data is audio." + }, + { + "value": "LanguageData", + "description": "Type of data is language data." + }, + { + "value": "PronunciationData", + "description": "Type of data is pronunciation data." + }, + { + "value": "AcousticDataArchive", + "description": "Type of data is acoustic data archive." + }, + { + "value": "AcousticDataTranscriptionV2", + "description": "Type of data is acoustic data transcription v2." + }, + { + "value": "Transcription", + "description": "Type of data is transcription." + }, + { + "value": "TranscriptionReport", + "description": "Type of data is transcription report." + }, + { + "value": "EvaluationDetails", + "description": "Type of data is evaluation details." + }, + { + "value": "ModelReport", + "description": "Type of data is model report." + }, + { + "value": "OutputFormattingData", + "description": "Type of data is output formatting input file." + } + ] + } + }, + "FileLinks": { + "title": "FileLinks", + "type": "object", + "properties": { + "contentUrl": { + "format": "uri", + "description": "The url to retrieve the content of this file.", + "type": "string", + "readOnly": true + } + } + }, + "FileProperties": { + "title": "FileProperties", + "type": "object", + "properties": { + "size": { + "format": "int64", + "description": "The size of the data in bytes.", + "type": "integer", + "readOnly": true + }, + "duration": { + "description": "The duration in case this file is an audio file. The duration is encoded as ISO 8601\r\nduration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + } + } + }, + "InnerError": { + "title": "InnerError", + "description": "New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/DetailedErrorCode" + }, + "details": { + "description": "Additional supportive details regarding the error and/or expected policies.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "message": { + "description": "High level error message.", + "type": "string" + }, + "target": { + "description": "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string" + }, + "innerError": { + "$ref": "#/definitions/InnerError" + } + } + }, + "LanguageIdentificationMode": { + "title": "LanguageIdentificationMode", + "description": "The mode used for language identification.", + "default": "Continuous", + "enum": [ + "Continuous", + "Single" + ], + "type": "string", + "x-ms-enum": { + "name": "LanguageIdentificationMode", + "modelAsString": true, + "values": [ + { + "value": "Continuous", + "description": "Continuous language identification (Default)." + }, + { + "value": "Single", + "description": "Single language identification." + } + ] + } + }, + "LanguageIdentificationProperties": { + "title": "LanguageIdentificationProperties", + "required": [ + "candidateLocales" + ], + "type": "object", + "properties": { + "mode": { + "$ref": "#/definitions/LanguageIdentificationMode" + }, + "candidateLocales": { + "description": "The candidate locales for language identification (example [\"en-US\", \"de-DE\", \"es-ES\"]). A minimum of 2 and a maximum of 10 candidate locales, including the main locale for the transcription, is supported for continuous mode. For single language identification, the maximum number of candidate locales is unbounded.", + "type": "array", + "items": { + "type": "string" + } + }, + "speechModelMapping": { + "description": "An optional mapping of locales to speech model entities. If no model is given for a locale, the default base model is used.\r\nKeys must be locales contained in the candidate locales, values are entities for models of the respective locales.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/EntityReference" + } + } + } + }, + "ModelCopyAuthorization": { + "title": "ModelCopyAuthorization", + "required": [ + "expirationDateTime", + "id", + "sourceResourceId", + "targetResourceEndpoint", + "targetResourceId", + "targetResourceRegion" + ], + "type": "object", + "properties": { + "targetResourceRegion": { + "description": "The region (aka location) of the target speech resource (e.g., westus2).", + "minLength": 1, + "type": "string" + }, + "targetResourceId": { + "description": "The Azure Resource ID of the target speech resource.", + "minLength": 1, + "type": "string" + }, + "targetResourceEndpoint": { + "description": "The endpoint (base url) of the target resource (with custom domain name when it is used).", + "minLength": 1, + "type": "string" + }, + "sourceResourceId": { + "description": "The Azure Resource ID of the source speech resource.", + "minLength": 1, + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "The expiration date of this copy authorization.", + "type": "string" + }, + "id": { + "description": "The ID of this copy authorization.", + "minLength": 1, + "type": "string" + } + } + }, + "ModelCopyAuthorizationDefinition": { + "title": "ModelCopyAuthorizationDefinition", + "required": [ + "sourceResourceId" + ], + "type": "object", + "properties": { + "sourceResourceId": { + "description": "The Azure Resource ID of the source speech resource.", + "minLength": 1, + "type": "string" + } + } + }, + "ModelFile": { + "title": "ModelFile", + "type": "object", + "properties": { + "name": { + "description": "The name of this file.", + "type": "string", + "readOnly": true + }, + "contentUrl": { + "format": "uri", + "description": "The url to retrieve the content of this file.", + "type": "string", + "readOnly": true + } + } + }, + "ModelManifest": { + "title": "ModelManifest", + "required": [ + "model", + "modelFiles", + "properties" + ], + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/EntityReference" + }, + "modelFiles": { + "description": "The model files of this model.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelFile" + } + }, + "properties": { + "description": "The configuration for running this model in a container.", + "type": "object", + "additionalProperties": {} + } + } + }, + "ModelUpdate": { + "title": "ModelUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "Operation": { + "title": "Operation", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this Operation.", + "type": "string" + }, + "result": { + "$ref": "#/definitions/OperationResult" + }, + "error": { + "$ref": "#/definitions/EntityError" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "OperationResult": { + "title": "OperationResult", + "type": "object", + "properties": { + "link": { + "format": "uri", + "description": "The link to the result of the operation.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "OutputFormatType": { + "title": "OutputFormatType", + "enum": [ + "Lexical", + "Display" + ], + "type": "string", + "x-ms-enum": { + "name": "OutputFormatType", + "modelAsString": true, + "values": [ + { + "value": "Lexical", + "description": "Model provides the transcription output without formatting." + }, + { + "value": "Display", + "description": "Model supports display formatting transcriptions output or endpoints." + } + ] + } + }, + "PaginatedBaseModels": { + "title": "PaginatedBaseModels", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/BaseModel" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedCustomModels": { + "title": "PaginatedCustomModels", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomModel" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedDatasets": { + "title": "PaginatedDatasets", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Dataset" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedEndpoints": { + "title": "PaginatedEndpoints", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedEvaluations": { + "title": "PaginatedEvaluations", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Evaluation" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedFiles": { + "title": "PaginatedFiles", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedProjects": { + "title": "PaginatedProjects", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Project" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedTranscriptions": { + "title": "PaginatedTranscriptions", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Transcription" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedWebHooks": { + "title": "PaginatedWebHooks", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/WebHook" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "ProfanityFilterMode": { + "title": "ProfanityFilterMode", + "description": "Mode of profanity filtering.", + "enum": [ + "None", + "Removed", + "Tags", + "Masked" + ], + "type": "string", + "x-ms-enum": { + "name": "ProfanityFilterMode", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "Disable profanity filtering." + }, + { + "value": "Removed", + "description": "Remove profanity." + }, + { + "value": "Tags", + "description": "Add \"profanity\" XML tags</Profanity>" + }, + { + "value": "Masked", + "description": "Mask the profanity with * except of the first letter, e.g., f***" + } + ] + } + }, + "Project": { + "title": "Project", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/ProjectLinks" + }, + "properties": { + "$ref": "#/definitions/ProjectProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "ProjectLinks": { + "title": "ProjectLinks", + "type": "object", + "properties": { + "evaluations": { + "format": "uri", + "description": "The location to get a list of all evaluations of this project. See operation \"Projects_ListEvaluations\" for more details.", + "type": "string", + "readOnly": true + }, + "datasets": { + "format": "uri", + "description": "The location to get a list of all datasets of this project. See operation \"Projects_ListDatasets\" for more details.", + "type": "string", + "readOnly": true + }, + "models": { + "format": "uri", + "description": "The location to get a list of all models of this project. See operation \"Projects_ListModels\" for more details.", + "type": "string", + "readOnly": true + }, + "endpoints": { + "format": "uri", + "description": "The location to get a list of all endpoints of this project. See operation \"Projects_ListEndpoints\" for more details.", + "type": "string", + "readOnly": true + }, + "transcriptions": { + "format": "uri", + "description": "The location to get a list of all transcriptions of this project. See operation \"Projects_ListTranscriptions\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "ProjectProperties": { + "title": "ProjectProperties", + "type": "object", + "properties": { + "datasetCount": { + "format": "int32", + "description": "The number of datasets associated to this project.", + "type": "integer", + "readOnly": true + }, + "evaluationCount": { + "format": "int32", + "description": "The number of evaluations associated to this project.", + "type": "integer", + "readOnly": true + }, + "modelCount": { + "format": "int32", + "description": "The number of models associated to this project.", + "type": "integer", + "readOnly": true + }, + "transcriptionCount": { + "format": "int32", + "description": "The number of transcriptions associated to this project.", + "type": "integer", + "readOnly": true + }, + "endpointCount": { + "format": "int32", + "description": "The number of endpoints associated to this project.", + "type": "integer", + "readOnly": true + } + }, + "readOnly": true + }, + "ProjectUpdate": { + "title": "ProjectUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PunctuationMode": { + "title": "PunctuationMode", + "description": "The mode used for punctuation.", + "enum": [ + "None", + "Dictated", + "Automatic", + "DictatedAndAutomatic" + ], + "type": "string", + "x-ms-enum": { + "name": "PunctuationMode", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "No punctuation." + }, + { + "value": "Dictated", + "description": "Dictated punctuation marks only, i.e., explicit punctuation." + }, + { + "value": "Automatic", + "description": "Automatic punctuation." + }, + { + "value": "DictatedAndAutomatic", + "description": "Dictated punctuation marks or automatic punctuation." + } + ] + } + }, + "ResponseBlock": { + "title": "ResponseBlock", + "description": "ResponseBlock.", + "type": "object", + "properties": { + "name": { + "description": "The name of the block.", + "type": "string" + }, + "size": { + "format": "int32", + "description": "The size of the block.", + "type": "integer" + } + } + }, + "SharedModel": { + "title": "SharedModel", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "SharedModelFeatures": { + "title": "SharedModelFeatures", + "description": "Features supported by the model.", + "type": "object", + "properties": { + "supportsTranscriptions": { + "description": "A value indicating whether batch transcription is supported.", + "type": "boolean", + "readOnly": true + }, + "supportsEndpoints": { + "description": "A value indicating whether creation of endpoints for live transcription is supported.", + "type": "boolean", + "readOnly": true + }, + "supportsTranscriptionsOnSpeechContainers": { + "description": "A value indicating whether this model can be used for transcription on speech container. This feature can be added on existing models when it becomes usable on speech container.", + "type": "boolean", + "readOnly": true + }, + "supportedOutputFormats": { + "description": "Supported output formats.", + "type": "array", + "items": { + "$ref": "#/definitions/OutputFormatType" + }, + "readOnly": true + } + } + }, + "Status": { + "title": "Status", + "description": "Describe the current state of the API.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false, + "values": [ + { + "value": "NotStarted", + "description": "The long running operation has not yet started." + }, + { + "value": "Running", + "description": "The long running operation is currently processing." + }, + { + "value": "Succeeded", + "description": "The long running operation has successfully completed." + }, + { + "value": "Failed", + "description": "The long running operation has failed." + } + ] + } + }, + "TextNormalizationKind": { + "title": "TextNormalizationKind", + "description": "The kind of text normalization.", + "enum": [ + "Default", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "TextNormalizationKind", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Default text normalization (e.g. '2 to 3' is replaced by 'two to three' in en-US)." + }, + { + "value": "None", + "description": "No text normalization will be applied to the input text. This is an override option that should only be used when text is normalized before the upload." + } + ] + } + }, + "TokenErrorDetails": { + "title": "TokenErrorDetails", + "type": "object", + "properties": { + "punctuation": { + "$ref": "#/definitions/EditsSummary" + }, + "capitalization": { + "$ref": "#/definitions/EditsSummary" + }, + "inverseTextNormalization": { + "$ref": "#/definitions/EditsSummary" + }, + "lexical": { + "$ref": "#/definitions/EditsSummary" + }, + "others": { + "$ref": "#/definitions/EditsSummary" + } + }, + "readOnly": true + }, + "Transcription": { + "title": "Transcription", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/TranscriptionLinks" + }, + "properties": { + "$ref": "#/definitions/TranscriptionProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "model": { + "$ref": "#/definitions/EntityReference" + }, + "dataset": { + "$ref": "#/definitions/EntityReference" + }, + "contentUrls": { + "description": "A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed.\r\nThis property will not be returned in a response.", + "type": "array", + "items": { + "format": "uri", + "type": "string" + } + }, + "contentContainerUrl": { + "format": "uri", + "description": "A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs.\r\nThe maximum size for a blob is 2.5GB.\r\nContainer SAS should contain 'r' (read) and 'l' (list) permissions.\r\nThis property will not be returned in a response.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected.", + "minLength": 1, + "type": "string" + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "TranscriptionLinks": { + "title": "TranscriptionLinks", + "type": "object", + "properties": { + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Transcriptions_ListFiles\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "TranscriptionProperties": { + "title": "TranscriptionProperties", + "type": "object", + "properties": { + "wordLevelTimestampsEnabled": { + "description": "A value indicating whether word level timestamps are requested. The default value is\r\n`false`.", + "type": "boolean" + }, + "displayFormWordLevelTimestampsEnabled": { + "description": "A value indicating whether word level timestamps for the display form are requested. The default value is `false`.", + "type": "boolean" + }, + "duration": { + "description": "The duration of the transcription. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + }, + "channels": { + "description": "A collection of the requested channel numbers.\r\nIn the default case, the channels 0 and 1 are considered.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "destinationContainerUrl": { + "format": "uri", + "description": "The requested destination container.\r\n### Remarks ###\r\nWhen a destination container is used in combination with a `timeToLive`, the metadata of a\r\ntranscription will be deleted normally, but the data stored in the destination container, including\r\ntranscription results, will remain untouched, because no delete permissions are required for this\r\ncontainer.
\r\nTo support automatic cleanup, either configure blob lifetimes on the container, or use \"Bring your own Storage (BYOS)\"\r\ninstead of `destinationContainerUrl`, where blobs can be cleaned up.", + "type": "string" + }, + "punctuationMode": { + "$ref": "#/definitions/PunctuationMode" + }, + "profanityFilterMode": { + "$ref": "#/definitions/ProfanityFilterMode" + }, + "timeToLive": { + "description": "How long the transcription will be kept in the system after it has completed. Once the\r\ntranscription reaches the time to live after completion (successful or failed) it will be automatically\r\ndeleted. Not setting this value or setting it to 0 will disable automatic deletion. The longest supported\r\nduration is 31 days.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + }, + "diarizationEnabled": { + "description": "A value indicating whether diarization (speaker identification) is requested. The default value\r\nis `false`.\r\nIf this field is set to true and the improved diarization system is configured by specifying\r\n`DiarizationProperties`, the improved diarization system will provide diarization for a configurable\r\nrange of speakers.\r\nIf this field is set to true and the improved diarization system is not enabled (not specifying\r\n`DiarizationProperties`), the basic diarization system will distinguish between up to two speakers.\r\nNo extra charges are applied for the basic diarization.\r\n \r\nThe basic diarization system is deprecated and will be removed in the next major version of the API.\r\nThis `diarizationEnabled` setting will also be removed.", + "type": "boolean" + }, + "diarization": { + "$ref": "#/definitions/DiarizationProperties" + }, + "languageIdentification": { + "$ref": "#/definitions/LanguageIdentificationProperties" + } + } + }, + "TranscriptionUpdate": { + "title": "TranscriptionUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "UploadedBlocks": { + "title": "UploadedBlocks", + "description": "List of uploaded blocks.", + "type": "object", + "properties": { + "committedBlocks": { + "description": "The block description of blocks already committed.", + "type": "array", + "items": { + "$ref": "#/definitions/ResponseBlock" + } + }, + "uncommittedBlocks": { + "description": "The block description of blocks not committed to the blob.", + "type": "array", + "items": { + "$ref": "#/definitions/ResponseBlock" + } + } + } + }, + "WebHook": { + "title": "WebHook", + "required": [ + "displayName", + "events", + "webUrl" + ], + "type": "object", + "properties": { + "webUrl": { + "format": "uri", + "description": "The registered URL that will be used to send the POST requests for the registered events to.", + "type": "string" + }, + "links": { + "$ref": "#/definitions/WebHookLinks" + }, + "properties": { + "$ref": "#/definitions/WebHookProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "events": { + "$ref": "#/definitions/WebHookEvents" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WebHookEvents": { + "title": "WebHookEvents", + "type": "object", + "properties": { + "datasetCreation": { + "type": "boolean" + }, + "datasetProcessing": { + "type": "boolean" + }, + "datasetCompletion": { + "type": "boolean" + }, + "datasetDeletion": { + "type": "boolean" + }, + "modelCreation": { + "type": "boolean" + }, + "modelProcessing": { + "type": "boolean" + }, + "modelCompletion": { + "type": "boolean" + }, + "modelDeletion": { + "type": "boolean" + }, + "evaluationCreation": { + "type": "boolean" + }, + "evaluationProcessing": { + "type": "boolean" + }, + "evaluationCompletion": { + "type": "boolean" + }, + "evaluationDeletion": { + "type": "boolean" + }, + "transcriptionCreation": { + "type": "boolean" + }, + "transcriptionProcessing": { + "type": "boolean" + }, + "transcriptionCompletion": { + "type": "boolean" + }, + "transcriptionDeletion": { + "type": "boolean" + }, + "endpointCreation": { + "type": "boolean" + }, + "endpointProcessing": { + "type": "boolean" + }, + "endpointCompletion": { + "type": "boolean" + }, + "endpointDeletion": { + "type": "boolean" + }, + "ping": { + "type": "boolean" + }, + "challenge": { + "type": "boolean" + } + } + }, + "WebHookLinks": { + "title": "WebHookLinks", + "type": "object", + "properties": { + "ping": { + "format": "uri", + "description": "The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration. See operation \"WebHooks_Ping\" for more details.", + "type": "string", + "readOnly": true + }, + "test": { + "format": "uri", + "description": "The URL that can be used sending test events to the registered URL of a web hook registration. See operation \"WebHooks_Test\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "WebHookProperties": { + "title": "WebHookProperties", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/EntityError" + }, + "apiVersion": { + "description": "The API version the web hook was created in. This defines the shape of the payload in the callbacks.\r\nIf the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation),\r\nthe web hook will be disabled.", + "type": "string", + "readOnly": true + }, + "secret": { + "description": "A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key.\r\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.", + "type": "string" + } + } + }, + "WebHookPropertiesUpdate": { + "title": "WebHookPropertiesUpdate", + "type": "object", + "properties": { + "secret": { + "description": "A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key.\r\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.", + "type": "string" + } + } + }, + "WebHookUpdate": { + "title": "WebHookUpdate", + "type": "object", + "properties": { + "webUrl": { + "format": "uri", + "description": "The registered URL that will be used to send the POST requests for the registered events to.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/WebHookPropertiesUpdate" + }, + "events": { + "$ref": "#/definitions/WebHookEvents" + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": { + "endpoint": { + "in": "path", + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "skipQueryParameter": { + "in": "query", + "name": "skip", + "description": "Number of datasets that will be skipped.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "topQueryParameter": { + "in": "query", + "name": "top", + "description": "Number of datasets that will be included after skipping.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "sasValidityQueryParameter": { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours. When using BYOS (https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): A value of 0 means that a plain blob URI without SAS token will be generated.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "api_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header", + "description": "Provide your cognitive services account key here." + }, + "token": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement" + } + }, + "security": [ + { + "api_key": [] + }, + { + "token": [] + } + ], + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/speechtotext/v3.2", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/endpoint" + } + ] + } +} From 814c3673e0c115347cc398673fe7d36cd82dc83e Mon Sep 17 00:00:00 2001 From: shraddhasun <128851887+shraddhasun@users.noreply.github.com> Date: Tue, 4 Jun 2024 14:39:17 -0700 Subject: [PATCH 35/49] Add new api-version 2024-02-01-preview to main (#29105) * Add 2024-02-01-preview to main * fix typespec errors * remove operations.json * fix linters * delete unusued file * edit readme * remove suppressions * Update specification/azurestackhci/Operations.Management/tspconfig.yaml Co-authored-by: Mike Harder * Update specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml Co-authored-by: Mike Harder * ID to id * remove unnecessary suppress * fix examples * copy private folder changes --------- Co-authored-by: Mike Harder --- .../AttestationStatus.tsp | 33 + .../GalleryImages.tsp | 51 + .../GuestAgent.tsp | 41 + .../HybridIdentityMetadata.tsp | 40 + .../LogicalNetworks.tsp | 51 + .../MarketplaceGalleryImages.tsp | 52 + .../NetworkInterfaces.tsp | 51 + .../NetworkSecurityGroups.tsp | 48 + .../SecurityRules.tsp | 41 + .../StorageContainers.tsp | 49 + .../VirtualHardDisks.tsp | 50 + .../VirtualMachineInstance.tsp | 84 + .../AttestationStatuses_Get.json | 26 + .../GalleryImages_CreateOrUpdate.json | 100 + .../GalleryImages_Delete.json | 22 + .../2024-02-01-preview/GalleryImages_Get.json | 56 + .../GalleryImages_ListAll.json | 52 + .../GalleryImages_ListByResourceGroup.json | 53 + .../GalleryImages_Update.json | 63 + .../GuestAgents_Create.json | 43 + .../GuestAgents_Delete.json | 20 + .../2024-02-01-preview/GuestAgents_Get.json | 22 + ...stAgents_ListByVirtualMachineInstance.json | 26 + .../HybridIdentityMetadataGroup_Get.json | 25 + ...Metadata_ListByVirtualMachineInstance.json | 29 + .../LogicalNetworks_CreateOrUpdate.json | 49 + .../LogicalNetworks_Delete.json | 22 + .../LogicalNetworks_Get.json | 27 + .../LogicalNetworks_ListAll.json | 29 + .../LogicalNetworks_ListByResourceGroup.json | 30 + .../LogicalNetworks_Update.json | 40 + ...rketplaceGalleryImages_CreateOrUpdate.json | 122 + .../MarketplaceGalleryImages_Delete.json | 22 + .../MarketplaceGalleryImages_Get.json | 56 + .../MarketplaceGalleryImages_ListAll.json | 58 + ...laceGalleryImages_ListByResourceGroup.json | 59 + .../MarketplaceGalleryImages_Update.json | 69 + .../NetworkInterfaces_CreateOrUpdate.json | 81 + .../NetworkInterfaces_Delete.json | 22 + .../NetworkInterfaces_Get.json | 37 + .../NetworkInterfaces_ListAll.json | 41 + ...NetworkInterfaces_ListByResourceGroup.json | 41 + .../NetworkInterfaces_Update.json | 47 + .../NetworkSecurityGroups_CreateOrUpdate.json | 37 + .../NetworkSecurityGroups_Delete.json | 22 + .../NetworkSecurityGroups_Get.json | 23 + .../NetworkSecurityGroups_ListAll.json | 34 + ...orkSecurityGroups_ListByResourceGroup.json | 35 + .../NetworkSecurityGroups_UpdateTags.json | 38 + .../2024-02-01-preview/Operations_List.json | 305 + .../SecurityRules_CreateOrUpdate.json | 85 + .../SecurityRules_Delete.json | 23 + .../2024-02-01-preview/SecurityRules_Get.json | 37 + ...urityRules_ListByNetworkSecurityGroup.json | 40 + .../StorageContainers_CreateOrUpdate.json | 54 + .../StorageContainers_Delete.json | 22 + .../StorageContainers_Get.json | 28 + .../StorageContainers_ListAll.json | 30 + ...StorageContainers_ListByResourceGroup.json | 31 + .../StorageContainers_Update.json | 41 + .../VirtualHardDisks_CreateOrUpdate.json | 66 + .../VirtualHardDisks_Delete.json | 22 + .../VirtualHardDisks_Get.json | 34 + .../VirtualHardDisks_ListAll.json | 36 + .../VirtualHardDisks_ListByResourceGroup.json | 37 + .../VirtualHardDisks_Update.json | 47 + ...l_Machine_Instance_With_Gallery_Image.json | 115 + ...stance_With_Marketplace_Gallery_Image.json | 115 + ...Virtual_Machine_Instance_With_Os_Disk.json | 102 + ...Machine_Instance_With_Vm_Config_Agent.json | 146 + .../VirtualMachineInstances_Delete.json | 20 + .../VirtualMachineInstances_Get.json | 44 + .../VirtualMachineInstances_List.json | 48 + .../VirtualMachineInstances_Pause.json | 15 + .../VirtualMachineInstances_Restart.json | 15 + .../VirtualMachineInstances_Save.json | 15 + .../VirtualMachineInstances_Start.json | 15 + .../VirtualMachineInstances_Stop.json | 15 + .../VirtualMachineInstances_Update.json | 64 + .../main.tsp | 48 + .../models.tsp | 1599 ++++ .../tspconfig.yaml | 12 + .../2024-02-01-preview/Operations_List.json | 305 + .../Operations.Management/main.tsp | 34 + .../Operations.Management/models.tsp | 12 + .../Operations.Management/tspconfig.yaml | 12 + .../examples/AttestationStatuses_Get.json | 26 + ...urityRules_ListByNetworkSecurityGroup.json | 37 + .../GalleryImages_CreateOrUpdate.json | 100 + .../examples/GalleryImages_Delete.json | 22 + .../examples/GalleryImages_Get.json | 56 + .../examples/GalleryImages_ListAll.json | 52 + .../GalleryImages_ListByResourceGroup.json | 53 + .../examples/GalleryImages_Update.json | 63 + .../examples/GuestAgents_Create.json | 43 + .../examples/GuestAgents_Delete.json | 20 + .../examples/GuestAgents_Get.json | 22 + ...stAgents_ListByVirtualMachineInstance.json | 26 + .../HybridIdentityMetadataGroup_Get.json | 25 + ...Metadata_ListByVirtualMachineInstance.json | 29 + .../LogicalNetworks_CreateOrUpdate.json | 49 + .../examples/LogicalNetworks_Delete.json | 22 + .../examples/LogicalNetworks_Get.json | 27 + .../examples/LogicalNetworks_ListAll.json | 29 + .../LogicalNetworks_ListByResourceGroup.json | 30 + .../examples/LogicalNetworks_Update.json | 40 + ...rketplaceGalleryImages_CreateOrUpdate.json | 122 + .../MarketplaceGalleryImages_Delete.json | 22 + .../MarketplaceGalleryImages_Get.json | 56 + .../MarketplaceGalleryImages_ListAll.json | 58 + ...laceGalleryImages_ListByResourceGroup.json | 59 + .../MarketplaceGalleryImages_Update.json | 69 + .../NetworkInterfaces_CreateOrUpdate.json | 81 + .../examples/NetworkInterfaces_Delete.json | 22 + .../examples/NetworkInterfaces_Get.json | 37 + .../examples/NetworkInterfaces_ListAll.json | 41 + ...NetworkInterfaces_ListByResourceGroup.json | 41 + .../examples/NetworkInterfaces_Update.json | 47 + .../NetworkSecurityGroups_CreateOrUpdate.json | 37 + .../NetworkSecurityGroups_Delete.json | 22 + .../examples/NetworkSecurityGroups_Get.json | 23 + .../NetworkSecurityGroups_ListAll.json | 34 + ...orkSecurityGroups_ListByResourceGroup.json | 35 + .../NetworkSecurityGroups_UpdateTags.json | 38 + .../examples/Operations_List.json | 305 + .../SecurityRules_CreateOrUpdate.json | 85 + .../examples/SecurityRules_Delete.json | 23 + .../examples/SecurityRules_Get.json | 37 + ...urityRules_ListByNetworkSecurityGroup.json | 40 + .../StorageContainers_CreateOrUpdate.json | 54 + .../examples/StorageContainers_Delete.json | 22 + .../examples/StorageContainers_Get.json | 28 + .../examples/StorageContainers_ListAll.json | 30 + ...StorageContainers_ListByResourceGroup.json | 31 + .../examples/StorageContainers_Update.json | 41 + .../VirtualHardDisks_CreateOrUpdate.json | 66 + .../examples/VirtualHardDisks_Delete.json | 22 + .../examples/VirtualHardDisks_Get.json | 34 + .../examples/VirtualHardDisks_ListAll.json | 36 + .../VirtualHardDisks_ListByResourceGroup.json | 37 + .../examples/VirtualHardDisks_Update.json | 47 + ...l_Machine_Instance_With_Gallery_Image.json | 115 + ...stance_With_Marketplace_Gallery_Image.json | 115 + ...Virtual_Machine_Instance_With_Os_Disk.json | 102 + ...Machine_Instance_With_Vm_Config_Agent.json | 146 + .../VirtualMachineInstances_Delete.json | 20 + .../examples/VirtualMachineInstances_Get.json | 44 + .../VirtualMachineInstances_List.json | 48 + .../VirtualMachineInstances_Pause.json | 15 + .../VirtualMachineInstances_Restart.json | 15 + .../VirtualMachineInstances_Save.json | 15 + .../VirtualMachineInstances_Start.json | 15 + .../VirtualMachineInstances_Stop.json | 15 + .../VirtualMachineInstances_Update.json | 64 + .../2024-02-01-preview/stackhcivm.json | 7079 +++++++++++++++++ .../StackHCIVM/readme.csharp.md | 16 + .../StackHCIVM/readme.go.md | 41 + .../StackHCIVM/readme.md | 69 + .../StackHCIVM/readme.python.md | 23 + .../StackHCIVM/readme.ruby.md | 19 + .../StackHCIVM/readme.typescript.md | 13 + .../examples/Operations_List.json | 305 + .../2024-02-01-preview/operations.json | 86 + .../readme.azureresourceschema.md | 18 + 164 files changed, 16809 insertions(+) create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/AttestationStatus.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GalleryImages.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GuestAgent.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/HybridIdentityMetadata.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/LogicalNetworks.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/MarketplaceGalleryImages.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkInterfaces.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkSecurityGroups.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/SecurityRules.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/StorageContainers.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualMachineInstance.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/AttestationStatuses_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_Create.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/HybridIdentityMetadataGroup_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/HybridIdentityMetadata_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_UpdateTags.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/Operations_List.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_ListByNetworkSecurityGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_List.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Pause.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Restart.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Save.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Start.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Stop.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/models.tsp create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml create mode 100644 specification/azurestackhci/Operations.Management/examples/2024-02-01-preview/Operations_List.json create mode 100644 specification/azurestackhci/Operations.Management/main.tsp create mode 100644 specification/azurestackhci/Operations.Management/models.tsp create mode 100644 specification/azurestackhci/Operations.Management/tspconfig.yaml create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/AttestationStatuses_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/DefaultSecurityRules_ListByNetworkSecurityGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_Create.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/HybridIdentityMetadataGroup_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_UpdateTags.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/Operations_List.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_List.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Pause.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Restart.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Save.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Start.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Stop.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.csharp.md create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.go.md create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.md create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.python.md create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.ruby.md create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.typescript.md create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-02-01-preview/examples/Operations_List.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-02-01-preview/operations.json create mode 100644 specification/azurestackhci/resource-manager/readme.azureresourceschema.md diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/AttestationStatus.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/AttestationStatus.tsp new file mode 100644 index 000000000000..611943235f68 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/AttestationStatus.tsp @@ -0,0 +1,33 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./VirtualMachineInstance.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.AzureStackHCI; +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@doc("The attestation status of the virtual machine") +@singleton("default") +@parentResource(VirtualMachineInstance) +@includeInapplicableMetadataInPayload(false) +model AttestationStatus is ProxyResource { + @doc("Name of attestation status") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$") + @key("attestationStatus") + @segment("attestationStatus") + @visibility("read") + @path + name: string; +} + +@armResourceOperations +interface AttestationStatuses { + @doc("Implements AttestationStatus GET method.") + get is ArmResourceRead; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GalleryImages.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GalleryImages.tsp new file mode 100644 index 000000000000..e46cd9ce02da --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GalleryImages.tsp @@ -0,0 +1,51 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.AzureStackHCI; + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@doc("The gallery images resource definition.") +@extension("x-ms-azure-resource", true) +@extension("x-ms-client-flatten", true) +model GalleryImage is TrackedResource { + @doc("Name of the gallery image") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$") + @path + @key("galleryImageName") + @segment("galleryImages") + @visibility("read") + name: string; + + @doc("The extendedLocation of the resource.") + extendedLocation?: ExtendedLocation; +} + +@armResourceOperations(GalleryImage) +interface GalleryImages { + @doc("Gets a gallery image") + get is ArmResourceRead; + + @doc("The operation to create or update a gallery image. Please note some properties can be set only during gallery image creation.") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + @doc("The operation to update a gallery image.") + @parameterVisibility + update is ArmCustomPatchAsync; + + @doc("The operation to delete a gallery image.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Lists all of the gallery images in the specified resource group. Use the nextLink property in the response to get the next page of gallery images.") + list is ArmResourceListByParent; + + @doc("Lists all of the gallery images in the specified subscription. Use the nextLink property in the response to get the next page of gallery images.") + listAll is ArmListBySubscription; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GuestAgent.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GuestAgent.tsp new file mode 100644 index 000000000000..e8cb4b5f819f --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GuestAgent.tsp @@ -0,0 +1,41 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./VirtualMachineInstance.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.AzureStackHCI; +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@doc("Defines the GuestAgent.") +@singleton("default") +@parentResource(VirtualMachineInstance) +model GuestAgent is ProxyResource { + @doc("guestAgent name") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$") + @key("guestAgent") + @segment("guestAgents") + @visibility("read") + @path + name: string; +} + +@armResourceOperations +interface GuestAgents { + @doc("Implements GuestAgent GET method.") + get is ArmResourceRead; + + @doc("Create Or Update GuestAgent.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("Implements GuestAgent DELETE method.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Returns the list of GuestAgent of the given vm.") + list is ArmResourceListByParent; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/HybridIdentityMetadata.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/HybridIdentityMetadata.tsp new file mode 100644 index 000000000000..f6c7cb5dc404 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/HybridIdentityMetadata.tsp @@ -0,0 +1,40 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./VirtualMachineInstance.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.AzureStackHCI; + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@doc("Defines the HybridIdentityMetadata.") +@extension("x-ms-azure-resource", true) +@singleton("default") +@parentResource(VirtualMachineInstance) +model HybridIdentityMetadata + is ProxyResource { + @doc("Name of the hybrididentitymetadata") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$") + @key("hybridIdentityMetadatum") + @segment("hybridIdentityMetadata") + @visibility("read") + @path + name: string; +} + +@armResourceOperations +@Azure.ClientGenerator.Core.clientName("HybridIdentityMetadata") +interface HybridIdentityMetadataGroup { + @doc("Implements HybridIdentityMetadata GET method.") + get is ArmResourceRead; + + @doc("Returns the list of HybridIdentityMetadata of the given vm.") + list is ArmResourceListByParent; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/LogicalNetworks.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/LogicalNetworks.tsp new file mode 100644 index 000000000000..9b01a62dd7cc --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/LogicalNetworks.tsp @@ -0,0 +1,51 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.AzureStackHCI; + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@doc("The logical network resource definition.") +@extension("x-ms-azure-resource", true) +@extension("x-ms-client-flatten", true) +model LogicalNetwork is TrackedResource { + @doc("Name of the logical network") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$") + @path + @key("logicalNetworkName") + @segment("logicalNetworks") + @visibility("read") + name: string; + + @doc("The extendedLocation of the resource.") + extendedLocation?: ExtendedLocation; +} + +@armResourceOperations +interface LogicalNetworks { + @doc("The operation to get a logical network.") + get is ArmResourceRead; + + @doc("The operation to create or update a logical network. Please note some properties can be set only during logical network creation.") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + @doc("The operation to update a logical network.") + @parameterVisibility + update is ArmCustomPatchAsync; + + @doc("The operation to delete a logical network.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Lists all of the logical networks in the specified resource group. Use the nextLink property in the response to get the next page of logical networks.") + list is ArmResourceListByParent; + + @doc("Lists all of the logical networks in the specified subscription. Use the nextLink property in the response to get the next page of logical networks.") + listAll is ArmListBySubscription; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/MarketplaceGalleryImages.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/MarketplaceGalleryImages.tsp new file mode 100644 index 000000000000..470b9fab0733 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/MarketplaceGalleryImages.tsp @@ -0,0 +1,52 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.AzureStackHCI; + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@doc("The marketplace gallery image resource definition.") +@extension("x-ms-azure-resource", true) +@extension("x-ms-client-flatten", true) +model MarketplaceGalleryImage + is TrackedResource { + @doc("Name of the marketplace gallery image") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$") + @path + @key("marketplaceGalleryImageName") + @segment("marketplaceGalleryImages") + @visibility("read") + name: string; + + @doc("The extendedLocation of the resource.") + extendedLocation?: ExtendedLocation; +} + +@armResourceOperations +interface MarketplaceGalleryImages { + @doc("Gets a marketplace gallery image") + get is ArmResourceRead; + + @doc("The operation to create or update a marketplace gallery image. Please note some properties can be set only during marketplace gallery image creation.") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + @doc("The operation to update a marketplace gallery image.") + @parameterVisibility + update is ArmCustomPatchAsync; + + @doc("The operation to delete a marketplace gallery image.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Lists all of the marketplace gallery images in the specified resource group. Use the nextLink property in the response to get the next page of marketplace gallery images.") + list is ArmResourceListByParent; + + @doc("Lists all of the marketplace gallery images in the specified subscription. Use the nextLink property in the response to get the next page of marketplace gallery images.") + listAll is ArmListBySubscription; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkInterfaces.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkInterfaces.tsp new file mode 100644 index 000000000000..b181201c789c --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkInterfaces.tsp @@ -0,0 +1,51 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.AzureStackHCI; + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@doc("The network interface resource definition.") +@extension("x-ms-azure-resource", true) +@extension("x-ms-client-flatten", true) +model NetworkInterface is TrackedResource { + @doc("Name of the network interface") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$") + @path + @key("networkInterfaceName") + @segment("networkInterfaces") + @visibility("read") + name: string; + + @doc("The extendedLocation of the resource.") + extendedLocation?: ExtendedLocation; +} + +@armResourceOperations +interface NetworkInterfaces { + @doc("Gets a network interface") + get is ArmResourceRead; + + @doc("The operation to create or update a network interface. Please note some properties can be set only during network interface creation.") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + @doc("The operation to update a network interface.") + @parameterVisibility + update is ArmCustomPatchAsync; + + @doc("The operation to delete a network interface.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Lists all of the network interfaces in the specified resource group. Use the nextLink property in the response to get the next page of network interfaces.") + list is ArmResourceListByParent; + + @doc("Lists all of the network interfaces in the specified subscription. Use the nextLink property in the response to get the next page of network interfaces.") + listAll is ArmListBySubscription; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkSecurityGroups.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkSecurityGroups.tsp new file mode 100644 index 000000000000..8de6fc091382 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkSecurityGroups.tsp @@ -0,0 +1,48 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; + +namespace Microsoft.AzureStackHCI; +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@doc("NetworkSecurityGroup resource.") +model NetworkSecurityGroup is TrackedResource { + @doc("Name of the network security group") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$") + @path + @key("networkSecurityGroupName") + @segment("networkSecurityGroups") + @visibility("read") + name: string; + + @doc("The extendedLocation of the resource.") + extendedLocation?: ExtendedLocation; + + ...EntityTagProperty; +} + +@armResourceOperations +interface NetworkSecurityGroups { + @doc("Gets the specified network security group.") + get is ArmResourceRead; + + @doc("Creates or updates a network security group in the specified resource group.") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + @doc("Updates a network security group tags.") + updateTags is ArmTagsPatchAsync; + + @doc("Deletes the specified network security group.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Gets all network security groups in a resource group.") + list is ArmResourceListByParent; + + @doc("Gets all network security groups in a subscription.") + listAll is ArmListBySubscription; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/SecurityRules.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/SecurityRules.tsp new file mode 100644 index 000000000000..4563d65e5c59 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/SecurityRules.tsp @@ -0,0 +1,41 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; + +namespace Microsoft.AzureStackHCI; +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@doc("Security Rule resource.") +@parentResource(NetworkSecurityGroup) +model SecurityRule is ProxyResource { + @doc("Name of the security rule.") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$") + @path + @key("securityRuleName") + @segment("securityRules") + @visibility("read") + name: string; + + @doc("The extendedLocation of the resource.") + extendedLocation?: ExtendedLocation; +} + +@armResourceOperations +interface SecurityRules { + @doc("Gets the specified security rule.") + get is ArmResourceRead; + + @doc("Creates or updates a security rule in the specified resource group.") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + @doc("Deletes the specified security rule.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Gets all security rules in a Network Security Group.") + list is ArmResourceListByParent; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/StorageContainers.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/StorageContainers.tsp new file mode 100644 index 000000000000..f81302304026 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/StorageContainers.tsp @@ -0,0 +1,49 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.AzureStackHCI; +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@doc("The storage container resource definition.") +@extension("x-ms-azure-resource", true) +@extension("x-ms-client-flatten", true) +model StorageContainer is TrackedResource { + @doc("Name of the storage container") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$") + @path + @key("storageContainerName") + @segment("storageContainers") + @visibility("read") + name: string; + + @doc("The extendedLocation of the resource.") + extendedLocation?: ExtendedLocation; +} + +@armResourceOperations +interface StorageContainers { + @doc("Gets a storage container") + get is ArmResourceRead; + + @doc("The operation to create or update a storage container. Please note some properties can be set only during storage container creation.") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + @doc("The operation to update a storage container.") + update is ArmTagsPatchAsync; + + @doc("The operation to delete a storage container.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Lists all of the storage containers in the specified resource group. Use the nextLink property in the response to get the next page of storage containers.") + list is ArmResourceListByParent; + + @doc("Lists all of the storage containers in the specified subscription. Use the nextLink property in the response to get the next page of storage containers.") + listAll is ArmListBySubscription; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp new file mode 100644 index 000000000000..4123b2ea6ca7 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp @@ -0,0 +1,50 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.AzureStackHCI; + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@doc("The virtual hard disk resource definition.") +@extension("x-ms-azure-resource", true) +@extension("x-ms-client-flatten", true) +model VirtualHardDisk is TrackedResource { + @doc("Name of the virtual hard disk") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$") + @path + @key("virtualHardDiskName") + @segment("virtualHardDisks") + @visibility("read") + name: string; + + @doc("The extendedLocation of the resource.") + extendedLocation?: ExtendedLocation; +} + +@armResourceOperations +interface VirtualHardDisks { + @doc("Gets a virtual hard disk") + get is ArmResourceRead; + + @doc("The operation to create or update a virtual hard disk. Please note some properties can be set only during virtual hard disk creation.") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + @doc("The operation to update a virtual hard disk.") + update is ArmTagsPatchAsync; + + @doc("The operation to delete a virtual hard disk.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Lists all of the virtual hard disks in the specified resource group. Use the nextLink property in the response to get the next page of virtual hard disks.") + list is ArmResourceListByParent; + + @doc("Lists all of the virtual hard disks in the specified subscription. Use the nextLink property in the response to get the next page of virtual hard disks.") + listAll is ArmListBySubscription; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualMachineInstance.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualMachineInstance.tsp new file mode 100644 index 000000000000..177c79c2491f --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualMachineInstance.tsp @@ -0,0 +1,84 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.AzureStackHCI; +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility" +@doc("The virtual machine instance resource definition.") +@extension("x-ms-azure-resource", true) +@extension("x-ms-client-flatten", true) +@singleton("default") +model VirtualMachineInstance + is ExtensionResource { + @doc("name of virtual machine") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$") + @key("virtualMachineInstance") + @segment("virtualMachineInstances") + @visibility("read") + @path + name: string; + + @doc("The extendedLocation of the resource.") + extendedLocation?: ExtendedLocation; + + ...ManagedServiceIdentityProperty; +} + +@armResourceOperations +interface VirtualMachineInstances { + @doc("Gets a virtual machine instance") + get is ArmResourceRead; + + @doc("The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + @doc("The operation to update a virtual machine instance.") + @parameterVisibility + update is ArmCustomPatchAsync< + VirtualMachineInstance, + VirtualMachineInstanceUpdateRequest + >; + + @doc("The operation to delete a virtual machine instance.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Lists all of the virtual machine instances within the specified parent resource.") + list is ArmResourceListByParent; + + @doc("The operation to start a virtual machine instance.") + start is ArmResourceActionNoResponseContentAsync< + VirtualMachineInstance, + Request = void + >; + + @doc("The operation to stop a virtual machine instance.") + stop is ArmResourceActionNoResponseContentAsync< + VirtualMachineInstance, + Request = void + >; + + @doc("The operation to restart a virtual machine instance.") + restart is ArmResourceActionNoResponseContentAsync< + VirtualMachineInstance, + Request = void + >; + + @doc("The operation to pause a virtual machine instance.") + pause is ArmResourceActionNoResponseContentAsync< + VirtualMachineInstance, + Request = void + >; + + @doc("The operation to save a virtual machine instance.") + save is ArmResourceActionNoResponseContentAsync< + VirtualMachineInstance, + Request = void + >; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/AttestationStatuses_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/AttestationStatuses_Get.json new file mode 100644 index 000000000000..c73ee3617166 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/AttestationStatuses_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/AttestationStatus", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default", + "properties": { + "attestSecureBootEnabled": "Disabled", + "attestationCertValidated": "Invalid", + "bootIntegrityValidated": "Invalid", + "errorMessage": "Attestation token has invalid signature", + "healthStatus": "Unhealthy", + "linuxKernelVersion": "1.0.0.0", + "timestamp": "2023/11/10 9:48" + } + } + } + }, + "operationId": "AttestationStatuses_Get", + "title": "GetAttestationStatus" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..625e304ccbcf --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_CreateOrUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "galleryImageName": "test-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "imagePath": "C:\\test.vhdx", + "osType": "Linux" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Succeeded", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_CreateOrUpdate", + "title": "PutGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_Delete.json new file mode 100644 index 000000000000..f55433c2b81c --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Delete", + "title": "DeleteGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_Get.json new file mode 100644 index 000000000000..7932b63e4ec3 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_Get", + "title": "GetGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_ListAll.json new file mode 100644 index 000000000000..588342065cff --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_ListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListAll", + "title": "ListGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..2870831af86e --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListByResourceGroup", + "title": "ListGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_Update.json new file mode 100644 index 000000000000..035f0e6a8376 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GalleryImages_Update.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "galleryImageName": "test-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Update", + "title": "UpdateGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_Create.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_Create.json new file mode 100644 index 000000000000..fb3503d12fa1 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_Create.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resource": { + "properties": { + "credentials": { + "password": "", + "username": "tempuser" + }, + "provisioningAction": "install" + } + }, + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Created", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Create", + "title": "CreateGuestAgent" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_Delete.json new file mode 100644 index 000000000000..7edd761afd32 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GuestAgents_Delete", + "title": "DeleteGuestAgent" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_Get.json new file mode 100644 index 000000000000..e350bcf9a21c --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Get", + "title": "GetGuestAgent" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_ListByVirtualMachineInstance.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..763ed44a39d3 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/GuestAgents_ListByVirtualMachineInstance.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + ] + } + } + }, + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "title": "GuestAgentListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/HybridIdentityMetadataGroup_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/HybridIdentityMetadataGroup_Get.json new file mode 100644 index 000000000000..b8e26dcf12ef --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/HybridIdentityMetadataGroup_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + } + }, + "operationId": "HybridIdentityMetadata_Get", + "title": "GetHybridIdentityMetadata" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/HybridIdentityMetadata_ListByVirtualMachineInstance.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/HybridIdentityMetadata_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..f8900e2f6774 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/HybridIdentityMetadata_ListByVirtualMachineInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + ] + } + } + }, + "operationId": "HybridIdentityMetadata_ListByVirtualMachineInstance", + "title": "HybridIdentityMetadataListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_CreateOrUpdate.json new file mode 100644 index 000000000000..56e12010fb82 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_CreateOrUpdate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "logicalNetworkName": "test-lnet", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2" + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "LogicalNetworks_CreateOrUpdate", + "title": "PutLogicalNetwork" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_Delete.json new file mode 100644 index 000000000000..a994c9ddbbf2 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Delete", + "title": "DeleteLogicalNetwork" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_Get.json new file mode 100644 index 000000000000..1726a541ecb3 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "LogicalNetworks_Get", + "title": "GetLogicalNetwork" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_ListAll.json new file mode 100644 index 000000000000..ac0cb9f62bd0 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_ListAll.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListAll", + "title": "ListLogicalNetworkBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..43fd5e75fe77 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_ListByResourceGroup.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListByResourceGroup", + "title": "ListLogicalNetworkByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_Update.json new file mode 100644 index 000000000000..bd3b62dc7c54 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/LogicalNetworks_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "logicalNetworkName": "test-lnet", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Update", + "title": "UpdateLogicalNetwork" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..f4c9ee0355e5 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_CreateOrUpdate.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "name": "test-marketplace-gallery-image", + "api-version": "2024-02-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "version": { + "name": "1.0.0" + } + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Creating", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_CreateOrUpdate", + "title": "PutMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_Delete.json new file mode 100644 index 000000000000..d307ea1f339c --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Delete", + "title": "DeleteMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_Get.json new file mode 100644 index 000000000000..20e91c809e31 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_Get", + "title": "GetMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_ListAll.json new file mode 100644 index 000000000000..a1c2ecc5c23e --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_ListAll.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListAll", + "title": "ListMarketplaceGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..98a8d0f6358b --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListByResourceGroup", + "title": "ListMarketplaceGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_Update.json new file mode 100644 index 000000000000..591e5d00baa1 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/MarketplaceGalleryImages_Update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "marketplaceGalleryImageName": "test-marketplce-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Update", + "title": "UpdateMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_CreateOrUpdate.json new file mode 100644 index 000000000000..d1d6a94cb097 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_CreateOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkInterfaceName": "test-nic", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "eastus", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ] + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkInterfaces_CreateOrUpdate", + "title": "PutNetworkInterface" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..849a2fa55d23 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Delete", + "title": "DeleteNetworkInterface" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_Get.json new file mode 100644 index 000000000000..0ba891a6e316 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "NetworkInterfaces_Get", + "title": "GetNetworkInterface" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_ListAll.json new file mode 100644 index 000000000000..877649fb00fd --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_ListAll.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListAll", + "title": "ListNetworkInterfaceBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_ListByResourceGroup.json new file mode 100644 index 000000000000..7ad9a7e22ec2 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListByResourceGroup", + "title": "ListNetworkInterfaceByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_Update.json new file mode 100644 index 000000000000..b492fca2b844 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkInterfaces_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkInterfaceName": "test-nic", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Update", + "title": "UpdateNetworkInterface" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_CreateOrUpdate.json new file mode 100644 index 000000000000..25dd85ff1ddb --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_CreateOrUpdate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resource": { + "location": "eastus" + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "title": "CreateNetworkSecurityGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_Delete.json new file mode 100644 index 000000000000..6cf6a0d2a421 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_Delete", + "title": "Delete network security group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_Get.json new file mode 100644 index 000000000000..6e89c13d91b8 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg1/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_Get", + "title": "Get network security group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_ListAll.json new file mode 100644 index 000000000000..43a1fe797c7e --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_ListAll.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg2", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg2/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg2", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListAll", + "title": "List all network security groups" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..05f46cfd5b5b --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_ListByResourceGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg3", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg3", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListByResourceGroup", + "title": "List network security groups in resource group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_UpdateTags.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_UpdateTags.json new file mode 100644 index 000000000000..ea3c52fac399 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/NetworkSecurityGroups_UpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_UpdateTags", + "title": "Update network security group tags" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/Operations_List.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/Operations_List.json new file mode 100644 index 000000000000..4a5ff103d84a --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/Operations_List.json @@ -0,0 +1,305 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Deletes virtual hard disk resource", + "description": "Deletes virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Creates/Updates virtual hard disk resource", + "description": "Creates/Updates virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Gets/Lists virtual hard disk resource", + "description": "Gets/Lists virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Deletes network interfaces resource", + "description": "Deletes network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Creates/Updates network interfaces resource", + "description": "Creates/Updates network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Gets/Lists network interfaces resource", + "description": "Gets/Lists network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Deletes gallery images resource", + "description": "Deletes gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Creates/Updates gallery images resource", + "description": "Creates/Updates gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Gets/Lists gallery images resource", + "description": "Gets/Lists gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/HybridIdentityMetadata/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances/HybridIdentityMetadata", + "operation": "Gets/Lists virtual machine instance hybrid identity metadata proxy resource", + "description": "Gets/Lists virtual machine instance hybrid identity metadata proxy resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/attestationStatus/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances/attestationStatus", + "operation": "Gets/Lists virtual machine instance's attestation status", + "description": "Gets/Lists virtual machine instance's attestation status" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Deletes logical networks resource", + "description": "Deletes logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Creates/Updates logical networks resource", + "description": "Creates/Updates logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Gets/Lists logical networks resource", + "description": "Gets/Lists logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/join/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Joins logical networks resource", + "description": "Joins logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Restart/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Restarts virtual machine instance resource", + "description": "Restarts virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Start/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Starts virtual machine instance resource", + "description": "Starts virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Stop/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Stops virtual machine instance resource", + "description": "Stops virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Deletes virtual machine instance resource", + "description": "Deletes virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Creates/Updates virtual machine instance resource", + "description": "Creates/Updates virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Gets/Lists virtual machine instance resource", + "description": "Gets/Lists virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Deletes storage containers resource", + "description": "Deletes storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Creates/Updates storage containers resource", + "description": "Creates/Updates storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Gets/Lists storage containers resource", + "description": "Gets/Lists storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/deploy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Deploys storage containers resource", + "description": "Deploys storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Deletes market place gallery images resource", + "description": "Deletes market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Creates/Updates market place gallery images resource", + "description": "Creates/Updates market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Gets/Lists market place gallery images resource", + "description": "Gets/Lists market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/deploy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Deploys market place gallery images resource", + "description": "Deploys market place gallery images resource" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List the operations for the provider." +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_CreateOrUpdate.json new file mode 100644 index 000000000000..3f4e58c8721d --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_CreateOrUpdate", + "title": "SecurityRulesCreateOrUpdate" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_Delete.json new file mode 100644 index 000000000000..4e2d69c17dff --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "SecurityRules_Delete", + "title": "SecurityRulesDelete" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_Get.json new file mode 100644 index 000000000000..c78dd2d79668 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_Get", + "title": "Get network security rule in network security group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_ListByNetworkSecurityGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_ListByNetworkSecurityGroup.json new file mode 100644 index 000000000000..3263f0e4f323 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/SecurityRules_ListByNetworkSecurityGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + ] + } + } + }, + "operationId": "SecurityRules_ListByNetworkSecurityGroup", + "title": "List network security rules in network security group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_CreateOrUpdate.json new file mode 100644 index 000000000000..8a4444585098 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "path": "C:\\container_storage" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "StorageContainers_CreateOrUpdate", + "title": "PutStorageContainer" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_Delete.json new file mode 100644 index 000000000000..2200c4db8fbc --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Delete", + "title": "DeleteStorageContainer" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_Get.json new file mode 100644 index 000000000000..567027da24f5 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "StorageContainers_Get", + "title": "GetStorageContainer" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_ListAll.json new file mode 100644 index 000000000000..c072a84422f1 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_ListAll.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListAll", + "title": "ListStorageContainerBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_ListByResourceGroup.json new file mode 100644 index 000000000000..2976d038e253 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListByResourceGroup", + "title": "ListStorageContainerByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_Update.json new file mode 100644 index 000000000000..f6868128d23c --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/StorageContainers_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Update", + "title": "UpdateStorageContainer" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_CreateOrUpdate.json new file mode 100644 index 000000000000..d2f44d5c884c --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_CreateOrUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "diskSizeGB": 32 + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "VirtualHardDisks_CreateOrUpdate", + "title": "PutVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_Delete.json new file mode 100644 index 000000000000..541cb195b39e --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Delete", + "title": "DeleteVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_Get.json new file mode 100644 index 000000000000..aeb4a697e8dd --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "VirtualHardDisks_Get", + "title": "GetVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_ListAll.json new file mode 100644 index 000000000000..615a36633889 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_ListAll.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListAll", + "title": "ListVirtualHardDiskBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_ListByResourceGroup.json new file mode 100644 index 000000000000..fa8b428580f9 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListByResourceGroup", + "title": "ListVirtualHardDiskByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_Update.json new file mode 100644 index 000000000000..1ae3c83ac98b --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualHardDisks_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "properties": { + "tags": { + "additionalProperties": "sample" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Update", + "title": "UpdateVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json new file mode 100644 index 000000000000..a91320df1aa6 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json new file mode 100644 index 000000000000..d69de8202af0 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json new file mode 100644 index 000000000000..b969d236e308 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Succeeded", + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithOsDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json new file mode 100644 index 000000000000..ad29a53df4f9 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster", + "windowsConfiguration": { + "provisionVMConfigAgent": true + } + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithVMConfigAgent" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Delete.json new file mode 100644 index 000000000000..cb0fdb58b717 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Delete", + "title": "DeleteVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Get.json new file mode 100644 index 000000000000..85bee1c16d3e --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_Get", + "title": "GetVirtualMachineInstance" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_List.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_List.json new file mode 100644 index 000000000000..a8b6f203e211 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + ] + } + } + }, + "operationId": "VirtualMachineInstances_List", + "title": "ListVirtualMachineInstances" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Pause.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Pause.json new file mode 100644 index 000000000000..2972c7be6d73 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Pause.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Pause", + "title": "PauseVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Restart.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Restart.json new file mode 100644 index 000000000000..cbe832ef1eb8 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Restart", + "title": "RestartVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Save.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Save.json new file mode 100644 index 000000000000..9c3a010fa826 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Save.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Save", + "title": "SaveVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Start.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Start.json new file mode 100644 index 000000000000..363ab5468eb3 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Start", + "title": "StartVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Stop.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Stop.json new file mode 100644 index 000000000000..cb301a5be1b0 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Stop.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Stop", + "title": "StopVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Update.json new file mode 100644 index 000000000000..13610e656a93 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-02-01-preview/VirtualMachineInstances_Update.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "properties": { + "properties": { + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ], + "imageReference": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + } + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Update", + "title": "UpdateVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp new file mode 100644 index 000000000000..296bc8508433 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp @@ -0,0 +1,48 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "./models.tsp"; +import "./GalleryImages.tsp"; +import "./LogicalNetworks.tsp"; +import "./MarketplaceGalleryImages.tsp"; +import "./NetworkInterfaces.tsp"; +import "./NetworkSecurityGroups.tsp"; +import "./SecurityRules.tsp"; +import "./StorageContainers.tsp"; +import "./VirtualHardDisks.tsp"; +import "./VirtualMachineInstance.tsp"; +import "./HybridIdentityMetadata.tsp"; +import "./AttestationStatus.tsp"; +import "./GuestAgent.tsp"; +import "../Operations.Management/models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; +/** + * Azure Stack HCI management service + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "HCI itself is a short form." +@armProviderNamespace +@service({ + title: "Microsoft.AzureStackHCI", +}) +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AzureStackHCI; + +/** + * The available API versions. + */ +enum Versions { + /** + * The 2024-02-01-preview API version. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_02_01_preview: "2024-02-01-preview", +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/models.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/models.tsp new file mode 100644 index 000000000000..74430122d563 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/models.tsp @@ -0,0 +1,1599 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-resource-manager"; +import "../Operations.Management/models.tsp"; +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.Core; +using TypeSpec.OpenAPI; +using Azure.ResourceManager; + +namespace Microsoft.AzureStackHCI; + +@doc("Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]") +union CloudInitDataSource { + @doc("NoCloud is used as the datasource") + NoCloud: "NoCloud", + + @doc("Azure is used as the datasource") + Azure: "Azure", + + string, +} + +@doc("The hypervisor generation of the Virtual Machine [V1, V2]") +union HyperVGeneration { + @doc("Generation 1 (V1) hypervisor") + V1: "V1", + + @doc("Generation 2 (V2) hypervisor") + V2: "V2", + + string, +} + +@doc("Provisioning state of the resource.") +union ProvisioningStateEnum { + @doc("Provisioning has succeeded") + Succeeded: "Succeeded", + + @doc("Provisioning has failed") + Failed: "Failed", + + @doc("Provisioning is in progress") + InProgress: "InProgress", + + @doc("Provisioning has been accepted") + Accepted: "Accepted", + + @doc("Deletion of the resource is in progress") + Deleting: "Deleting", + + @doc("Provisioning has been canceled") + Canceled: "Canceled", + + string, +} + +@doc("The status of the operation performed on the resource [Succeeded, Failed, InProgress]") +union Status { + @doc("Operation succeeded") + Succeeded: "Succeeded", + + @doc("Operation failed") + Failed: "Failed", + + @doc("Operation is in progress") + InProgress: "InProgress", + + string, +} + +@doc("The type of extendedLocation.") +union ExtendedLocationTypes { + @doc("Custom extended location type") + CustomLocation: "CustomLocation", + + string, +} + +@doc("IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'") +union IpAllocationMethodEnum { + @doc("Dynamic IP allocation method") + Dynamic: "Dynamic", + + @doc("Static IP allocation method") + Static: "Static", + + string, +} + +@doc("Network protocol this rule applies to.") +union SecurityRuleProtocol { + @doc("Transmission Control Protocol") + Tcp: "Tcp", + + @doc("User Datagram Protocol") + Udp: "Udp", + + @doc("Internet Control Message Protocol") + Icmp: "Icmp", + + @doc("Wildcard rule for all protocols") + Asterisk: "*", + + string, +} + +@doc("Whether network traffic is allowed or denied.") +union SecurityRuleAccess { + @doc("Network traffic is allowed") + Allow: "Allow", + + @doc("Network traffic is denied") + Deny: "Deny", + + string, +} + +@doc("The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.") +union SecurityRuleDirection { + @doc("Rule is evaluated on incoming traffic") + Inbound: "Inbound", + + @doc("Rule is evaluated on outgoing traffic") + Outbound: "Outbound", + + string, +} + +@doc("The format of the actual VHD file [vhd, vhdx]") +union DiskFileFormat { + @doc("VHDX file format") + vhdx: "vhdx", + + @doc("VHD file format") + vhd: "vhd", + + string, +} + +@doc("VM Sizes") +union VmSizeEnum { + @doc("Default virtual machine size") + Default: "Default", + + @doc("Standard A2 v2 virtual machine size") + Standard_A2_v2: "Standard_A2_v2", + + @doc("Standard A4 v2 virtual machine size") + Standard_A4_v2: "Standard_A4_v2", + + @doc("Standard D2s v3 virtual machine size") + Standard_D2s_v3: "Standard_D2s_v3", + + @doc("Standard D4s v3 virtual machine size") + Standard_D4s_v3: "Standard_D4s_v3", + + @doc("Standard D8s v3 virtual machine size") + Standard_D8s_v3: "Standard_D8s_v3", + + @doc("Standard D16s v3 virtual machine size") + Standard_D16s_v3: "Standard_D16s_v3", + + @doc("Standard D32s v3 virtual machine size") + Standard_D32s_v3: "Standard_D32s_v3", + + @doc("Standard DS2 v2 virtual machine size") + Standard_DS2_v2: "Standard_DS2_v2", + + @doc("Standard DS3 v2 virtual machine size") + Standard_DS3_v2: "Standard_DS3_v2", + + @doc("Standard DS4 v2 virtual machine size") + Standard_DS4_v2: "Standard_DS4_v2", + + @doc("Standard DS5 v2 virtual machine size") + Standard_DS5_v2: "Standard_DS5_v2", + + @doc("Standard DS13 v2 virtual machine size") + Standard_DS13_v2: "Standard_DS13_v2", + + @doc("Standard K8S v1 virtual machine size") + Standard_K8S_v1: "Standard_K8S_v1", + + @doc("Standard K8S2 v1 virtual machine size") + Standard_K8S2_v1: "Standard_K8S2_v1", + + @doc("Standard K8S3 v1 virtual machine size") + Standard_K8S3_v1: "Standard_K8S3_v1", + + @doc("Standard K8S4 v1 virtual machine size") + Standard_K8S4_v1: "Standard_K8S4_v1", + + @doc("Standard NK6 virtual machine size") + Standard_NK6: "Standard_NK6", + + @doc("Standard NK12 virtual machine size") + Standard_NK12: "Standard_NK12", + + @doc("Standard NV6 virtual machine size") + Standard_NV6: "Standard_NV6", + + @doc("Standard NV12 virtual machine size") + Standard_NV12: "Standard_NV12", + + @doc("Standard K8S5 v1 virtual machine size") + Standard_K8S5_v1: "Standard_K8S5_v1", + + @doc("Custom virtual machine size") + Custom: "Custom", + + string, +} + +@doc("Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function.") +union SecurityTypes { + @doc("Trusted Launch security type") + TrustedLaunch: "TrustedLaunch", + + @doc("Confidential VM security type") + ConfidentialVM: "ConfidentialVM", + + string, +} + +@doc("The level code.") +union StatusLevelTypes { + @doc("Informational status level") + Info: "Info", + + @doc("Warning status level") + Warning: "Warning", + + @doc("Error status level") + Error: "Error", + + string, +} + +@doc("The power state of the virtual machine instance") +union PowerStateEnum { + @doc("Virtual machine deallocated") + Deallocated: "Deallocated", + + @doc("Virtual machine deallocating") + Deallocating: "Deallocating", + + @doc("Virtual machine running") + Running: "Running", + + @doc("Virtual machine starting") + Starting: "Starting", + + @doc("Virtual machine stopped") + Stopped: "Stopped", + + @doc("Virtual machine stopping") + Stopping: "Stopping", + + @doc("Virtual machine paused") + Paused: "Paused", + + @doc("Virtual machine Saved,") + Saved: "Saved", + + @doc("Power state of the virtual machine is unknown") + Unknown: "Unknown", + + string, +} + +@doc("The installation status of the hybrid machine agent installation.") +union StatusTypes { + @doc("Installation succeeded") + Succeeded: "Succeeded", + + @doc("Installation in progress") + InProgress: "InProgress", + + @doc("Installation failed") + Failed: "Failed", + + string, +} + +@doc("The status of whether secure boot is enabled.") +union AttestSecureBootPropertyEnum { + @doc("Secure boot enabled") + Enabled: "Enabled", + + @doc("Secure boot disabled") + Disabled: "Disabled", + + @doc("Secure boot status is unknown") + Unknown: "Unknown", + + string, +} + +@doc("The status of whether attestation certificate is validated.") +union AttestCertPropertyEnum { + @doc("Attestation certificate is valid") + Valid: "Valid", + + @doc("Attestation certificate is invalid") + Invalid: "Invalid", + + @doc("Attestation certificate status is unknown") + Unknown: "Unknown", + + string, +} + +@doc("The status of whether the list of boot integrity properties is validated.") +union AttestBootIntegrityPropertyEnum { + @doc("Boot integrity properties are valid") + Valid: "Valid", + + @doc("Boot integrity properties are invalid") + Invalid: "Invalid", + + @doc("Boot integrity properties status is unknown") + Unknown: "Unknown", + + string, +} + +@doc("The health status of attestation validation and parsing") +union AttestHealthStatusEnum { + @doc("Attestation validation and parsing pending") + Pending: "Pending", + + @doc("Attestation validation and parsing healthy") + Healthy: "Healthy", + + @doc("Attestation validation and parsing unhealthy") + Unhealthy: "Unhealthy", + + @doc("Attestation validation and parsing status is unknown") + Unknown: "Unknown", + + string, +} + +@doc("Defines the different types of operations for guest agent.") +union ProvisioningAction { + @doc("Install guest agent") + install: "install", + + @doc("Uninstall guest agent") + uninstall: "uninstall", + + @doc("Repair guest agent") + repair: "repair", + + string, +} + +@doc("Operating system type that the gallery image uses [Windows, Linux]") +union OperatingSystemTypes { + @doc("Windows operating system") + Windows: "Windows", + + @doc("Linux operating system") + Linux: "Linux", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "IP is a short form. The casing is correct." +@doc("Type of the IP Pool [vm, vippool]") +union IPPoolTypeEnum { + @doc("Virtual Machine IP Pool") + vm: "vm", + + @doc("VIP Pool") + vippool: "vippool", + + string, +} + +@doc("The ARM ID for a Network Interface.") +model NetworkInterfaceArmReference { + @doc("The ARM ID for a Network Interface.") + id?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/networkInterfaces"; + } + ]>; +} +@doc("The ARM ID for a Network Interface.") +model SubnetIpConfigurationReference { + #suppress "@azure-tools/typespec-azure-core/casing-style" "ID is already shipped. Changing the casing is a breaking change." + @doc("The ARM ID for a Network Interface.") + ID?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/networkInterfaces"; + } + ]>; +} + +@doc("The ARM ID for a Network Security Group.") +model NetworkSecurityGroupArmReference { + @doc("The ARM ID for a Network Security Group.") + id?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/networkSecurityGroups"; + } + ]>; +} + +@doc("The ARM ID for a Logical Network.") +model LogicalNetworkArmReference { + @doc("The ARM ID for a Logical Network.") + id?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/logicalNetworks"; + } + ]>; +} + +@doc("The ARM ID for a Virtual Machine.") +model VirtualMachineArmReference { + @doc("The ARM ID for a Virtual Machine.") + id?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/virtualMachineInstance"; + } + ]>; +} + +@doc("The ARM ID for a Storage Container.") +model StorageContainerArmReference { + @doc("The ARM ID for a Storage Container.") + id?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/storageContainers"; + } + ]>; +} + +@doc("The ARM ID for a Gallery Image.") +model ImageArmReference { + @doc("The ARM ID for an image resource used by the virtual machine instance.") + @visibility("create", "read") + id?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/galleryImages"; + }, + { + type: "Microsoft.AzureStackHCI/marketplaceGalleryImages"; + } + ]>; +} + +@doc("The ARM ID for a Virtual Hard Disk.") +model VirtualHardDiskArmReference { + @doc("The ARM ID for a Virtual Hard Disk.") + id?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/virtualHardDisks"; + } + ]>; +} + +@doc("Properties under the gallery image resource") +model GalleryImageProperties { + @doc("Storage ContainerID of the storage container to be used for gallery image") + containerId?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/storageContainers"; + } + ]>; + + @doc("location of the image the gallery image should be created from") + @secret + imagePath?: string; + + @doc("Operating system type that the gallery image uses [Windows, Linux]") + osType: OperatingSystemTypes; + + @doc("Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]") + cloudInitDataSource?: CloudInitDataSource; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "HyperV is the correct case." + @doc("The hypervisor generation of the Virtual Machine [V1, V2]") + hyperVGeneration?: HyperVGeneration; + + @doc("This is the gallery image definition identifier.") + identifier?: GalleryImageIdentifier; + + @doc("Specifies information about the gallery image version that you want to create or update.") + version?: GalleryImageVersion; + + @doc("Provisioning state of the gallery image.") + @visibility("read") + provisioningState?: ProvisioningStateEnum; + + @doc("The observed state of gallery images") + @visibility("read") + status?: GalleryImageStatus; +} + +@doc("This is the gallery image definition identifier.") +model GalleryImageIdentifier { + @doc("The name of the gallery image definition publisher.") + publisher: string; + + @doc("The name of the gallery image definition offer.") + offer: string; + + @doc("The name of the gallery image definition SKU.") + sku: string; +} + +@doc("Specifies information about the gallery image version that you want to create or update.") +model GalleryImageVersion { + @doc("This is the version of the gallery image.") + name?: string; + + @doc("Describes the properties of a gallery image version.") + @extension("x-ms-client-flatten", true) + properties?: GalleryImageVersionProperties; +} + +@doc("Describes the properties of a gallery image version.") +model GalleryImageVersionProperties { + @doc("This is the storage profile of a Gallery Image Version.") + storageProfile: GalleryImageVersionStorageProfile; +} + +@doc("This is the storage profile of a Gallery Image Version.") +model GalleryImageVersionStorageProfile { + @doc("This is the OS disk image.") + osDiskImage?: GalleryOSDiskImage; +} + +@doc("This is the disk image base class.") +model GalleryDiskImage { + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is a short form." + @doc("This property indicates the size of the VHD to be created.") + @visibility("read") + sizeInMB?: int64; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "OS is a short form. GalleryOSDiskImage is the correct case." +@doc("This is the OS disk image.") +model GalleryOSDiskImage { + ...GalleryDiskImage; + // Add additional properties specific to GalleryOSDiskImage if needed +} + +@doc("The observed state of gallery images") +@extension("x-ms-client-flatten", true) +model GalleryImageStatus { + @doc("GalleryImage provisioning error code") + errorCode?: string; + + @doc("Descriptive error message") + errorMessage?: string; + + @doc("provisioning status of the gallery image") + provisioningStatus?: GalleryImageStatusProvisioningStatus; + + @doc("The download status of the gallery image") + downloadStatus?: GalleryImageStatusDownloadStatus; + + @doc("The progress of the operation in percentage") + progressPercentage?: int64; +} + +@doc("The status of the operation performed on the gallery image") +model GalleryImageStatusProvisioningStatus { + @doc("The ID of the operation performed on the gallery image") + operationId?: string; + + @doc("The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]") + status?: Status; +} + +@doc("The download status of the gallery image") +model GalleryImageStatusDownloadStatus { + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB should be referenced as MB." + @doc("The downloaded sized of the image in MB") + downloadSizeInMB?: int64; +} + +@doc("The complex type of the extended location.") +model ExtendedLocation { + @doc("The name of the extended location.") + name?: string; + + @doc("The type of the extended location.") + type?: ExtendedLocationTypes; +} + +@doc("The gallery images resource patch definition.") +model GalleryImagesUpdateRequest { + @doc("Resource tags") + tags?: Record; +} + +@doc("Properties under the logical network resource") +model LogicalNetworkProperties { + @doc("DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.") + dhcpOptions?: LogicalNetworkPropertiesDhcpOptions; + + @doc("Subnet - list of subnets under the logical network") + @OpenAPI.extension("x-ms-identifiers", []) + subnets?: Subnet[]; + + @doc("Provisioning state of the logical network.") + @visibility("read") + provisioningState?: ProvisioningStateEnum; + + @doc("name of the network switch to be used for VMs") + vmSwitchName?: string; + + @doc("The observed state of logical networks") + @visibility("read") + status?: LogicalNetworkStatus; +} + +@doc("DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.") +model LogicalNetworkPropertiesDhcpOptions { + @doc("The list of DNS servers IP addresses.") + dnsServers?: string[]; +} + +@doc("Properties of the subnet.") +model Subnet { + @doc("Properties of the subnet.") + @extension("x-ms-client-flatten", true) + properties?: SubnetProperties; + + @doc("Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$") + name?: string; +} + +@doc("Properties of the subnet.") +model SubnetProperties { + @doc("The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6.") + addressPrefix?: string; + + @doc("List of address prefixes for the subnet.") + addressPrefixes?: string[]; + + @doc("IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'") + ipAllocationMethod?: IpAllocationMethodEnum; + + @doc("IPConfigurationReferences - list of IPConfigurationReferences") + @extension("x-ms-identifiers", []) + ipConfigurationReferences?: SubnetIpConfigurationReference[]; + + @doc("NetworkSecurityGroup - Network Security Group attached to the logical network.") + networkSecurityGroup?: NetworkSecurityGroupArmReference; + + @doc("Route table resource.") + routeTable?: RouteTable; + + @doc("network associated pool of IP Addresses") + @extension("x-ms-identifiers", []) + ipPools?: IPPool[]; + + @doc("Vlan to use for the subnet") + vlan?: int32; +} + +@doc("Route table resource.") +model RouteTable { + @doc("A unique read-only string that changes whenever the resource is updated.") + @visibility("read") + etag?: string; + + @doc("Resource name.") + @visibility("read") + name?: string; + + @doc("Resource type.") + @visibility("read") + type?: string; + + @doc("Properties of the route table.") + @extension("x-ms-client-flatten", true) + properties?: RouteTableProperties; +} + +@doc("RouteTablePropertiesFormat - Route Table resource.") +model RouteTableProperties { + @doc("Collection of routes contained within a route table.") + @extension("x-ms-identifiers", []) + routes?: Route[]; +} + +@doc("Route - Route resource.") +model Route { + @doc("Properties of the route.") + @extension("x-ms-client-flatten", true) + properties?: RouteProperties; + + @doc("Name - name of the subnet") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$") + name?: string; +} + +@doc("RoutePropertiesFormat - Route resource.") +model RouteProperties { + @doc("The destination CIDR to which the route applies.") + addressPrefix?: string; + + @doc("The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.") + nextHopIpAddress?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "IP is a short form. The casing is correct." +@doc("Describes IPPool") +model IPPool { + @doc("Name of the IP-Pool") + name?: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "IP is a short form. The casing is correct." + @doc("Type of the IP Pool [vm, vippool]") + ipPoolType?: IPPoolTypeEnum; + + @doc("Start of the IP address pool") + start?: string; + + @doc("End of the IP address pool") + end?: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "IP is a short form. The casing is correct." + @doc("IPPool info") + info?: IPPoolInfo; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "IP is a short form. The casing is correct." +@doc("IP Pool info") +model IPPoolInfo { + @doc("Number of IP addresses allocated from the IP Pool") + @visibility("read") + used?: string; + + @doc("Number of IP addresses available in the IP Pool") + @visibility("read") + available?: string; +} + +@doc("Network Security Group resource.") +model NetworkSecurityGroupProperties { + @doc("A collection of references to network interfaces that are currently using this NSG.") + @visibility("read") + @extension("x-ms-identifiers", []) + networkInterfaces?: NetworkInterfaceArmReference[]; + + @doc("A collection of references to logical networks that are currently using this NSG") + @visibility("read") + subnets?: LogicalNetworkArmReference[]; + + @doc("The provisioning state of the network security group resource.") + @visibility("read") + provisioningState?: ProvisioningStateEnum; +} + +@doc("Security rule resource.") +model SecurityRuleProperties { + @doc("A description for this rule. Restricted to 140 chars.") + description?: string; + + @doc("Network protocol this rule applies to.") + protocol: SecurityRuleProtocol; + + @doc("The CIDR or source IP ranges.") + sourceAddressPrefixes?: string[]; + + @doc("The destination address prefixes. CIDR or destination IP ranges.") + destinationAddressPrefixes?: string[]; + + @doc("The source port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.") + sourcePortRanges?: string[]; + + @doc("The destination port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.") + destinationPortRanges?: string[]; + + @doc("The network traffic is allowed or denied.") + access: SecurityRuleAccess; + + @doc("The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.") + priority: int32; + + @doc("The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.") + direction: SecurityRuleDirection; + + @doc("Provisioning state of the SR") + @visibility("read") + provisioningState?: ProvisioningStateEnum; +} + +@doc("Properties under the network interface resource") +model NetworkInterfaceProperties { + @doc("IPConfigurations - A list of IPConfigurations of the network interface.") + @extension("x-ms-identifiers", []) + ipConfigurations?: IPConfiguration[]; + + @doc("MacAddress - The MAC address of the network interface.") + macAddress?: string; + + @doc("DNS Settings for the interface") + dnsSettings?: InterfaceDNSSettings; + + @doc("Provisioning state of the network interface.") + @visibility("read") + provisioningState?: ProvisioningStateEnum; + + @doc("The observed state of network interfaces") + @visibility("read") + status?: NetworkInterfaceStatus; + + @doc("NetworkSecurityGroup - Network Security Group attached to the network interface.") + networkSecurityGroup?: NetworkSecurityGroupArmReference; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "IP is a short form. The casing is correct." +@doc("InterfaceIPConfiguration IPConfiguration in a network interface.") +@extension("x-ms-client-flatten", true) +model IPConfiguration { + @doc("Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.") + @visibility("read", "create") + @pattern("^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$") + name?: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "IP is a short form. The casing is correct." + @doc("InterfaceIPConfigurationPropertiesFormat properties of IP configuration.") + properties?: IPConfigurationProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "IP is a short form. The casing is correct." +@doc("InterfaceIPConfigurationPropertiesFormat properties of IP configuration.") +model IPConfigurationProperties { + @doc("Gateway for network interface") + @visibility("read") + gateway?: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "IP is a short form. The casing is correct." + @doc("prefixLength for network interface") + @visibility("read") + prefixLength?: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "IP is a short form. The casing is correct." + @doc("PrivateIPAddress - Private IP address of the IP configuration.") + privateIPAddress?: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "IP is a short form. The casing is correct." + @doc("Subnet - Name of Subnet bound to the IP configuration.") + subnet?: LogicalNetworkArmReference; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "DNS is a short form. The casing is correct." +@doc("DNS Settings of the interface") +model InterfaceDNSSettings { + @doc("List of DNS server IP Addresses for the interface") + dnsServers?: string[]; +} + +@doc("The observed state of network interfaces") +@extension("x-ms-client-flatten", true) +model NetworkInterfaceStatus { + @doc("NetworkInterface provisioning error code") + errorCode?: string; + + @doc("Descriptive error message") + errorMessage?: string; + + @doc("Network interface provisioning status") + provisioningStatus?: NetworkInterfaceStatusProvisioningStatus; +} + +@doc("Network interface provisioning status") +model NetworkInterfaceStatusProvisioningStatus { + @doc("The ID of the operation performed on the network interface") + operationId?: string; + + @doc("The status of the operation performed on the network interface [Succeeded, Failed, InProgress]") + status?: Status; +} + +@doc("The observed state of logical networks") +@extension("x-ms-client-flatten", true) +model LogicalNetworkStatus { + @doc("LogicalNetwork provisioning error code") + errorCode?: string; + + @doc("Descriptive error message") + errorMessage?: string; + + @doc("Logical network provisioning status") + provisioningStatus?: LogicalNetworkStatusProvisioningStatus; +} + +@doc("Describes the status of the provisioning.") +model LogicalNetworkStatusProvisioningStatus { + @doc("The ID of the operation performed on the logical network") + operationId?: string; + + @doc("The status of the operation performed on the logical network [Succeeded, Failed, InProgress]") + status?: Status; +} + +@doc("The logical network resource patch definition.") +model LogicalNetworksUpdateRequest { + @doc("Resource tags") + tags?: Record; +} + +@doc("Properties under the marketplace gallery image resource") +model MarketplaceGalleryImageProperties { + @doc("Storage ContainerID of the storage container to be used for marketplace gallery image") + containerId?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/storageContainers"; + } + ]>; + + @doc("Operating system type that the gallery image uses [Windows, Linux]") + osType: OperatingSystemTypes; + + @doc("Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]") + cloudInitDataSource?: CloudInitDataSource; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "HyperV is the correct case." + @doc("The hypervisor generation of the Virtual Machine [V1, V2]") + hyperVGeneration?: HyperVGeneration; + + @doc("This is the gallery image definition identifier.") + identifier?: GalleryImageIdentifier; + + @doc("Specifies information about the gallery image version that you want to create or update.") + version?: GalleryImageVersion; + + @doc("Provisioning state of the marketplace gallery image.") + @visibility("read") + provisioningState?: ProvisioningStateEnum; + + @doc("The observed state of marketplace gallery images") + @visibility("read") + status?: MarketplaceGalleryImageStatus; +} + +@doc("The observed state of marketplace gallery images") +@extension("x-ms-client-flatten", true) +model MarketplaceGalleryImageStatus { + @doc("MarketplaceGalleryImage provisioning error code") + errorCode?: string; + + @doc("Descriptive error message") + errorMessage?: string; + + @doc("Provisioning status of marketplace gallery image") + provisioningStatus?: MarketplaceGalleryImageStatusProvisioningStatus; + + @doc("The download status of the gallery image") + downloadStatus?: MarketplaceGalleryImageStatusDownloadStatus; + + @doc("The progress of the operation in percentage") + progressPercentage?: int64; +} + +@doc("Marketplace GalleryImage provisioning status") +model MarketplaceGalleryImageStatusProvisioningStatus { + @doc("The ID of the operation performed on the gallery image") + operationId?: string; + + @doc("The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]") + status?: Status; +} + +@doc("The download status of the gallery image") +model MarketplaceGalleryImageStatusDownloadStatus { + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is a short form." + @doc("The downloaded sized of the image in MB") + downloadSizeInMB?: int64; +} + +@doc("The marketplace gallery image resource patch definition.") +model MarketplaceGalleryImagesUpdateRequest { + @doc("Resource tags") + tags?: Record; +} + +@doc("The network interface resource patch definition.") +model NetworkInterfacesUpdateRequest { + @doc("Resource tags") + tags?: Record; +} + +@doc("Tags object for patch operations.") +model TagsObject { + @doc("Resource tags.") + tags?: Record; +} + +@doc("Properties under the storage container resource") +model StorageContainerProperties { + @doc("Path of the storage container on the disk") + path: string; + + @doc("Provisioning state of the storage container.") + @visibility("read") + provisioningState?: ProvisioningStateEnum; + + @doc("The observed state of storage containers") + @visibility("read") + status?: StorageContainerStatus; +} + +@doc("The observed state of storage containers") +@extension("x-ms-client-flatten", true) +model StorageContainerStatus { + @doc("StorageContainer provisioning error code") + errorCode?: string; + + @doc("Descriptive error message") + errorMessage?: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is a short form." + @doc("Amount of space available on the disk in MB") + availableSizeMB?: int64; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is a short form." + @doc("Total size of the disk in MB") + containerSizeMB?: int64; + + @doc("Storage container's provisioning status") + provisioningStatus?: StorageContainerStatusProvisioningStatus; +} + +@doc("Storage container provisioning status") +model StorageContainerStatusProvisioningStatus { + @doc("The ID of the operation performed on the storage container") + operationId?: string; + + @doc("The status of the operation performed on the storage container [Succeeded, Failed, InProgress]") + status?: Status; +} + +@doc("The storage container resource patch definition.") +model StorageContainersUpdateRequest { + @doc("Resource tags") + tags?: Record; +} + +@doc("Properties under the virtual hard disk resource") +model VirtualHardDiskProperties { + @doc("Block size in bytes") + blockSizeBytes?: int32; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "GB is a short form." + @doc("Size of the disk in GB") + diskSizeGB?: int64; + + @doc("Boolean for enabling dynamic sizing on the virtual hard disk") + dynamic?: boolean; + + @doc("Logical sector in bytes") + logicalSectorBytes?: int32; + + @doc("Physical sector in bytes") + physicalSectorBytes?: int32; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "HyperV is the correct case." + @doc("The hypervisor generation of the Virtual Machine [V1, V2]") + hyperVGeneration?: HyperVGeneration; + + @doc("The format of the actual VHD file [vhd, vhdx]") + diskFileFormat?: DiskFileFormat; + + @doc("Provisioning state of the virtual hard disk.") + @visibility("read") + provisioningState?: ProvisioningStateEnum; + + @doc("Storage ContainerID of the storage container to be used for VHD") + containerId?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/storageContainers"; + } + ]>; + + @doc("The observed state of virtual hard disks") + @visibility("read") + status?: VirtualHardDiskStatus; +} + +@doc("The observed state of virtual hard disks") +@extension("x-ms-client-flatten", true) +model VirtualHardDiskStatus { + @doc("VirtualHardDisk provisioning error code") + errorCode?: string; + + @doc("Descriptive error message") + errorMessage?: string; + + @doc("Provisioning status of the vhd") + provisioningStatus?: VirtualHardDiskStatusProvisioningStatus; +} + +@doc("VHD Status provisioning status") +model VirtualHardDiskStatusProvisioningStatus { + @doc("The ID of the operation performed on the virtual hard disk") + operationId?: string; + + @doc("The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress]") + status?: Status; +} + +@doc("The virtual hard disk resource patch definition.") +model VirtualHardDisksUpdateRequest { + @doc("Resource tags") + tags?: Record; +} + +@doc("Properties under the virtual machine instance resource") +model VirtualMachineInstanceProperties { + @doc("HardwareProfile - Specifies the hardware settings for the virtual machine instance.") + hardwareProfile?: VirtualMachineInstancePropertiesHardwareProfile; + + @doc("NetworkProfile - describes the network configuration the virtual machine instance") + networkProfile?: VirtualMachineInstancePropertiesNetworkProfile; + + @doc("OsProfile - describes the configuration of the operating system and sets login data") + osProfile?: VirtualMachineInstancePropertiesOsProfile; + + @doc("SecurityProfile - Specifies the security settings for the virtual machine instance.") + securityProfile?: VirtualMachineInstancePropertiesSecurityProfile; + + @doc("StorageProfile - contains information about the disks and storage information for the virtual machine instance") + storageProfile?: VirtualMachineInstancePropertiesStorageProfile; + + @doc("HTTP Proxy configuration for the VM.") + httpProxyConfig?: HttpProxyConfiguration; + + @doc("Provisioning state of the virtual machine instance.") + @visibility("read") + provisioningState?: ProvisioningStateEnum; + + @doc("The virtual machine instance view.") + @visibility("read") + instanceView?: VirtualMachineInstanceView; + + @doc("The observed state of virtual machine instances") + @visibility("read") + status?: VirtualMachineInstanceStatus; + + @doc("Guest agent install status.") + guestAgentInstallStatus?: GuestAgentInstallStatus; + + @doc("Unique identifier for the vm resource.") + @visibility("read") + vmId?: string; + + @doc("Unique identifier defined by ARC to identify the guest of the VM.") + resourceUid?: string; +} + +@doc("HardwareProfile - Specifies the hardware settings for the virtual machine instance.") +model VirtualMachineInstancePropertiesHardwareProfile { + @doc("Enum of VM Sizes") + vmSize?: VmSizeEnum = VmSizeEnum.Default; + + @doc("number of processors for the virtual machine instance") + processors?: int32; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is a short form." + @doc("RAM in MB for the virtual machine instance") + memoryMB?: int64; + + @doc("Dynamic memory config") + dynamicMemoryConfig?: VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig; +} + +@doc("Dynamic memory config") +model VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig { + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is a short form." + @doc("Maximum memory in MB") + maximumMemoryMB?: int64; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is a short form." + @doc("Minimum memory in MB") + minimumMemoryMB?: int64; + + @doc("Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000.") + targetMemoryBuffer?: int32; +} + +@doc("NetworkProfile - describes the network configuration the virtual machine instance") +model VirtualMachineInstancePropertiesNetworkProfile { + @doc("NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance") + @extension("x-ms-identifiers", []) + networkInterfaces?: NetworkInterfaceArmReference[]; +} + +@doc("OsProfile - describes the configuration of the operating system and sets login data") +model VirtualMachineInstancePropertiesOsProfile { + @doc("AdminPassword - admin password") + @visibility("create") + @secret + adminPassword?: string; + + @doc("AdminUsername - admin username") + adminUsername?: string; + + @doc("ComputerName - name of the compute") + computerName?: string; + + @doc("LinuxConfiguration - linux specific configuration values for the virtual machine instance") + linuxConfiguration?: VirtualMachineInstancePropertiesOsProfileLinuxConfiguration; + + @doc("Windows Configuration for the virtual machine instance") + windowsConfiguration?: VirtualMachineInstancePropertiesOsProfileWindowsConfiguration; +} + +@doc("LinuxConfiguration - linux specific configuration values for the virtual machine instance") +model VirtualMachineInstancePropertiesOsProfileLinuxConfiguration { + @doc("DisablePasswordAuthentication - whether password authentication should be disabled") + disablePasswordAuthentication?: boolean; + + @doc("Specifies the ssh key configuration for a Linux OS.") + ssh?: SshConfiguration; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "VM is a short form. It is the correct case" + @doc("Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.") + provisionVMAgent?: boolean = true; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "VM is a short form. It is the correct case" + @doc("Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.") + provisionVMConfigAgent?: boolean = true; +} + +@doc("SSH configuration for Linux based VMs running on Azure") +model SshConfiguration { + @doc("The list of SSH public keys used to authenticate with linux based VMs.") + @extension("x-ms-identifiers", ["path"]) + publicKeys?: SshPublicKey[]; +} + +@doc("Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.") +model SshPublicKey { + @doc("Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys") + path?: string; + + @doc("SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).") + keyData?: string; +} + +@doc("Windows Configuration for the virtual machine instance") +model VirtualMachineInstancePropertiesOsProfileWindowsConfiguration { + @doc("Whether to EnableAutomaticUpdates on the machine") + enableAutomaticUpdates?: boolean; + + @doc("Specifies the ssh key configuration for Windows OS.") + ssh?: SshConfiguration; + + @doc("TimeZone for the virtual machine instance") + timeZone?: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "VM is a short form. It is the correct case" + @doc("Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.") + provisionVMAgent?: boolean = true; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "VM is a short form. It is the correct case" + @doc("Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.") + provisionVMConfigAgent?: boolean = true; +} + +@doc("SecurityProfile - Specifies the security settings for the virtual machine instance.") +model VirtualMachineInstancePropertiesSecurityProfile { + #suppress "@azure-tools/typespec-azure-core/casing-style" "TPM is a short form. It is the correct case" + @doc("Enable TPM flag") + enableTPM?: boolean = false; + + @doc("Uefi settings of the virtual machine instance") + uefiSettings?: VirtualMachineInstancePropertiesSecurityProfileUefiSettings; + + @doc("Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function.") + securityType?: SecurityTypes; +} + +@doc("Uefi settings - Specifies whether secure boot should be enabled on the virtual machine instance.") +model VirtualMachineInstancePropertiesSecurityProfileUefiSettings { + @doc("Specifies whether secure boot should be enabled on the virtual machine instance.") + secureBootEnabled?: boolean = false; +} + +@doc("StorageProfile - contains information about the disks and storage information for the virtual machine instance") +model VirtualMachineInstancePropertiesStorageProfile { + @doc("adds data disks to the virtual machine instance") + dataDisks?: VirtualHardDiskArmReference[]; + + @doc("Which Image to use for the virtual machine instance") + @visibility("read", "create") + imageReference?: ImageArmReference; + + @doc("VHD to attach as OS disk") + osDisk?: VirtualMachineInstancePropertiesStorageProfileOsDisk; + + @doc("Id of the storage container that hosts the VM configuration file") + vmConfigStoragePathId?: armResourceIdentifier<[ + { + type: "Microsoft.AzureStackHCI/storageContainers"; + } + ]>; +} + +@doc("VHD to attach as OS disk") +model VirtualMachineInstancePropertiesStorageProfileOsDisk + is VirtualHardDiskArmReference { + @doc("This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux.") + osType?: OperatingSystemTypes; +} + +@doc("HTTP Proxy configuration for the VM.") +model HttpProxyConfiguration { + @doc("The HTTP proxy server endpoint to use.") + @secret + httpProxy?: string; + + @doc("The HTTPS proxy server endpoint to use.") + @secret + httpsProxy?: string; + + @doc("The endpoints that should not go through proxy.") + noProxy?: string[]; + + @doc("Alternative CA cert to use for connecting to proxy servers.") + trustedCa?: string; +} + +@doc("The instance view of a virtual machine.") +model VirtualMachineInstanceView { + @doc("The VM Config Agent running on the virtual machine.") + vmAgent?: VirtualMachineConfigAgentInstanceView; +} + +@doc("The instance view of the VM Config Agent running on the virtual machine.") +model VirtualMachineConfigAgentInstanceView { + @doc("The VM Config Agent full version.") + vmConfigAgentVersion?: string; + + @doc("The resource status information.") + @extension("x-ms-identifiers", []) + statuses?: InstanceViewStatus[]; +} + +@doc("Instance view status.") +model InstanceViewStatus { + @doc("The status code.") + code?: string; + + @doc("The level code.") + level?: StatusLevelTypes; + + @doc("The short localizable label for the status.") + displayStatus?: string; + + @doc("The detailed status message, including for alerts and error messages.") + message?: string; + + @doc("The time of the status.") + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + time?: utcDateTime; +} + +@doc("The observed state of virtual machine instances") +@extension("x-ms-client-flatten", true) +model VirtualMachineInstanceStatus { + @doc("VirtualMachine provisioning error code") + errorCode?: string; + + @doc("Descriptive error message") + errorMessage?: string; + + @doc("The power state of the virtual machine instance") + powerState?: PowerStateEnum; + + @doc("Provisioning status of the virtual machine instance") + provisioningStatus?: VirtualMachineInstanceStatusProvisioningStatus; +} + +@doc("Virtual machine instance provisioning status.") +model VirtualMachineInstanceStatusProvisioningStatus { + @doc("The ID of the operation performed on the virtual machine instance") + operationId?: string; + + @doc("The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress]") + status?: Status; +} + +@doc("Defines the status of a guest agent installation.") +model GuestAgentInstallStatus { + @doc("Specifies the VM's unique SMBIOS ID.") + @visibility("read") + vmUuid?: string; + + @doc("The installation status of the hybrid machine agent installation.") + @visibility("read") + status?: StatusTypes; + + @doc("The time of the last status change.") + @visibility("read") + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + lastStatusChange?: utcDateTime; + + @doc("The hybrid machine agent full version.") + @visibility("read") + agentVersion?: string; + + @doc("Details about the error state.") + @visibility("read") + errorDetails?: Azure.ResourceManager.Foundations.ErrorDetail[]; +} + +@doc("Identity for the resource.") +model Identity { + @doc("The principal ID of resource identity. The value must be an UUID.") + @visibility("read") + principalId?: string; + + @doc("The tenant ID of resource. The value must be an UUID.") + @visibility("read") + tenantId?: string; + + @doc("The identity type.") + type?: "SystemAssigned"; +} + +@doc("The virtual machine instance resource patch definition.") +model VirtualMachineInstanceUpdateRequest { + @doc("Defines the resource properties for the update.") + properties?: VirtualMachineInstanceUpdateProperties; + + @doc("Identity for the resource.") + identity?: Identity; +} + +@doc("Defines the resource properties for the update.") +model VirtualMachineInstanceUpdateProperties { + @doc("HardwareProfile - Specifies the hardware settings for the virtual machine instance.") + hardwareProfile?: HardwareProfileUpdate; + + @doc("StorageProfile - Specifies the storage settings for the virtual machine instance.") + storageProfile?: StorageProfileUpdate; + + @doc("NetworkProfile - describes the network update configuration the virtual machine instance") + networkProfile?: NetworkProfileUpdate; + + @doc("OsProfile - describes the update configuration of the operating system") + osProfile?: OsProfileUpdate; +} + +@doc("HardwareProfile - Specifies the hardware settings for the virtual machine instance.") +model HardwareProfileUpdate { + @doc("VM Size Enum") + vmSize?: VmSizeEnum; + + @doc("number of processors for the virtual machine instance") + processors?: int32; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "MB is a short form." + @doc("RAM in MB for the virtual machine instance") + memoryMB?: int64; +} + +@doc("Storage profile update") +model StorageProfileUpdate { + @doc("adds data disks to the virtual machine instance for the update call") + dataDisks?: VirtualHardDiskArmReference[]; +} + +@doc("NetworkProfile - describes the network update configuration the virtual machine instance") +model NetworkProfileUpdate { + @doc("NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance") + @extension("x-ms-identifiers", []) + networkInterfaces?: NetworkInterfaceArmReference[]; +} + +@doc("OsProfile - describes the update configuration of the operating system") +model OsProfileUpdate { + @doc("ComputerName - name of the computer") + computerName?: string; + + @doc("Linux configuration properties") + linuxConfiguration?: OsProfileUpdateLinuxConfiguration; + + @doc("Windows configuration properties") + windowsConfiguration?: OsProfileUpdateWindowsConfiguration; +} + +@doc("OSProfile update linux configuration") +model OsProfileUpdateLinuxConfiguration { + #suppress "@azure-tools/typespec-azure-core/casing-style" "VM is a short form. It is the correct case" + @doc("Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.") + provisionVMAgent?: boolean; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "VM is a short form. It is the correct case" + @doc("Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.") + provisionVMConfigAgent?: boolean; +} + +@doc("OSProfile update windows configuration") +model OsProfileUpdateWindowsConfiguration { + #suppress "@azure-tools/typespec-azure-core/casing-style" "VM is a short form. It is the correct case" + @doc("Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.") + provisionVMAgent?: boolean; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "VM is a short form. It is the correct case" + @doc("Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.") + provisionVMConfigAgent?: boolean; +} + +@doc("Defines the resource properties.") +model HybridIdentityMetadataProperties { + @doc("The unique identifier for the resource.") + resourceUid?: string; + + @doc("The Public Key.") + publicKey?: string; + + @doc("Identity for the resource.") + @visibility("read") + identity?: Identity; + + @doc("Provisioning state of the virtual machine instance.") + @visibility("read") + provisioningState?: ProvisioningStateEnum; +} + +@doc("Defines the attestation status properties") +model AttestationStatusProperties { + @doc("The status of whether secure boot is enabled.") + @visibility("read") + attestSecureBootEnabled?: AttestSecureBootPropertyEnum = AttestSecureBootPropertyEnum.Unknown; + + @doc("The status of whether attestation certificate is validated.") + @visibility("read") + attestationCertValidated?: AttestCertPropertyEnum = AttestCertPropertyEnum.Unknown; + + @doc("The status of whether the list of boot integrity properties is validated.") + @visibility("read") + bootIntegrityValidated?: AttestBootIntegrityPropertyEnum = AttestBootIntegrityPropertyEnum.Unknown; + + @doc("kernel version string for Linux VM.") + @visibility("read") + linuxKernelVersion?: string; + + @doc("The health status of attestation validation and parsing") + @visibility("read") + healthStatus?: AttestHealthStatusEnum = AttestHealthStatusEnum.Unknown; + + @doc("The time stamp of the last time attestation token is validated by relying party service.") + @visibility("read") + timestamp?: string; + + @doc("The error message of attestation validation and parsing") + @visibility("read") + errorMessage?: string; + + @doc("Provisioning state of the virtual machine instance.") + @visibility("read") + provisioningState?: ProvisioningStateEnum; +} + +@doc("Defines the resource properties.") +model GuestAgentProperties { + @doc("Username / Password Credentials to provision guest agent.") + credentials?: GuestCredential; + + @doc("The guest agent provisioning action.") + provisioningAction?: ProvisioningAction; + + @doc("The guest agent status.") + @visibility("read") + status?: string; + + @doc("Provisioning state of the virtual machine instance.") + @visibility("read") + provisioningState?: ProvisioningStateEnum; +} + +@doc("Username / Password Credentials to connect to guest.") +model GuestCredential { + @doc("The username to connect with the guest.") + username?: string; + + @doc("The password to connect with the guest.") + @visibility("create", "update") + @secret + password?: string; +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml new file mode 100644 index 000000000000..0a082d97d76d --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml @@ -0,0 +1,12 @@ +emit: + - "@azure-tools/typespec-autorest" +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}/StackHCIVM/{version-status}/{version}/stackhcivm.json" + examples-directory: "{project-root}/examples" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/azurestackhci/Operations.Management/examples/2024-02-01-preview/Operations_List.json b/specification/azurestackhci/Operations.Management/examples/2024-02-01-preview/Operations_List.json new file mode 100644 index 000000000000..4a5ff103d84a --- /dev/null +++ b/specification/azurestackhci/Operations.Management/examples/2024-02-01-preview/Operations_List.json @@ -0,0 +1,305 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Deletes virtual hard disk resource", + "description": "Deletes virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Creates/Updates virtual hard disk resource", + "description": "Creates/Updates virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Gets/Lists virtual hard disk resource", + "description": "Gets/Lists virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Deletes network interfaces resource", + "description": "Deletes network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Creates/Updates network interfaces resource", + "description": "Creates/Updates network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Gets/Lists network interfaces resource", + "description": "Gets/Lists network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Deletes gallery images resource", + "description": "Deletes gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Creates/Updates gallery images resource", + "description": "Creates/Updates gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Gets/Lists gallery images resource", + "description": "Gets/Lists gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/HybridIdentityMetadata/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances/HybridIdentityMetadata", + "operation": "Gets/Lists virtual machine instance hybrid identity metadata proxy resource", + "description": "Gets/Lists virtual machine instance hybrid identity metadata proxy resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/attestationStatus/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances/attestationStatus", + "operation": "Gets/Lists virtual machine instance's attestation status", + "description": "Gets/Lists virtual machine instance's attestation status" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Deletes logical networks resource", + "description": "Deletes logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Creates/Updates logical networks resource", + "description": "Creates/Updates logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Gets/Lists logical networks resource", + "description": "Gets/Lists logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/join/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Joins logical networks resource", + "description": "Joins logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Restart/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Restarts virtual machine instance resource", + "description": "Restarts virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Start/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Starts virtual machine instance resource", + "description": "Starts virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Stop/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Stops virtual machine instance resource", + "description": "Stops virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Deletes virtual machine instance resource", + "description": "Deletes virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Creates/Updates virtual machine instance resource", + "description": "Creates/Updates virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Gets/Lists virtual machine instance resource", + "description": "Gets/Lists virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Deletes storage containers resource", + "description": "Deletes storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Creates/Updates storage containers resource", + "description": "Creates/Updates storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Gets/Lists storage containers resource", + "description": "Gets/Lists storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/deploy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Deploys storage containers resource", + "description": "Deploys storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Deletes market place gallery images resource", + "description": "Deletes market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Creates/Updates market place gallery images resource", + "description": "Creates/Updates market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Gets/Lists market place gallery images resource", + "description": "Gets/Lists market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/deploy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Deploys market place gallery images resource", + "description": "Deploys market place gallery images resource" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List the operations for the provider." +} diff --git a/specification/azurestackhci/Operations.Management/main.tsp b/specification/azurestackhci/Operations.Management/main.tsp new file mode 100644 index 000000000000..b56ae312dc3e --- /dev/null +++ b/specification/azurestackhci/Operations.Management/main.tsp @@ -0,0 +1,34 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; +/** + * Azure Stack HCI management service + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "HCI itself is a short form." +@armProviderNamespace +@service({ + title: "Microsoft.AzureStackHCI", +}) +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AzureStackHCI; + +/** + * The available API versions. + */ +enum Versions { + /** + * The 2024-02-01-preview API version. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_02_01_preview: "2024-02-01-preview", +} diff --git a/specification/azurestackhci/Operations.Management/models.tsp b/specification/azurestackhci/Operations.Management/models.tsp new file mode 100644 index 000000000000..9cd08de9580e --- /dev/null +++ b/specification/azurestackhci/Operations.Management/models.tsp @@ -0,0 +1,12 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; + +#suppress "@azure-tools/typespec-azure-core/casing-style" "HCI itself is a short form." +namespace Microsoft.AzureStackHCI; + +interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/azurestackhci/Operations.Management/tspconfig.yaml b/specification/azurestackhci/Operations.Management/tspconfig.yaml new file mode 100644 index 000000000000..dc13f45348b5 --- /dev/null +++ b/specification/azurestackhci/Operations.Management/tspconfig.yaml @@ -0,0 +1,12 @@ +emit: + - "@azure-tools/typespec-autorest" +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}/operations/{version-status}/{version}/operations.json" + examples-directory: "{project-root}/examples" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/AttestationStatuses_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/AttestationStatuses_Get.json new file mode 100644 index 000000000000..c73ee3617166 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/AttestationStatuses_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/AttestationStatus", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default", + "properties": { + "attestSecureBootEnabled": "Disabled", + "attestationCertValidated": "Invalid", + "bootIntegrityValidated": "Invalid", + "errorMessage": "Attestation token has invalid signature", + "healthStatus": "Unhealthy", + "linuxKernelVersion": "1.0.0.0", + "timestamp": "2023/11/10 9:48" + } + } + } + }, + "operationId": "AttestationStatuses_Get", + "title": "GetAttestationStatus" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/DefaultSecurityRules_ListByNetworkSecurityGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/DefaultSecurityRules_ListByNetworkSecurityGroup.json new file mode 100644 index 000000000000..a0baf5ef8b44 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/DefaultSecurityRules_ListByNetworkSecurityGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resource": { + "location": "eastus" + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "title": "Create network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..625e304ccbcf --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_CreateOrUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "galleryImageName": "test-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "imagePath": "C:\\test.vhdx", + "osType": "Linux" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Succeeded", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_CreateOrUpdate", + "title": "PutGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_Delete.json new file mode 100644 index 000000000000..f55433c2b81c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Delete", + "title": "DeleteGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_Get.json new file mode 100644 index 000000000000..7932b63e4ec3 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_Get", + "title": "GetGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_ListAll.json new file mode 100644 index 000000000000..588342065cff --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_ListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListAll", + "title": "ListGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..2870831af86e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListByResourceGroup", + "title": "ListGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_Update.json new file mode 100644 index 000000000000..035f0e6a8376 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GalleryImages_Update.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "galleryImageName": "test-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Update", + "title": "UpdateGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_Create.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_Create.json new file mode 100644 index 000000000000..fb3503d12fa1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_Create.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resource": { + "properties": { + "credentials": { + "password": "", + "username": "tempuser" + }, + "provisioningAction": "install" + } + }, + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Created", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Create", + "title": "CreateGuestAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_Delete.json new file mode 100644 index 000000000000..7edd761afd32 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GuestAgents_Delete", + "title": "DeleteGuestAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_Get.json new file mode 100644 index 000000000000..e350bcf9a21c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Get", + "title": "GetGuestAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_ListByVirtualMachineInstance.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..763ed44a39d3 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/GuestAgents_ListByVirtualMachineInstance.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + ] + } + } + }, + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "title": "GuestAgentListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/HybridIdentityMetadataGroup_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/HybridIdentityMetadataGroup_Get.json new file mode 100644 index 000000000000..b8e26dcf12ef --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/HybridIdentityMetadataGroup_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + } + }, + "operationId": "HybridIdentityMetadata_Get", + "title": "GetHybridIdentityMetadata" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..f8900e2f6774 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + ] + } + } + }, + "operationId": "HybridIdentityMetadata_ListByVirtualMachineInstance", + "title": "HybridIdentityMetadataListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_CreateOrUpdate.json new file mode 100644 index 000000000000..56e12010fb82 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_CreateOrUpdate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "logicalNetworkName": "test-lnet", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2" + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "LogicalNetworks_CreateOrUpdate", + "title": "PutLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_Delete.json new file mode 100644 index 000000000000..a994c9ddbbf2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Delete", + "title": "DeleteLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_Get.json new file mode 100644 index 000000000000..1726a541ecb3 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "LogicalNetworks_Get", + "title": "GetLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_ListAll.json new file mode 100644 index 000000000000..ac0cb9f62bd0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_ListAll.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListAll", + "title": "ListLogicalNetworkBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..43fd5e75fe77 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_ListByResourceGroup.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListByResourceGroup", + "title": "ListLogicalNetworkByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_Update.json new file mode 100644 index 000000000000..bd3b62dc7c54 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/LogicalNetworks_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "logicalNetworkName": "test-lnet", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Update", + "title": "UpdateLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..f4c9ee0355e5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "name": "test-marketplace-gallery-image", + "api-version": "2024-02-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "version": { + "name": "1.0.0" + } + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Creating", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_CreateOrUpdate", + "title": "PutMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_Delete.json new file mode 100644 index 000000000000..d307ea1f339c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Delete", + "title": "DeleteMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_Get.json new file mode 100644 index 000000000000..20e91c809e31 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_Get", + "title": "GetMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_ListAll.json new file mode 100644 index 000000000000..a1c2ecc5c23e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_ListAll.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListAll", + "title": "ListMarketplaceGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..98a8d0f6358b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListByResourceGroup", + "title": "ListMarketplaceGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_Update.json new file mode 100644 index 000000000000..591e5d00baa1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/MarketplaceGalleryImages_Update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "marketplaceGalleryImageName": "test-marketplce-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Update", + "title": "UpdateMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_CreateOrUpdate.json new file mode 100644 index 000000000000..d1d6a94cb097 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_CreateOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkInterfaceName": "test-nic", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "eastus", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ] + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkInterfaces_CreateOrUpdate", + "title": "PutNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..849a2fa55d23 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Delete", + "title": "DeleteNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_Get.json new file mode 100644 index 000000000000..0ba891a6e316 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "NetworkInterfaces_Get", + "title": "GetNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_ListAll.json new file mode 100644 index 000000000000..877649fb00fd --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_ListAll.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListAll", + "title": "ListNetworkInterfaceBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_ListByResourceGroup.json new file mode 100644 index 000000000000..7ad9a7e22ec2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListByResourceGroup", + "title": "ListNetworkInterfaceByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_Update.json new file mode 100644 index 000000000000..b492fca2b844 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkInterfaces_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkInterfaceName": "test-nic", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Update", + "title": "UpdateNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json new file mode 100644 index 000000000000..25dd85ff1ddb --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resource": { + "location": "eastus" + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "title": "CreateNetworkSecurityGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_Delete.json new file mode 100644 index 000000000000..6cf6a0d2a421 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_Delete", + "title": "Delete network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_Get.json new file mode 100644 index 000000000000..6e89c13d91b8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg1/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_Get", + "title": "Get network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_ListAll.json new file mode 100644 index 000000000000..43a1fe797c7e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_ListAll.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg2", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg2/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg2", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListAll", + "title": "List all network security groups" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..05f46cfd5b5b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg3", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg3", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListByResourceGroup", + "title": "List network security groups in resource group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_UpdateTags.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_UpdateTags.json new file mode 100644 index 000000000000..ea3c52fac399 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/NetworkSecurityGroups_UpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_UpdateTags", + "title": "Update network security group tags" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/Operations_List.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..4a5ff103d84a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/Operations_List.json @@ -0,0 +1,305 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Deletes virtual hard disk resource", + "description": "Deletes virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Creates/Updates virtual hard disk resource", + "description": "Creates/Updates virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Gets/Lists virtual hard disk resource", + "description": "Gets/Lists virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Deletes network interfaces resource", + "description": "Deletes network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Creates/Updates network interfaces resource", + "description": "Creates/Updates network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Gets/Lists network interfaces resource", + "description": "Gets/Lists network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Deletes gallery images resource", + "description": "Deletes gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Creates/Updates gallery images resource", + "description": "Creates/Updates gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Gets/Lists gallery images resource", + "description": "Gets/Lists gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/HybridIdentityMetadata/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances/HybridIdentityMetadata", + "operation": "Gets/Lists virtual machine instance hybrid identity metadata proxy resource", + "description": "Gets/Lists virtual machine instance hybrid identity metadata proxy resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/attestationStatus/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances/attestationStatus", + "operation": "Gets/Lists virtual machine instance's attestation status", + "description": "Gets/Lists virtual machine instance's attestation status" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Deletes logical networks resource", + "description": "Deletes logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Creates/Updates logical networks resource", + "description": "Creates/Updates logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Gets/Lists logical networks resource", + "description": "Gets/Lists logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/join/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Joins logical networks resource", + "description": "Joins logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Restart/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Restarts virtual machine instance resource", + "description": "Restarts virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Start/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Starts virtual machine instance resource", + "description": "Starts virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Stop/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Stops virtual machine instance resource", + "description": "Stops virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Deletes virtual machine instance resource", + "description": "Deletes virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Creates/Updates virtual machine instance resource", + "description": "Creates/Updates virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Gets/Lists virtual machine instance resource", + "description": "Gets/Lists virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Deletes storage containers resource", + "description": "Deletes storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Creates/Updates storage containers resource", + "description": "Creates/Updates storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Gets/Lists storage containers resource", + "description": "Gets/Lists storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/deploy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Deploys storage containers resource", + "description": "Deploys storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Deletes market place gallery images resource", + "description": "Deletes market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Creates/Updates market place gallery images resource", + "description": "Creates/Updates market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Gets/Lists market place gallery images resource", + "description": "Gets/Lists market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/deploy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Deploys market place gallery images resource", + "description": "Deploys market place gallery images resource" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List the operations for the provider." +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_CreateOrUpdate.json new file mode 100644 index 000000000000..3f4e58c8721d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_CreateOrUpdate", + "title": "SecurityRulesCreateOrUpdate" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_Delete.json new file mode 100644 index 000000000000..4e2d69c17dff --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "SecurityRules_Delete", + "title": "SecurityRulesDelete" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_Get.json new file mode 100644 index 000000000000..c78dd2d79668 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_Get", + "title": "Get network security rule in network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json new file mode 100644 index 000000000000..3263f0e4f323 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + ] + } + } + }, + "operationId": "SecurityRules_ListByNetworkSecurityGroup", + "title": "List network security rules in network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_CreateOrUpdate.json new file mode 100644 index 000000000000..8a4444585098 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "path": "C:\\container_storage" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "StorageContainers_CreateOrUpdate", + "title": "PutStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_Delete.json new file mode 100644 index 000000000000..2200c4db8fbc --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Delete", + "title": "DeleteStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_Get.json new file mode 100644 index 000000000000..567027da24f5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "StorageContainers_Get", + "title": "GetStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_ListAll.json new file mode 100644 index 000000000000..c072a84422f1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_ListAll.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListAll", + "title": "ListStorageContainerBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_ListByResourceGroup.json new file mode 100644 index 000000000000..2976d038e253 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListByResourceGroup", + "title": "ListStorageContainerByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_Update.json new file mode 100644 index 000000000000..f6868128d23c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/StorageContainers_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Update", + "title": "UpdateStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_CreateOrUpdate.json new file mode 100644 index 000000000000..d2f44d5c884c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_CreateOrUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "diskSizeGB": 32 + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "VirtualHardDisks_CreateOrUpdate", + "title": "PutVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_Delete.json new file mode 100644 index 000000000000..541cb195b39e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Delete", + "title": "DeleteVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_Get.json new file mode 100644 index 000000000000..aeb4a697e8dd --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "VirtualHardDisks_Get", + "title": "GetVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_ListAll.json new file mode 100644 index 000000000000..615a36633889 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_ListAll.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListAll", + "title": "ListVirtualHardDiskBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_ListByResourceGroup.json new file mode 100644 index 000000000000..fa8b428580f9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListByResourceGroup", + "title": "ListVirtualHardDiskByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_Update.json new file mode 100644 index 000000000000..1ae3c83ac98b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualHardDisks_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "properties": { + "tags": { + "additionalProperties": "sample" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Update", + "title": "UpdateVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json new file mode 100644 index 000000000000..a91320df1aa6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json new file mode 100644 index 000000000000..d69de8202af0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json new file mode 100644 index 000000000000..b969d236e308 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Succeeded", + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithOsDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json new file mode 100644 index 000000000000..ad29a53df4f9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster", + "windowsConfiguration": { + "provisionVMConfigAgent": true + } + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithVMConfigAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Delete.json new file mode 100644 index 000000000000..cb0fdb58b717 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Delete", + "title": "DeleteVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Get.json new file mode 100644 index 000000000000..85bee1c16d3e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_Get", + "title": "GetVirtualMachineInstance" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_List.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_List.json new file mode 100644 index 000000000000..a8b6f203e211 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + ] + } + } + }, + "operationId": "VirtualMachineInstances_List", + "title": "ListVirtualMachineInstances" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Pause.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Pause.json new file mode 100644 index 000000000000..2972c7be6d73 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Pause.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Pause", + "title": "PauseVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Restart.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Restart.json new file mode 100644 index 000000000000..cbe832ef1eb8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Restart", + "title": "RestartVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Save.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Save.json new file mode 100644 index 000000000000..9c3a010fa826 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Save.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Save", + "title": "SaveVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Start.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Start.json new file mode 100644 index 000000000000..363ab5468eb3 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Start", + "title": "StartVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Stop.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Stop.json new file mode 100644 index 000000000000..cb301a5be1b0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Stop.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Stop", + "title": "StopVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Update.json new file mode 100644 index 000000000000..13610e656a93 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/examples/VirtualMachineInstances_Update.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "properties": { + "properties": { + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ], + "imageReference": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + } + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Update", + "title": "UpdateVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json new file mode 100644 index 000000000000..db8910818cc0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json @@ -0,0 +1,7079 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AzureStackHCI", + "version": "2024-02-01-preview", + "description": "Azure Stack HCI management service", + "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": "GalleryImages" + }, + { + "name": "LogicalNetworks" + }, + { + "name": "MarketplaceGalleryImages" + }, + { + "name": "NetworkInterfaces" + }, + { + "name": "NetworkSecurityGroups" + }, + { + "name": "SecurityRules" + }, + { + "name": "StorageContainers" + }, + { + "name": "VirtualHardDisks" + }, + { + "name": "VirtualMachineInstances" + }, + { + "name": "HybridIdentityMetadataGroup" + }, + { + "name": "AttestationStatuses" + }, + { + "name": "GuestAgents" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances": { + "get": { + "operationId": "VirtualMachineInstances_List", + "tags": [ + "VirtualMachineInstances" + ], + "description": "Lists all of the virtual machine instances within the specified parent resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListVirtualMachineInstances": { + "$ref": "./examples/VirtualMachineInstances_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default": { + "get": { + "operationId": "VirtualMachineInstances_Get", + "tags": [ + "VirtualMachineInstances" + ], + "description": "Gets a virtual machine instance", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetVirtualMachineInstance": { + "$ref": "./examples/VirtualMachineInstances_Get.json" + } + } + }, + "put": { + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualMachineInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "201": { + "description": "Resource 'VirtualMachineInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + }, + "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": { + "PutVirtualMachineInstanceWithGalleryImage": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json" + }, + "PutVirtualMachineInstanceWithMarketplaceGalleryImage": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json" + }, + "PutVirtualMachineInstanceWithOsDisk": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json" + }, + "PutVirtualMachineInstanceWithVMConfigAgent": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualMachineInstances_Update", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to update a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceUpdateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "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": { + "UpdateVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualMachineInstances_Delete", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to delete a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "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": { + "DeleteVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default": { + "get": { + "operationId": "AttestationStatuses_Get", + "tags": [ + "AttestationStatuses" + ], + "description": "Implements AttestationStatus GET method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AttestationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAttestationStatus": { + "$ref": "./examples/AttestationStatuses_Get.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents": { + "get": { + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "tags": [ + "GuestAgents" + ], + "description": "Returns the list of GuestAgent of the given vm.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GuestAgentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GuestAgentListByVirtualMachineInstances": { + "$ref": "./examples/GuestAgents_ListByVirtualMachineInstance.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default": { + "get": { + "operationId": "GuestAgents_Get", + "tags": [ + "GuestAgents" + ], + "description": "Implements GuestAgent GET method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GuestAgent" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetGuestAgent": { + "$ref": "./examples/GuestAgents_Get.json" + } + } + }, + "put": { + "operationId": "GuestAgents_Create", + "tags": [ + "GuestAgents" + ], + "description": "Create Or Update GuestAgent.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GuestAgent" + } + } + ], + "responses": { + "200": { + "description": "Resource 'GuestAgent' update operation succeeded", + "schema": { + "$ref": "#/definitions/GuestAgent" + } + }, + "201": { + "description": "Resource 'GuestAgent' create operation succeeded", + "schema": { + "$ref": "#/definitions/GuestAgent" + }, + "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": { + "CreateGuestAgent": { + "$ref": "./examples/GuestAgents_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "GuestAgents_Delete", + "tags": [ + "GuestAgents" + ], + "description": "Implements GuestAgent DELETE method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "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": { + "DeleteGuestAgent": { + "$ref": "./examples/GuestAgents_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata": { + "get": { + "operationId": "HybridIdentityMetadata_ListByVirtualMachineInstance", + "tags": [ + "HybridIdentityMetadataGroup" + ], + "description": "Returns the list of HybridIdentityMetadata of the given vm.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HybridIdentityMetadataListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HybridIdentityMetadataListByVirtualMachineInstances": { + "$ref": "./examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default": { + "get": { + "operationId": "HybridIdentityMetadata_Get", + "tags": [ + "HybridIdentityMetadataGroup" + ], + "description": "Implements HybridIdentityMetadata GET method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HybridIdentityMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetHybridIdentityMetadata": { + "$ref": "./examples/HybridIdentityMetadataGroup_Get.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/pause": { + "post": { + "operationId": "VirtualMachineInstances_Pause", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to pause a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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": { + "PauseVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Pause.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/restart": { + "post": { + "operationId": "VirtualMachineInstances_Restart", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to restart a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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": { + "RestartVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Restart.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/save": { + "post": { + "operationId": "VirtualMachineInstances_Save", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to save a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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": { + "SaveVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Save.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/start": { + "post": { + "operationId": "VirtualMachineInstances_Start", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to start a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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": { + "StartVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Start.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/stop": { + "post": { + "operationId": "VirtualMachineInstances_Stop", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to stop a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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": { + "StopVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Stop.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.AzureStackHCI/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 the operations for the provider.": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/galleryImages": { + "get": { + "operationId": "GalleryImages_ListAll", + "tags": [ + "GalleryImages" + ], + "description": "Lists all of the gallery images in the specified subscription. Use the nextLink property in the response to get the next page of gallery images.", + "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/GalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListGalleryImageBySubscription": { + "$ref": "./examples/GalleryImages_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/logicalNetworks": { + "get": { + "operationId": "LogicalNetworks_ListAll", + "tags": [ + "LogicalNetworks" + ], + "description": "Lists all of the logical networks in the specified subscription. Use the nextLink property in the response to get the next page of logical networks.", + "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/LogicalNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListLogicalNetworkBySubscription": { + "$ref": "./examples/LogicalNetworks_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages": { + "get": { + "operationId": "MarketplaceGalleryImages_ListAll", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "Lists all of the marketplace gallery images in the specified subscription. Use the nextLink property in the response to get the next page of marketplace gallery images.", + "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/MarketplaceGalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListMarketplaceGalleryImageBySubscription": { + "$ref": "./examples/MarketplaceGalleryImages_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/networkInterfaces": { + "get": { + "operationId": "NetworkInterfaces_ListAll", + "tags": [ + "NetworkInterfaces" + ], + "description": "Lists all of the network interfaces in the specified subscription. Use the nextLink property in the response to get the next page of network interfaces.", + "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/NetworkInterfaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListNetworkInterfaceBySubscription": { + "$ref": "./examples/NetworkInterfaces_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/networkSecurityGroups": { + "get": { + "operationId": "NetworkSecurityGroups_ListAll", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Gets all network security groups in 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/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all network security groups": { + "$ref": "./examples/NetworkSecurityGroups_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/storageContainers": { + "get": { + "operationId": "StorageContainers_ListAll", + "tags": [ + "StorageContainers" + ], + "description": "Lists all of the storage containers in the specified subscription. Use the nextLink property in the response to get the next page of storage containers.", + "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/StorageContainerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListStorageContainerBySubscription": { + "$ref": "./examples/StorageContainers_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/virtualHardDisks": { + "get": { + "operationId": "VirtualHardDisks_ListAll", + "tags": [ + "VirtualHardDisks" + ], + "description": "Lists all of the virtual hard disks in the specified subscription. Use the nextLink property in the response to get the next page of virtual hard disks.", + "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/VirtualHardDiskListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListVirtualHardDiskBySubscription": { + "$ref": "./examples/VirtualHardDisks_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages": { + "get": { + "operationId": "GalleryImages_ListByResourceGroup", + "tags": [ + "GalleryImages" + ], + "description": "Lists all of the gallery images in the specified resource group. Use the nextLink property in the response to get the next page of gallery images.", + "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/GalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListGalleryImageByResourceGroup": { + "$ref": "./examples/GalleryImages_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages/{galleryImageName}": { + "get": { + "operationId": "GalleryImages_Get", + "tags": [ + "GalleryImages" + ], + "description": "Gets a gallery image", + "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": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetGalleryImage": { + "$ref": "./examples/GalleryImages_Get.json" + } + } + }, + "put": { + "operationId": "GalleryImages_CreateOrUpdate", + "tags": [ + "GalleryImages" + ], + "description": "The operation to create or update a gallery image. Please note some properties can be set only during gallery image creation.", + "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": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'GalleryImage' update operation succeeded", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "201": { + "description": "Resource 'GalleryImage' create operation succeeded", + "schema": { + "$ref": "#/definitions/GalleryImage" + }, + "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": { + "PutGalleryImage": { + "$ref": "./examples/GalleryImages_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "GalleryImages_Update", + "tags": [ + "GalleryImages" + ], + "description": "The operation to update a gallery image.", + "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": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "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": { + "UpdateGalleryImage": { + "$ref": "./examples/GalleryImages_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "GalleryImages_Delete", + "tags": [ + "GalleryImages" + ], + "description": "The operation to delete a gallery image.", + "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": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteGalleryImage": { + "$ref": "./examples/GalleryImages_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks": { + "get": { + "operationId": "LogicalNetworks_ListByResourceGroup", + "tags": [ + "LogicalNetworks" + ], + "description": "Lists all of the logical networks in the specified resource group. Use the nextLink property in the response to get the next page of logical networks.", + "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/LogicalNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListLogicalNetworkByResourceGroup": { + "$ref": "./examples/LogicalNetworks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}": { + "get": { + "operationId": "LogicalNetworks_Get", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to get a logical network.", + "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": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_Get.json" + } + } + }, + "put": { + "operationId": "LogicalNetworks_CreateOrUpdate", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to create or update a logical network. Please note some properties can be set only during logical network creation.", + "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": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LogicalNetwork' update operation succeeded", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "201": { + "description": "Resource 'LogicalNetwork' create operation succeeded", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + }, + "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": { + "PutLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LogicalNetworks_Update", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to update a logical network.", + "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": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LogicalNetworksUpdateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "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": { + "UpdateLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LogicalNetworks_Delete", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to delete a logical network.", + "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": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages": { + "get": { + "operationId": "MarketplaceGalleryImages_ListByResourceGroup", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "Lists all of the marketplace gallery images in the specified resource group. Use the nextLink property in the response to get the next page of marketplace gallery images.", + "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/MarketplaceGalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListMarketplaceGalleryImageByResourceGroup": { + "$ref": "./examples/MarketplaceGalleryImages_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/{marketplaceGalleryImageName}": { + "get": { + "operationId": "MarketplaceGalleryImages_Get", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "Gets a marketplace gallery image", + "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": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_Get.json" + } + } + }, + "put": { + "operationId": "MarketplaceGalleryImages_CreateOrUpdate", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "The operation to create or update a marketplace gallery image. Please note some properties can be set only during marketplace gallery image creation.", + "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": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'MarketplaceGalleryImage' update operation succeeded", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "201": { + "description": "Resource 'MarketplaceGalleryImage' create operation succeeded", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + }, + "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": { + "PutMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "MarketplaceGalleryImages_Update", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "The operation to update a marketplace gallery image.", + "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": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImageTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "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": { + "UpdateMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "MarketplaceGalleryImages_Delete", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "The operation to delete a marketplace gallery image.", + "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": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces": { + "get": { + "operationId": "NetworkInterfaces_ListByResourceGroup", + "tags": [ + "NetworkInterfaces" + ], + "description": "Lists all of the network interfaces in the specified resource group. Use the nextLink property in the response to get the next page of network interfaces.", + "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/NetworkInterfaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListNetworkInterfaceByResourceGroup": { + "$ref": "./examples/NetworkInterfaces_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces/{networkInterfaceName}": { + "get": { + "operationId": "NetworkInterfaces_Get", + "tags": [ + "NetworkInterfaces" + ], + "description": "Gets a network interface", + "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": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_Get.json" + } + } + }, + "put": { + "operationId": "NetworkInterfaces_CreateOrUpdate", + "tags": [ + "NetworkInterfaces" + ], + "description": "The operation to create or update a network interface. Please note some properties can be set only during network interface creation.", + "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": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkInterface' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "201": { + "description": "Resource 'NetworkInterface' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkInterface" + }, + "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": { + "PutNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkInterfaces_Update", + "tags": [ + "NetworkInterfaces" + ], + "description": "The operation to update a network interface.", + "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": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterfaceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "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": { + "UpdateNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkInterfaces_Delete", + "tags": [ + "NetworkInterfaces" + ], + "description": "The operation to delete a network interface.", + "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": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups": { + "get": { + "operationId": "NetworkSecurityGroups_ListByResourceGroup", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Gets all network security groups in 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/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List network security groups in resource group": { + "$ref": "./examples/NetworkSecurityGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}": { + "get": { + "operationId": "NetworkSecurityGroups_Get", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Gets the specified network security 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": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network security group": { + "$ref": "./examples/NetworkSecurityGroups_Get.json" + } + } + }, + "put": { + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Creates or updates a network security group in the specified 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkSecurityGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "201": { + "description": "Resource 'NetworkSecurityGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "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": { + "CreateNetworkSecurityGroup": { + "$ref": "./examples/NetworkSecurityGroups_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkSecurityGroups_UpdateTags", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Updates a network security group tags.", + "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": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "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 network security group tags": { + "$ref": "./examples/NetworkSecurityGroups_UpdateTags.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkSecurityGroups_Delete", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Deletes the specified network security 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": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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 network security group": { + "$ref": "./examples/NetworkSecurityGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}/securityRules": { + "get": { + "operationId": "SecurityRules_ListByNetworkSecurityGroup", + "tags": [ + "SecurityRules" + ], + "description": "Gets all security rules in a Network Security 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": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List network security rules in network security group": { + "$ref": "./examples/SecurityRules_ListByNetworkSecurityGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}": { + "get": { + "operationId": "SecurityRules_Get", + "tags": [ + "SecurityRules" + ], + "description": "Gets the specified security 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "securityRuleName", + "in": "path", + "description": "Name of the security rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network security rule in network security group": { + "$ref": "./examples/SecurityRules_Get.json" + } + } + }, + "put": { + "operationId": "SecurityRules_CreateOrUpdate", + "tags": [ + "SecurityRules" + ], + "description": "Creates or updates a security rule in the specified 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "securityRuleName", + "in": "path", + "description": "Name of the security rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityRule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SecurityRule' update operation succeeded", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "201": { + "description": "Resource 'SecurityRule' create operation succeeded", + "schema": { + "$ref": "#/definitions/SecurityRule" + }, + "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": { + "SecurityRulesCreateOrUpdate": { + "$ref": "./examples/SecurityRules_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SecurityRules_Delete", + "tags": [ + "SecurityRules" + ], + "description": "Deletes the specified security 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "securityRuleName", + "in": "path", + "description": "Name of the security rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "SecurityRulesDelete": { + "$ref": "./examples/SecurityRules_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers": { + "get": { + "operationId": "StorageContainers_ListByResourceGroup", + "tags": [ + "StorageContainers" + ], + "description": "Lists all of the storage containers in the specified resource group. Use the nextLink property in the response to get the next page of storage containers.", + "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/StorageContainerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListStorageContainerByResourceGroup": { + "$ref": "./examples/StorageContainers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers/{storageContainerName}": { + "get": { + "operationId": "StorageContainers_Get", + "tags": [ + "StorageContainers" + ], + "description": "Gets a storage container", + "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": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetStorageContainer": { + "$ref": "./examples/StorageContainers_Get.json" + } + } + }, + "put": { + "operationId": "StorageContainers_CreateOrUpdate", + "tags": [ + "StorageContainers" + ], + "description": "The operation to create or update a storage container. Please note some properties can be set only during storage container creation.", + "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": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageContainer" + } + } + ], + "responses": { + "200": { + "description": "Resource 'StorageContainer' update operation succeeded", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + }, + "201": { + "description": "Resource 'StorageContainer' create operation succeeded", + "schema": { + "$ref": "#/definitions/StorageContainer" + }, + "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": { + "PutStorageContainer": { + "$ref": "./examples/StorageContainers_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "StorageContainers_Update", + "tags": [ + "StorageContainers" + ], + "description": "The operation to update a storage container.", + "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": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageContainerTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + }, + "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": { + "UpdateStorageContainer": { + "$ref": "./examples/StorageContainers_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "StorageContainers_Delete", + "tags": [ + "StorageContainers" + ], + "description": "The operation to delete a storage container.", + "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": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteStorageContainer": { + "$ref": "./examples/StorageContainers_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks": { + "get": { + "operationId": "VirtualHardDisks_ListByResourceGroup", + "tags": [ + "VirtualHardDisks" + ], + "description": "Lists all of the virtual hard disks in the specified resource group. Use the nextLink property in the response to get the next page of virtual hard disks.", + "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/VirtualHardDiskListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListVirtualHardDiskByResourceGroup": { + "$ref": "./examples/VirtualHardDisks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks/{virtualHardDiskName}": { + "get": { + "operationId": "VirtualHardDisks_Get", + "tags": [ + "VirtualHardDisks" + ], + "description": "Gets a virtual hard disk", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Get.json" + } + } + }, + "put": { + "operationId": "VirtualHardDisks_CreateOrUpdate", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to create or update a virtual hard disk. Please note some properties can be set only during virtual hard disk creation.", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualHardDisk' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "201": { + "description": "Resource 'VirtualHardDisk' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + }, + "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": { + "PutVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualHardDisks_Update", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to update a virtual hard disk.", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHardDiskTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "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": { + "UpdateVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualHardDisks_Delete", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to delete a virtual hard disk.", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AttestBootIntegrityPropertyEnum": { + "type": "string", + "description": "The status of whether the list of boot integrity properties is validated.", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestBootIntegrityPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Boot integrity properties are valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Boot integrity properties are invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Boot integrity properties status is unknown" + } + ] + } + }, + "AttestCertPropertyEnum": { + "type": "string", + "description": "The status of whether attestation certificate is validated.", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestCertPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Attestation certificate is valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Attestation certificate is invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation certificate status is unknown" + } + ] + } + }, + "AttestHealthStatusEnum": { + "type": "string", + "description": "The health status of attestation validation and parsing", + "enum": [ + "Pending", + "Healthy", + "Unhealthy", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestHealthStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Attestation validation and parsing pending" + }, + { + "name": "Healthy", + "value": "Healthy", + "description": "Attestation validation and parsing healthy" + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "Attestation validation and parsing unhealthy" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation validation and parsing status is unknown" + } + ] + } + }, + "AttestSecureBootPropertyEnum": { + "type": "string", + "description": "The status of whether secure boot is enabled.", + "enum": [ + "Enabled", + "Disabled", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestSecureBootPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Secure boot enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Secure boot disabled" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Secure boot status is unknown" + } + ] + } + }, + "AttestationStatus": { + "type": "object", + "description": "The attestation status of the virtual machine", + "properties": { + "properties": { + "$ref": "#/definitions/AttestationStatusProperties", + "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" + } + ] + }, + "AttestationStatusProperties": { + "type": "object", + "description": "Defines the attestation status properties", + "properties": { + "attestSecureBootEnabled": { + "type": "string", + "description": "The status of whether secure boot is enabled.", + "default": "Unknown", + "enum": [ + "Enabled", + "Disabled", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestSecureBootPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Secure boot enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Secure boot disabled" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Secure boot status is unknown" + } + ] + }, + "readOnly": true + }, + "attestationCertValidated": { + "type": "string", + "description": "The status of whether attestation certificate is validated.", + "default": "Unknown", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestCertPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Attestation certificate is valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Attestation certificate is invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation certificate status is unknown" + } + ] + }, + "readOnly": true + }, + "bootIntegrityValidated": { + "type": "string", + "description": "The status of whether the list of boot integrity properties is validated.", + "default": "Unknown", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestBootIntegrityPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Boot integrity properties are valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Boot integrity properties are invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Boot integrity properties status is unknown" + } + ] + }, + "readOnly": true + }, + "linuxKernelVersion": { + "type": "string", + "description": "kernel version string for Linux VM.", + "readOnly": true + }, + "healthStatus": { + "type": "string", + "description": "The health status of attestation validation and parsing", + "default": "Unknown", + "enum": [ + "Pending", + "Healthy", + "Unhealthy", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestHealthStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Attestation validation and parsing pending" + }, + { + "name": "Healthy", + "value": "Healthy", + "description": "Attestation validation and parsing healthy" + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "Attestation validation and parsing unhealthy" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation validation and parsing status is unknown" + } + ] + }, + "readOnly": true + }, + "timestamp": { + "type": "string", + "description": "The time stamp of the last time attestation token is validated by relying party service.", + "readOnly": true + }, + "errorMessage": { + "type": "string", + "description": "The error message of attestation validation and parsing", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + } + } + }, + "CloudInitDataSource": { + "type": "string", + "description": "Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]", + "enum": [ + "NoCloud", + "Azure" + ], + "x-ms-enum": { + "name": "CloudInitDataSource", + "modelAsString": true, + "values": [ + { + "name": "NoCloud", + "value": "NoCloud", + "description": "NoCloud is used as the datasource" + }, + { + "name": "Azure", + "value": "Azure", + "description": "Azure is used as the datasource" + } + ] + } + }, + "DiskFileFormat": { + "type": "string", + "description": "The format of the actual VHD file [vhd, vhdx]", + "enum": [ + "vhdx", + "vhd" + ], + "x-ms-enum": { + "name": "DiskFileFormat", + "modelAsString": true, + "values": [ + { + "name": "vhdx", + "value": "vhdx", + "description": "VHDX file format" + }, + { + "name": "vhd", + "value": "vhd", + "description": "VHD file format" + } + ] + } + }, + "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/ExtendedLocationTypes", + "description": "The type of the extended location." + } + } + }, + "ExtendedLocationTypes": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true, + "values": [ + { + "name": "CustomLocation", + "value": "CustomLocation", + "description": "Custom extended location type" + } + ] + } + }, + "GalleryDiskImage": { + "type": "object", + "description": "This is the disk image base class.", + "properties": { + "sizeInMB": { + "type": "integer", + "format": "int64", + "description": "This property indicates the size of the VHD to be created.", + "readOnly": true + } + } + }, + "GalleryImage": { + "type": "object", + "description": "The gallery images resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/GalleryImageProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "GalleryImageIdentifier": { + "type": "object", + "description": "This is the gallery image definition identifier.", + "properties": { + "publisher": { + "type": "string", + "description": "The name of the gallery image definition publisher." + }, + "offer": { + "type": "string", + "description": "The name of the gallery image definition offer." + }, + "sku": { + "type": "string", + "description": "The name of the gallery image definition SKU." + } + }, + "required": [ + "publisher", + "offer", + "sku" + ] + }, + "GalleryImageListResult": { + "type": "object", + "description": "The response of a GalleryImage list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GalleryImage items on this page", + "items": { + "$ref": "#/definitions/GalleryImage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GalleryImageProperties": { + "type": "object", + "description": "Properties under the gallery image resource", + "properties": { + "containerId": { + "type": "string", + "format": "arm-id", + "description": "Storage ContainerID of the storage container to be used for gallery image", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + }, + "imagePath": { + "type": "string", + "format": "password", + "description": "location of the image the gallery image should be created from", + "x-ms-secret": true + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "Operating system type that the gallery image uses [Windows, Linux]" + }, + "cloudInitDataSource": { + "$ref": "#/definitions/CloudInitDataSource", + "description": "Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]" + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGeneration", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]" + }, + "identifier": { + "$ref": "#/definitions/GalleryImageIdentifier", + "description": "This is the gallery image definition identifier." + }, + "version": { + "$ref": "#/definitions/GalleryImageVersion", + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the gallery image.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/GalleryImageStatus", + "description": "The observed state of gallery images", + "readOnly": true + } + }, + "required": [ + "osType" + ] + }, + "GalleryImageStatus": { + "type": "object", + "description": "The observed state of gallery images", + "properties": { + "errorCode": { + "type": "string", + "description": "GalleryImage provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/GalleryImageStatusProvisioningStatus", + "description": "provisioning status of the gallery image" + }, + "downloadStatus": { + "$ref": "#/definitions/GalleryImageStatusDownloadStatus", + "description": "The download status of the gallery image" + }, + "progressPercentage": { + "type": "integer", + "format": "int64", + "description": "The progress of the operation in percentage" + } + }, + "x-ms-client-flatten": true + }, + "GalleryImageStatusDownloadStatus": { + "type": "object", + "description": "The download status of the gallery image", + "properties": { + "downloadSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The downloaded sized of the image in MB" + } + } + }, + "GalleryImageStatusProvisioningStatus": { + "type": "object", + "description": "The status of the operation performed on the gallery image", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the gallery image" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]" + } + } + }, + "GalleryImageTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in GalleryImage resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GalleryImageVersion": { + "type": "object", + "description": "Specifies information about the gallery image version that you want to create or update.", + "properties": { + "name": { + "type": "string", + "description": "This is the version of the gallery image." + }, + "properties": { + "$ref": "#/definitions/GalleryImageVersionProperties", + "description": "Describes the properties of a gallery image version.", + "x-ms-client-flatten": true + } + } + }, + "GalleryImageVersionProperties": { + "type": "object", + "description": "Describes the properties of a gallery image version.", + "properties": { + "storageProfile": { + "$ref": "#/definitions/GalleryImageVersionStorageProfile", + "description": "This is the storage profile of a Gallery Image Version." + } + }, + "required": [ + "storageProfile" + ] + }, + "GalleryImageVersionStorageProfile": { + "type": "object", + "description": "This is the storage profile of a Gallery Image Version.", + "properties": { + "osDiskImage": { + "$ref": "#/definitions/GalleryOSDiskImage", + "description": "This is the OS disk image." + } + } + }, + "GalleryImagesUpdateRequest": { + "type": "object", + "description": "The gallery images resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GalleryOSDiskImage": { + "type": "object", + "description": "This is the OS disk image.", + "properties": { + "sizeInMB": { + "type": "integer", + "format": "int64", + "description": "This property indicates the size of the VHD to be created.", + "readOnly": true + } + } + }, + "GuestAgent": { + "type": "object", + "description": "Defines the GuestAgent.", + "properties": { + "properties": { + "$ref": "#/definitions/GuestAgentProperties", + "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" + } + ] + }, + "GuestAgentInstallStatus": { + "type": "object", + "description": "Defines the status of a guest agent installation.", + "properties": { + "vmUuid": { + "type": "string", + "description": "Specifies the VM's unique SMBIOS ID.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/StatusTypes", + "description": "The installation status of the hybrid machine agent installation.", + "readOnly": true + }, + "lastStatusChange": { + "type": "string", + "format": "date-time", + "description": "The time of the last status change.", + "readOnly": true + }, + "agentVersion": { + "type": "string", + "description": "The hybrid machine agent full version.", + "readOnly": true + }, + "errorDetails": { + "type": "array", + "description": "Details about the error state.", + "items": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "GuestAgentListResult": { + "type": "object", + "description": "The response of a GuestAgent list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GuestAgent items on this page", + "items": { + "$ref": "#/definitions/GuestAgent" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GuestAgentProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "credentials": { + "$ref": "#/definitions/GuestCredential", + "description": "Username / Password Credentials to provision guest agent." + }, + "provisioningAction": { + "$ref": "#/definitions/ProvisioningAction", + "description": "The guest agent provisioning action." + }, + "status": { + "type": "string", + "description": "The guest agent status.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + } + } + }, + "GuestCredential": { + "type": "object", + "description": "Username / Password Credentials to connect to guest.", + "properties": { + "username": { + "type": "string", + "description": "The username to connect with the guest." + }, + "password": { + "type": "string", + "format": "password", + "description": "The password to connect with the guest.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + } + } + }, + "HardwareProfileUpdate": { + "type": "object", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance.", + "properties": { + "vmSize": { + "$ref": "#/definitions/VmSizeEnum", + "description": "VM Size Enum" + }, + "processors": { + "type": "integer", + "format": "int32", + "description": "number of processors for the virtual machine instance" + }, + "memoryMB": { + "type": "integer", + "format": "int64", + "description": "RAM in MB for the virtual machine instance" + } + } + }, + "HttpProxyConfiguration": { + "type": "object", + "description": "HTTP Proxy configuration for the VM.", + "properties": { + "httpProxy": { + "type": "string", + "format": "password", + "description": "The HTTP proxy server endpoint to use.", + "x-ms-secret": true + }, + "httpsProxy": { + "type": "string", + "format": "password", + "description": "The HTTPS proxy server endpoint to use.", + "x-ms-secret": true + }, + "noProxy": { + "type": "array", + "description": "The endpoints that should not go through proxy.", + "items": { + "type": "string" + } + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "HybridIdentityMetadata": { + "type": "object", + "description": "Defines the HybridIdentityMetadata.", + "properties": { + "properties": { + "$ref": "#/definitions/HybridIdentityMetadataProperties", + "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" + } + ], + "x-ms-azure-resource": true + }, + "HybridIdentityMetadataListResult": { + "type": "object", + "description": "The response of a HybridIdentityMetadata list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HybridIdentityMetadata items on this page", + "items": { + "$ref": "#/definitions/HybridIdentityMetadata" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HybridIdentityMetadataProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "resourceUid": { + "type": "string", + "description": "The unique identifier for the resource." + }, + "publicKey": { + "type": "string", + "description": "The Public Key." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity for the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + } + } + }, + "HyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true, + "values": [ + { + "name": "V1", + "value": "V1", + "description": "Generation 1 (V1) hypervisor" + }, + { + "name": "V2", + "value": "V2", + "description": "Generation 2 (V2) hypervisor" + } + ] + } + }, + "IPConfiguration": { + "type": "object", + "description": "InterfaceIPConfiguration IPConfiguration in a network interface.", + "properties": { + "name": { + "type": "string", + "description": "Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "$ref": "#/definitions/IPConfigurationProperties", + "description": "InterfaceIPConfigurationPropertiesFormat properties of IP configuration." + } + }, + "x-ms-client-flatten": true + }, + "IPConfigurationProperties": { + "type": "object", + "description": "InterfaceIPConfigurationPropertiesFormat properties of IP configuration.", + "properties": { + "gateway": { + "type": "string", + "description": "Gateway for network interface", + "readOnly": true + }, + "prefixLength": { + "type": "string", + "description": "prefixLength for network interface", + "readOnly": true + }, + "privateIPAddress": { + "type": "string", + "description": "PrivateIPAddress - Private IP address of the IP configuration." + }, + "subnet": { + "$ref": "#/definitions/LogicalNetworkArmReference", + "description": "Subnet - Name of Subnet bound to the IP configuration." + } + } + }, + "IPPool": { + "type": "object", + "description": "Describes IPPool", + "properties": { + "name": { + "type": "string", + "description": "Name of the IP-Pool" + }, + "ipPoolType": { + "$ref": "#/definitions/IPPoolTypeEnum", + "description": "Type of the IP Pool [vm, vippool]" + }, + "start": { + "type": "string", + "description": "Start of the IP address pool" + }, + "end": { + "type": "string", + "description": "End of the IP address pool" + }, + "info": { + "$ref": "#/definitions/IPPoolInfo", + "description": "IPPool info" + } + } + }, + "IPPoolInfo": { + "type": "object", + "description": "IP Pool info", + "properties": { + "used": { + "type": "string", + "description": "Number of IP addresses allocated from the IP Pool", + "readOnly": true + }, + "available": { + "type": "string", + "description": "Number of IP addresses available in the IP Pool", + "readOnly": true + } + } + }, + "IPPoolTypeEnum": { + "type": "string", + "description": "Type of the IP Pool [vm, vippool]", + "enum": [ + "vm", + "vippool" + ], + "x-ms-enum": { + "name": "IPPoolTypeEnum", + "modelAsString": true, + "values": [ + { + "name": "vm", + "value": "vm", + "description": "Virtual Machine IP Pool" + }, + { + "name": "vippool", + "value": "vippool", + "description": "VIP Pool" + } + ] + } + }, + "Identity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "type": "string", + "description": "The principal ID of resource identity. The value must be an UUID.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenant ID of resource. The value must be an UUID.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "modelAsString": false + } + } + } + }, + "ImageArmReference": { + "type": "object", + "description": "The ARM ID for a Gallery Image.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for an image resource used by the virtual machine instance.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/galleryImages" + }, + { + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages" + } + ] + } + } + } + }, + "InstanceViewStatus": { + "type": "object", + "description": "Instance view status.", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "$ref": "#/definitions/StatusLevelTypes", + "description": "The level code." + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + } + }, + "InterfaceDNSSettings": { + "type": "object", + "description": "DNS Settings of the interface", + "properties": { + "dnsServers": { + "type": "array", + "description": "List of DNS server IP Addresses for the interface", + "items": { + "type": "string" + } + } + } + }, + "IpAllocationMethodEnum": { + "type": "string", + "description": "IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'", + "enum": [ + "Dynamic", + "Static" + ], + "x-ms-enum": { + "name": "IpAllocationMethodEnum", + "modelAsString": true, + "values": [ + { + "name": "Dynamic", + "value": "Dynamic", + "description": "Dynamic IP allocation method" + }, + { + "name": "Static", + "value": "Static", + "description": "Static IP allocation method" + } + ] + } + }, + "LogicalNetwork": { + "type": "object", + "description": "The logical network resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/LogicalNetworkProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "LogicalNetworkArmReference": { + "type": "object", + "description": "The ARM ID for a Logical Network.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Logical Network.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/logicalNetworks" + } + ] + } + } + } + }, + "LogicalNetworkListResult": { + "type": "object", + "description": "The response of a LogicalNetwork list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LogicalNetwork items on this page", + "items": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LogicalNetworkProperties": { + "type": "object", + "description": "Properties under the logical network resource", + "properties": { + "dhcpOptions": { + "$ref": "#/definitions/LogicalNetworkPropertiesDhcpOptions", + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options." + }, + "subnets": { + "type": "array", + "description": "Subnet - list of subnets under the logical network", + "items": { + "$ref": "#/definitions/Subnet" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the logical network.", + "readOnly": true + }, + "vmSwitchName": { + "type": "string", + "description": "name of the network switch to be used for VMs" + }, + "status": { + "$ref": "#/definitions/LogicalNetworkStatus", + "description": "The observed state of logical networks", + "readOnly": true + } + } + }, + "LogicalNetworkPropertiesDhcpOptions": { + "type": "object", + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.", + "properties": { + "dnsServers": { + "type": "array", + "description": "The list of DNS servers IP addresses.", + "items": { + "type": "string" + } + } + } + }, + "LogicalNetworkStatus": { + "type": "object", + "description": "The observed state of logical networks", + "properties": { + "errorCode": { + "type": "string", + "description": "LogicalNetwork provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/LogicalNetworkStatusProvisioningStatus", + "description": "Logical network provisioning status" + } + }, + "x-ms-client-flatten": true + }, + "LogicalNetworkStatusProvisioningStatus": { + "type": "object", + "description": "Describes the status of the provisioning.", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the logical network" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the logical network [Succeeded, Failed, InProgress]" + } + } + }, + "LogicalNetworksUpdateRequest": { + "type": "object", + "description": "The logical network resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MarketplaceGalleryImage": { + "type": "object", + "description": "The marketplace gallery image resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/MarketplaceGalleryImageProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "MarketplaceGalleryImageListResult": { + "type": "object", + "description": "The response of a MarketplaceGalleryImage list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MarketplaceGalleryImage items on this page", + "items": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MarketplaceGalleryImageProperties": { + "type": "object", + "description": "Properties under the marketplace gallery image resource", + "properties": { + "containerId": { + "type": "string", + "format": "arm-id", + "description": "Storage ContainerID of the storage container to be used for marketplace gallery image", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "Operating system type that the gallery image uses [Windows, Linux]" + }, + "cloudInitDataSource": { + "$ref": "#/definitions/CloudInitDataSource", + "description": "Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]" + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGeneration", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]" + }, + "identifier": { + "$ref": "#/definitions/GalleryImageIdentifier", + "description": "This is the gallery image definition identifier." + }, + "version": { + "$ref": "#/definitions/GalleryImageVersion", + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the marketplace gallery image.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/MarketplaceGalleryImageStatus", + "description": "The observed state of marketplace gallery images", + "readOnly": true + } + }, + "required": [ + "osType" + ] + }, + "MarketplaceGalleryImageStatus": { + "type": "object", + "description": "The observed state of marketplace gallery images", + "properties": { + "errorCode": { + "type": "string", + "description": "MarketplaceGalleryImage provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/MarketplaceGalleryImageStatusProvisioningStatus", + "description": "Provisioning status of marketplace gallery image" + }, + "downloadStatus": { + "$ref": "#/definitions/MarketplaceGalleryImageStatusDownloadStatus", + "description": "The download status of the gallery image" + }, + "progressPercentage": { + "type": "integer", + "format": "int64", + "description": "The progress of the operation in percentage" + } + }, + "x-ms-client-flatten": true + }, + "MarketplaceGalleryImageStatusDownloadStatus": { + "type": "object", + "description": "The download status of the gallery image", + "properties": { + "downloadSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The downloaded sized of the image in MB" + } + } + }, + "MarketplaceGalleryImageStatusProvisioningStatus": { + "type": "object", + "description": "Marketplace GalleryImage provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the gallery image" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]" + } + } + }, + "MarketplaceGalleryImageTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in MarketplaceGalleryImage resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MarketplaceGalleryImagesUpdateRequest": { + "type": "object", + "description": "The marketplace gallery image resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkInterface": { + "type": "object", + "description": "The network interface resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkInterfaceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "NetworkInterfaceArmReference": { + "type": "object", + "description": "The ARM ID for a Network Interface.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Network Interface.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/networkInterfaces" + } + ] + } + } + } + }, + "NetworkInterfaceListResult": { + "type": "object", + "description": "The response of a NetworkInterface list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkInterface items on this page", + "items": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkInterfaceProperties": { + "type": "object", + "description": "Properties under the network interface resource", + "properties": { + "ipConfigurations": { + "type": "array", + "description": "IPConfigurations - A list of IPConfigurations of the network interface.", + "items": { + "$ref": "#/definitions/IPConfiguration" + }, + "x-ms-identifiers": [] + }, + "macAddress": { + "type": "string", + "description": "MacAddress - The MAC address of the network interface." + }, + "dnsSettings": { + "$ref": "#/definitions/InterfaceDNSSettings", + "description": "DNS Settings for the interface" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the network interface.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/NetworkInterfaceStatus", + "description": "The observed state of network interfaces", + "readOnly": true + }, + "networkSecurityGroup": { + "$ref": "#/definitions/NetworkSecurityGroupArmReference", + "description": "NetworkSecurityGroup - Network Security Group attached to the network interface." + } + } + }, + "NetworkInterfaceStatus": { + "type": "object", + "description": "The observed state of network interfaces", + "properties": { + "errorCode": { + "type": "string", + "description": "NetworkInterface provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/NetworkInterfaceStatusProvisioningStatus", + "description": "Network interface provisioning status" + } + }, + "x-ms-client-flatten": true + }, + "NetworkInterfaceStatusProvisioningStatus": { + "type": "object", + "description": "Network interface provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the network interface" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the network interface [Succeeded, Failed, InProgress]" + } + } + }, + "NetworkInterfaceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NetworkInterface resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkInterfacesUpdateRequest": { + "type": "object", + "description": "The network interface resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkProfileUpdate": { + "type": "object", + "description": "NetworkProfile - describes the network update configuration the virtual machine instance", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance", + "items": { + "$ref": "#/definitions/NetworkInterfaceArmReference" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkSecurityGroup": { + "type": "object", + "description": "NetworkSecurityGroup resource.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSecurityGroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "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/TrackedResource" + } + ] + }, + "NetworkSecurityGroupArmReference": { + "type": "object", + "description": "The ARM ID for a Network Security Group.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Network Security Group.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/networkSecurityGroups" + } + ] + } + } + } + }, + "NetworkSecurityGroupListResult": { + "type": "object", + "description": "The response of a NetworkSecurityGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkSecurityGroup items on this page", + "items": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkSecurityGroupProperties": { + "type": "object", + "description": "Network Security Group resource.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "A collection of references to network interfaces that are currently using this NSG.", + "items": { + "$ref": "#/definitions/NetworkInterfaceArmReference" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "subnets": { + "type": "array", + "description": "A collection of references to logical networks that are currently using this NSG", + "items": { + "$ref": "#/definitions/LogicalNetworkArmReference" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "The provisioning state of the network security group resource.", + "readOnly": true + } + } + }, + "NetworkSecurityGroupTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NetworkSecurityGroup resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OperatingSystemTypes": { + "type": "string", + "description": "Operating system type that the gallery image uses [Windows, Linux]", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "Windows operating system" + }, + { + "name": "Linux", + "value": "Linux", + "description": "Linux operating system" + } + ] + } + }, + "OsProfileUpdate": { + "type": "object", + "description": "OsProfile - describes the update configuration of the operating system", + "properties": { + "computerName": { + "type": "string", + "description": "ComputerName - name of the computer" + }, + "linuxConfiguration": { + "$ref": "#/definitions/OsProfileUpdateLinuxConfiguration", + "description": "Linux configuration properties" + }, + "windowsConfiguration": { + "$ref": "#/definitions/OsProfileUpdateWindowsConfiguration", + "description": "Windows configuration properties" + } + } + }, + "OsProfileUpdateLinuxConfiguration": { + "type": "object", + "description": "OSProfile update linux configuration", + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process." + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process." + } + } + }, + "OsProfileUpdateWindowsConfiguration": { + "type": "object", + "description": "OSProfile update windows configuration", + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process." + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process." + } + } + }, + "PowerStateEnum": { + "type": "string", + "description": "The power state of the virtual machine instance", + "enum": [ + "Deallocated", + "Deallocating", + "Running", + "Starting", + "Stopped", + "Stopping", + "Paused", + "Saved", + "Unknown" + ], + "x-ms-enum": { + "name": "PowerStateEnum", + "modelAsString": true, + "values": [ + { + "name": "Deallocated", + "value": "Deallocated", + "description": "Virtual machine deallocated" + }, + { + "name": "Deallocating", + "value": "Deallocating", + "description": "Virtual machine deallocating" + }, + { + "name": "Running", + "value": "Running", + "description": "Virtual machine running" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Virtual machine starting" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Virtual machine stopped" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Virtual machine stopping" + }, + { + "name": "Paused", + "value": "Paused", + "description": "Virtual machine paused" + }, + { + "name": "Saved", + "value": "Saved", + "description": "Virtual machine Saved," + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Power state of the virtual machine is unknown" + } + ] + } + }, + "ProvisioningAction": { + "type": "string", + "description": "Defines the different types of operations for guest agent.", + "enum": [ + "install", + "uninstall", + "repair" + ], + "x-ms-enum": { + "name": "ProvisioningAction", + "modelAsString": true, + "values": [ + { + "name": "install", + "value": "install", + "description": "Install guest agent" + }, + { + "name": "uninstall", + "value": "uninstall", + "description": "Uninstall guest agent" + }, + { + "name": "repair", + "value": "repair", + "description": "Repair guest agent" + } + ] + } + }, + "ProvisioningStateEnum": { + "type": "string", + "description": "Provisioning state of the resource.", + "enum": [ + "Succeeded", + "Failed", + "InProgress", + "Accepted", + "Deleting", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningStateEnum", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Provisioning has succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Provisioning has failed" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Provisioning is in progress" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Provisioning has been accepted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion of the resource is in progress" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Provisioning has been canceled" + } + ] + }, + "readOnly": true + }, + "Route": { + "type": "object", + "description": "Route - Route resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RouteProperties", + "description": "Properties of the route.", + "x-ms-client-flatten": true + }, + "name": { + "type": "string", + "description": "Name - name of the subnet", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$" + } + } + }, + "RouteProperties": { + "type": "object", + "description": "RoutePropertiesFormat - Route resource.", + "properties": { + "addressPrefix": { + "type": "string", + "description": "The destination CIDR to which the route applies." + }, + "nextHopIpAddress": { + "type": "string", + "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." + } + } + }, + "RouteTable": { + "type": "object", + "description": "Route table resource.", + "properties": { + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Resource type.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/RouteTableProperties", + "description": "Properties of the route table.", + "x-ms-client-flatten": true + } + } + }, + "RouteTableProperties": { + "type": "object", + "description": "RouteTablePropertiesFormat - Route Table resource.", + "properties": { + "routes": { + "type": "array", + "description": "Collection of routes contained within a route table.", + "items": { + "$ref": "#/definitions/Route" + }, + "x-ms-identifiers": [] + } + } + }, + "SecurityRule": { + "type": "object", + "description": "Security Rule resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityRuleProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SecurityRuleAccess": { + "type": "string", + "description": "Whether network traffic is allowed or denied.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "SecurityRuleAccess", + "modelAsString": true, + "values": [ + { + "name": "Allow", + "value": "Allow", + "description": "Network traffic is allowed" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Network traffic is denied" + } + ] + } + }, + "SecurityRuleDirection": { + "type": "string", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityRuleDirection", + "modelAsString": true, + "values": [ + { + "name": "Inbound", + "value": "Inbound", + "description": "Rule is evaluated on incoming traffic" + }, + { + "name": "Outbound", + "value": "Outbound", + "description": "Rule is evaluated on outgoing traffic" + } + ] + } + }, + "SecurityRuleListResult": { + "type": "object", + "description": "The response of a SecurityRule list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SecurityRule items on this page", + "items": { + "$ref": "#/definitions/SecurityRule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SecurityRuleProperties": { + "type": "object", + "description": "Security rule resource.", + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "protocol": { + "$ref": "#/definitions/SecurityRuleProtocol", + "description": "Network protocol this rule applies to." + }, + "sourceAddressPrefixes": { + "type": "array", + "description": "The CIDR or source IP ranges.", + "items": { + "type": "string" + } + }, + "destinationAddressPrefixes": { + "type": "array", + "description": "The destination address prefixes. CIDR or destination IP ranges.", + "items": { + "type": "string" + } + }, + "sourcePortRanges": { + "type": "array", + "description": "The source port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.", + "items": { + "type": "string" + } + }, + "destinationPortRanges": { + "type": "array", + "description": "The destination port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.", + "items": { + "type": "string" + } + }, + "access": { + "$ref": "#/definitions/SecurityRuleAccess", + "description": "The network traffic is allowed or denied." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "$ref": "#/definitions/SecurityRuleDirection", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the SR", + "readOnly": true + } + }, + "required": [ + "protocol", + "access", + "priority", + "direction" + ] + }, + "SecurityRuleProtocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "Tcp", + "Udp", + "Icmp", + "*" + ], + "x-ms-enum": { + "name": "SecurityRuleProtocol", + "modelAsString": true, + "values": [ + { + "name": "Tcp", + "value": "Tcp", + "description": "Transmission Control Protocol" + }, + { + "name": "Udp", + "value": "Udp", + "description": "User Datagram Protocol" + }, + { + "name": "Icmp", + "value": "Icmp", + "description": "Internet Control Message Protocol" + }, + { + "name": "Asterisk", + "value": "*", + "description": "Wildcard rule for all protocols" + } + ] + } + }, + "SecurityTypes": { + "type": "string", + "description": "Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function.", + "enum": [ + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": true, + "values": [ + { + "name": "TrustedLaunch", + "value": "TrustedLaunch", + "description": "Trusted Launch security type" + }, + { + "name": "ConfidentialVM", + "value": "ConfidentialVM", + "description": "Confidential VM security type" + } + ] + } + }, + "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 VM 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 the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)." + } + } + }, + "Status": { + "type": "string", + "description": "The status of the operation performed on the resource [Succeeded, Failed, InProgress]", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Operation succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Operation failed" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Operation is in progress" + } + ] + }, + "readOnly": true + }, + "StatusLevelTypes": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true, + "values": [ + { + "name": "Info", + "value": "Info", + "description": "Informational status level" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning status level" + }, + { + "name": "Error", + "value": "Error", + "description": "Error status level" + } + ] + } + }, + "StatusTypes": { + "type": "string", + "description": "The installation status of the hybrid machine agent installation.", + "enum": [ + "Succeeded", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "name": "StatusTypes", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Installation succeeded" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Installation in progress" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Installation failed" + } + ] + }, + "readOnly": true + }, + "StorageContainer": { + "type": "object", + "description": "The storage container resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/StorageContainerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "StorageContainerArmReference": { + "type": "object", + "description": "The ARM ID for a Storage Container.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Storage Container.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + } + } + }, + "StorageContainerListResult": { + "type": "object", + "description": "The response of a StorageContainer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The StorageContainer items on this page", + "items": { + "$ref": "#/definitions/StorageContainer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "StorageContainerProperties": { + "type": "object", + "description": "Properties under the storage container resource", + "properties": { + "path": { + "type": "string", + "description": "Path of the storage container on the disk" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the storage container.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/StorageContainerStatus", + "description": "The observed state of storage containers", + "readOnly": true + } + }, + "required": [ + "path" + ] + }, + "StorageContainerStatus": { + "type": "object", + "description": "The observed state of storage containers", + "properties": { + "errorCode": { + "type": "string", + "description": "StorageContainer provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "availableSizeMB": { + "type": "integer", + "format": "int64", + "description": "Amount of space available on the disk in MB" + }, + "containerSizeMB": { + "type": "integer", + "format": "int64", + "description": "Total size of the disk in MB" + }, + "provisioningStatus": { + "$ref": "#/definitions/StorageContainerStatusProvisioningStatus", + "description": "Storage container's provisioning status" + } + }, + "x-ms-client-flatten": true + }, + "StorageContainerStatusProvisioningStatus": { + "type": "object", + "description": "Storage container provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the storage container" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the storage container [Succeeded, Failed, InProgress]" + } + } + }, + "StorageContainerTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in StorageContainer resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "StorageContainersUpdateRequest": { + "type": "object", + "description": "The storage container resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "StorageProfileUpdate": { + "type": "object", + "description": "Storage profile update", + "properties": { + "dataDisks": { + "type": "array", + "description": "adds data disks to the virtual machine instance for the update call", + "items": { + "$ref": "#/definitions/VirtualHardDiskArmReference" + } + } + } + }, + "Subnet": { + "type": "object", + "description": "Properties of the subnet.", + "properties": { + "properties": { + "$ref": "#/definitions/SubnetProperties", + "description": "Properties of the subnet.", + "x-ms-client-flatten": true + }, + "name": { + "type": "string", + "description": "Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$" + } + } + }, + "SubnetIpConfigurationReference": { + "type": "object", + "description": "The ARM ID for a Network Interface.", + "properties": { + "ID": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Network Interface.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/networkInterfaces" + } + ] + } + } + } + }, + "SubnetProperties": { + "type": "object", + "description": "Properties of the subnet.", + "properties": { + "addressPrefix": { + "type": "string", + "description": "The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6." + }, + "addressPrefixes": { + "type": "array", + "description": "List of address prefixes for the subnet.", + "items": { + "type": "string" + } + }, + "ipAllocationMethod": { + "$ref": "#/definitions/IpAllocationMethodEnum", + "description": "IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'" + }, + "ipConfigurationReferences": { + "type": "array", + "description": "IPConfigurationReferences - list of IPConfigurationReferences", + "items": { + "$ref": "#/definitions/SubnetIpConfigurationReference" + }, + "x-ms-identifiers": [] + }, + "networkSecurityGroup": { + "$ref": "#/definitions/NetworkSecurityGroupArmReference", + "description": "NetworkSecurityGroup - Network Security Group attached to the logical network." + }, + "routeTable": { + "$ref": "#/definitions/RouteTable", + "description": "Route table resource." + }, + "ipPools": { + "type": "array", + "description": "network associated pool of IP Addresses", + "items": { + "$ref": "#/definitions/IPPool" + }, + "x-ms-identifiers": [] + }, + "vlan": { + "type": "integer", + "format": "int32", + "description": "Vlan to use for the subnet" + } + } + }, + "TagsObject": { + "type": "object", + "description": "Tags object for patch operations.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualHardDisk": { + "type": "object", + "description": "The virtual hard disk resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualHardDiskProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "VirtualHardDiskArmReference": { + "type": "object", + "description": "The ARM ID for a Virtual Hard Disk.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Hard Disk.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualHardDisks" + } + ] + } + } + } + }, + "VirtualHardDiskListResult": { + "type": "object", + "description": "The response of a VirtualHardDisk list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualHardDisk items on this page", + "items": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualHardDiskProperties": { + "type": "object", + "description": "Properties under the virtual hard disk resource", + "properties": { + "blockSizeBytes": { + "type": "integer", + "format": "int32", + "description": "Block size in bytes" + }, + "diskSizeGB": { + "type": "integer", + "format": "int64", + "description": "Size of the disk in GB" + }, + "dynamic": { + "type": "boolean", + "description": "Boolean for enabling dynamic sizing on the virtual hard disk" + }, + "logicalSectorBytes": { + "type": "integer", + "format": "int32", + "description": "Logical sector in bytes" + }, + "physicalSectorBytes": { + "type": "integer", + "format": "int32", + "description": "Physical sector in bytes" + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGeneration", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]" + }, + "diskFileFormat": { + "$ref": "#/definitions/DiskFileFormat", + "description": "The format of the actual VHD file [vhd, vhdx]" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual hard disk.", + "readOnly": true + }, + "containerId": { + "type": "string", + "format": "arm-id", + "description": "Storage ContainerID of the storage container to be used for VHD", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + }, + "status": { + "$ref": "#/definitions/VirtualHardDiskStatus", + "description": "The observed state of virtual hard disks", + "readOnly": true + } + } + }, + "VirtualHardDiskStatus": { + "type": "object", + "description": "The observed state of virtual hard disks", + "properties": { + "errorCode": { + "type": "string", + "description": "VirtualHardDisk provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/VirtualHardDiskStatusProvisioningStatus", + "description": "Provisioning status of the vhd" + } + }, + "x-ms-client-flatten": true + }, + "VirtualHardDiskStatusProvisioningStatus": { + "type": "object", + "description": "VHD Status provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the virtual hard disk" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress]" + } + } + }, + "VirtualHardDiskTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in VirtualHardDisk resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualHardDisksUpdateRequest": { + "type": "object", + "description": "The virtual hard disk resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualMachineArmReference": { + "type": "object", + "description": "The ARM ID for a Virtual Machine.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Machine.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualMachineInstance" + } + ] + } + } + } + }, + "VirtualMachineConfigAgentInstanceView": { + "type": "object", + "description": "The instance view of the VM Config Agent running on the virtual machine.", + "properties": { + "vmConfigAgentVersion": { + "type": "string", + "description": "The VM Config Agent full version." + }, + "statuses": { + "type": "array", + "description": "The resource status information.", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualMachineInstance": { + "type": "object", + "description": "The virtual machine instance resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineInstanceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "x-ms-azure-resource": true, + "x-ms-client-flatten": true + }, + "VirtualMachineInstanceListResult": { + "type": "object", + "description": "The response of a VirtualMachineInstance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachineInstance items on this page", + "items": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualMachineInstanceProperties": { + "type": "object", + "description": "Properties under the virtual machine instance resource", + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfile", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesNetworkProfile", + "description": "NetworkProfile - describes the network configuration the virtual machine instance" + }, + "osProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesOsProfile", + "description": "OsProfile - describes the configuration of the operating system and sets login data" + }, + "securityProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesSecurityProfile", + "description": "SecurityProfile - Specifies the security settings for the virtual machine instance." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesStorageProfile", + "description": "StorageProfile - contains information about the disks and storage information for the virtual machine instance" + }, + "httpProxyConfig": { + "$ref": "#/definitions/HttpProxyConfiguration", + "description": "HTTP Proxy configuration for the VM." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "description": "The virtual machine instance view.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/VirtualMachineInstanceStatus", + "description": "The observed state of virtual machine instances", + "readOnly": true + }, + "guestAgentInstallStatus": { + "$ref": "#/definitions/GuestAgentInstallStatus", + "description": "Guest agent install status." + }, + "vmId": { + "type": "string", + "description": "Unique identifier for the vm resource.", + "readOnly": true + }, + "resourceUid": { + "type": "string", + "description": "Unique identifier defined by ARC to identify the guest of the VM." + } + } + }, + "VirtualMachineInstancePropertiesHardwareProfile": { + "type": "object", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance.", + "properties": { + "vmSize": { + "type": "string", + "description": "Enum of VM Sizes", + "default": "Default", + "enum": [ + "Default", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS13_v2", + "Standard_K8S_v1", + "Standard_K8S2_v1", + "Standard_K8S3_v1", + "Standard_K8S4_v1", + "Standard_NK6", + "Standard_NK12", + "Standard_NV6", + "Standard_NV12", + "Standard_K8S5_v1", + "Custom" + ], + "x-ms-enum": { + "name": "VmSizeEnum", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default virtual machine size" + }, + { + "name": "Standard_A2_v2", + "value": "Standard_A2_v2", + "description": "Standard A2 v2 virtual machine size" + }, + { + "name": "Standard_A4_v2", + "value": "Standard_A4_v2", + "description": "Standard A4 v2 virtual machine size" + }, + { + "name": "Standard_D2s_v3", + "value": "Standard_D2s_v3", + "description": "Standard D2s v3 virtual machine size" + }, + { + "name": "Standard_D4s_v3", + "value": "Standard_D4s_v3", + "description": "Standard D4s v3 virtual machine size" + }, + { + "name": "Standard_D8s_v3", + "value": "Standard_D8s_v3", + "description": "Standard D8s v3 virtual machine size" + }, + { + "name": "Standard_D16s_v3", + "value": "Standard_D16s_v3", + "description": "Standard D16s v3 virtual machine size" + }, + { + "name": "Standard_D32s_v3", + "value": "Standard_D32s_v3", + "description": "Standard D32s v3 virtual machine size" + }, + { + "name": "Standard_DS2_v2", + "value": "Standard_DS2_v2", + "description": "Standard DS2 v2 virtual machine size" + }, + { + "name": "Standard_DS3_v2", + "value": "Standard_DS3_v2", + "description": "Standard DS3 v2 virtual machine size" + }, + { + "name": "Standard_DS4_v2", + "value": "Standard_DS4_v2", + "description": "Standard DS4 v2 virtual machine size" + }, + { + "name": "Standard_DS5_v2", + "value": "Standard_DS5_v2", + "description": "Standard DS5 v2 virtual machine size" + }, + { + "name": "Standard_DS13_v2", + "value": "Standard_DS13_v2", + "description": "Standard DS13 v2 virtual machine size" + }, + { + "name": "Standard_K8S_v1", + "value": "Standard_K8S_v1", + "description": "Standard K8S v1 virtual machine size" + }, + { + "name": "Standard_K8S2_v1", + "value": "Standard_K8S2_v1", + "description": "Standard K8S2 v1 virtual machine size" + }, + { + "name": "Standard_K8S3_v1", + "value": "Standard_K8S3_v1", + "description": "Standard K8S3 v1 virtual machine size" + }, + { + "name": "Standard_K8S4_v1", + "value": "Standard_K8S4_v1", + "description": "Standard K8S4 v1 virtual machine size" + }, + { + "name": "Standard_NK6", + "value": "Standard_NK6", + "description": "Standard NK6 virtual machine size" + }, + { + "name": "Standard_NK12", + "value": "Standard_NK12", + "description": "Standard NK12 virtual machine size" + }, + { + "name": "Standard_NV6", + "value": "Standard_NV6", + "description": "Standard NV6 virtual machine size" + }, + { + "name": "Standard_NV12", + "value": "Standard_NV12", + "description": "Standard NV12 virtual machine size" + }, + { + "name": "Standard_K8S5_v1", + "value": "Standard_K8S5_v1", + "description": "Standard K8S5 v1 virtual machine size" + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom virtual machine size" + } + ] + } + }, + "processors": { + "type": "integer", + "format": "int32", + "description": "number of processors for the virtual machine instance" + }, + "memoryMB": { + "type": "integer", + "format": "int64", + "description": "RAM in MB for the virtual machine instance" + }, + "dynamicMemoryConfig": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig", + "description": "Dynamic memory config" + } + } + }, + "VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig": { + "type": "object", + "description": "Dynamic memory config", + "properties": { + "maximumMemoryMB": { + "type": "integer", + "format": "int64", + "description": "Maximum memory in MB" + }, + "minimumMemoryMB": { + "type": "integer", + "format": "int64", + "description": "Minimum memory in MB" + }, + "targetMemoryBuffer": { + "type": "integer", + "format": "int32", + "description": "Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000." + } + } + }, + "VirtualMachineInstancePropertiesNetworkProfile": { + "type": "object", + "description": "NetworkProfile - describes the network configuration the virtual machine instance", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance", + "items": { + "$ref": "#/definitions/NetworkInterfaceArmReference" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualMachineInstancePropertiesOsProfile": { + "type": "object", + "description": "OsProfile - describes the configuration of the operating system and sets login data", + "properties": { + "adminPassword": { + "type": "string", + "format": "password", + "description": "AdminPassword - admin password", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "adminUsername": { + "type": "string", + "description": "AdminUsername - admin username" + }, + "computerName": { + "type": "string", + "description": "ComputerName - name of the compute" + }, + "linuxConfiguration": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesOsProfileLinuxConfiguration", + "description": "LinuxConfiguration - linux specific configuration values for the virtual machine instance" + }, + "windowsConfiguration": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesOsProfileWindowsConfiguration", + "description": "Windows Configuration for the virtual machine instance" + } + } + }, + "VirtualMachineInstancePropertiesOsProfileLinuxConfiguration": { + "type": "object", + "description": "LinuxConfiguration - linux specific configuration values for the virtual machine instance", + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "DisablePasswordAuthentication - whether password authentication should be disabled" + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.", + "default": true + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.", + "default": true + } + } + }, + "VirtualMachineInstancePropertiesOsProfileWindowsConfiguration": { + "type": "object", + "description": "Windows Configuration for the virtual machine instance", + "properties": { + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Whether to EnableAutomaticUpdates on the machine" + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for Windows OS." + }, + "timeZone": { + "type": "string", + "description": "TimeZone for the virtual machine instance" + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.", + "default": true + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.", + "default": true + } + } + }, + "VirtualMachineInstancePropertiesSecurityProfile": { + "type": "object", + "description": "SecurityProfile - Specifies the security settings for the virtual machine instance.", + "properties": { + "enableTPM": { + "type": "boolean", + "description": "Enable TPM flag", + "default": false + }, + "uefiSettings": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesSecurityProfileUefiSettings", + "description": "Uefi settings of the virtual machine instance" + }, + "securityType": { + "$ref": "#/definitions/SecurityTypes", + "description": "Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function." + } + } + }, + "VirtualMachineInstancePropertiesSecurityProfileUefiSettings": { + "type": "object", + "description": "Uefi settings - Specifies whether secure boot should be enabled on the virtual machine instance.", + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine instance.", + "default": false + } + } + }, + "VirtualMachineInstancePropertiesStorageProfile": { + "type": "object", + "description": "StorageProfile - contains information about the disks and storage information for the virtual machine instance", + "properties": { + "dataDisks": { + "type": "array", + "description": "adds data disks to the virtual machine instance", + "items": { + "$ref": "#/definitions/VirtualHardDiskArmReference" + } + }, + "imageReference": { + "$ref": "#/definitions/ImageArmReference", + "description": "Which Image to use for the virtual machine instance", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesStorageProfileOsDisk", + "description": "VHD to attach as OS disk" + }, + "vmConfigStoragePathId": { + "type": "string", + "format": "arm-id", + "description": "Id of the storage container that hosts the VM configuration file", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + } + } + }, + "VirtualMachineInstancePropertiesStorageProfileOsDisk": { + "type": "object", + "description": "VHD to attach as OS disk", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Hard Disk.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualHardDisks" + } + ] + } + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux." + } + } + }, + "VirtualMachineInstanceStatus": { + "type": "object", + "description": "The observed state of virtual machine instances", + "properties": { + "errorCode": { + "type": "string", + "description": "VirtualMachine provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "powerState": { + "$ref": "#/definitions/PowerStateEnum", + "description": "The power state of the virtual machine instance" + }, + "provisioningStatus": { + "$ref": "#/definitions/VirtualMachineInstanceStatusProvisioningStatus", + "description": "Provisioning status of the virtual machine instance" + } + }, + "x-ms-client-flatten": true + }, + "VirtualMachineInstanceStatusProvisioningStatus": { + "type": "object", + "description": "Virtual machine instance provisioning status.", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the virtual machine instance" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress]" + } + } + }, + "VirtualMachineInstanceUpdateProperties": { + "type": "object", + "description": "Defines the resource properties for the update.", + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfileUpdate", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfileUpdate", + "description": "StorageProfile - Specifies the storage settings for the virtual machine instance." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfileUpdate", + "description": "NetworkProfile - describes the network update configuration the virtual machine instance" + }, + "osProfile": { + "$ref": "#/definitions/OsProfileUpdate", + "description": "OsProfile - describes the update configuration of the operating system" + } + } + }, + "VirtualMachineInstanceUpdateRequest": { + "type": "object", + "description": "The virtual machine instance resource patch definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineInstanceUpdateProperties", + "description": "Defines the resource properties for the update." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity for the resource." + } + } + }, + "VirtualMachineInstanceView": { + "type": "object", + "description": "The instance view of a virtual machine.", + "properties": { + "vmAgent": { + "$ref": "#/definitions/VirtualMachineConfigAgentInstanceView", + "description": "The VM Config Agent running on the virtual machine." + } + } + }, + "VmSizeEnum": { + "type": "string", + "description": "VM Sizes", + "enum": [ + "Default", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS13_v2", + "Standard_K8S_v1", + "Standard_K8S2_v1", + "Standard_K8S3_v1", + "Standard_K8S4_v1", + "Standard_NK6", + "Standard_NK12", + "Standard_NV6", + "Standard_NV12", + "Standard_K8S5_v1", + "Custom" + ], + "x-ms-enum": { + "name": "VmSizeEnum", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default virtual machine size" + }, + { + "name": "Standard_A2_v2", + "value": "Standard_A2_v2", + "description": "Standard A2 v2 virtual machine size" + }, + { + "name": "Standard_A4_v2", + "value": "Standard_A4_v2", + "description": "Standard A4 v2 virtual machine size" + }, + { + "name": "Standard_D2s_v3", + "value": "Standard_D2s_v3", + "description": "Standard D2s v3 virtual machine size" + }, + { + "name": "Standard_D4s_v3", + "value": "Standard_D4s_v3", + "description": "Standard D4s v3 virtual machine size" + }, + { + "name": "Standard_D8s_v3", + "value": "Standard_D8s_v3", + "description": "Standard D8s v3 virtual machine size" + }, + { + "name": "Standard_D16s_v3", + "value": "Standard_D16s_v3", + "description": "Standard D16s v3 virtual machine size" + }, + { + "name": "Standard_D32s_v3", + "value": "Standard_D32s_v3", + "description": "Standard D32s v3 virtual machine size" + }, + { + "name": "Standard_DS2_v2", + "value": "Standard_DS2_v2", + "description": "Standard DS2 v2 virtual machine size" + }, + { + "name": "Standard_DS3_v2", + "value": "Standard_DS3_v2", + "description": "Standard DS3 v2 virtual machine size" + }, + { + "name": "Standard_DS4_v2", + "value": "Standard_DS4_v2", + "description": "Standard DS4 v2 virtual machine size" + }, + { + "name": "Standard_DS5_v2", + "value": "Standard_DS5_v2", + "description": "Standard DS5 v2 virtual machine size" + }, + { + "name": "Standard_DS13_v2", + "value": "Standard_DS13_v2", + "description": "Standard DS13 v2 virtual machine size" + }, + { + "name": "Standard_K8S_v1", + "value": "Standard_K8S_v1", + "description": "Standard K8S v1 virtual machine size" + }, + { + "name": "Standard_K8S2_v1", + "value": "Standard_K8S2_v1", + "description": "Standard K8S2 v1 virtual machine size" + }, + { + "name": "Standard_K8S3_v1", + "value": "Standard_K8S3_v1", + "description": "Standard K8S3 v1 virtual machine size" + }, + { + "name": "Standard_K8S4_v1", + "value": "Standard_K8S4_v1", + "description": "Standard K8S4 v1 virtual machine size" + }, + { + "name": "Standard_NK6", + "value": "Standard_NK6", + "description": "Standard NK6 virtual machine size" + }, + { + "name": "Standard_NK12", + "value": "Standard_NK12", + "description": "Standard NK12 virtual machine size" + }, + { + "name": "Standard_NV6", + "value": "Standard_NV6", + "description": "Standard NV6 virtual machine size" + }, + { + "name": "Standard_NV12", + "value": "Standard_NV12", + "description": "Standard NV12 virtual machine size" + }, + { + "name": "Standard_K8S5_v1", + "value": "Standard_K8S5_v1", + "description": "Standard K8S5 v1 virtual machine size" + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom virtual machine size" + } + ] + } + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.csharp.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.csharp.md new file mode 100644 index 000000000000..1fe337740d71 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.csharp.md @@ -0,0 +1,16 @@ +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.AzureStackHCI + package-name: Microsoft.Azure.Management.StackHCIVM + output-folder: $(csharp-sdks-folder)/azurestackhci/management/Microsoft.AzureStackHCI/GeneratedProtocol +``` diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.go.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.go.md new file mode 100644 index 000000000000..61e35fe461a3 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.go.md @@ -0,0 +1,41 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +go: + license-header: MICROSOFT_MIT_NO_VERSION + module-name: sdk/resourcemanager/azuresatckhci/armazurestackhci + module: github.com/Azure/azure-sdk-for-go/$(module-name) + output-folder: $(go-sdk-folder)/$(module-name) + azure-arm: true + package-name: armstackhcivm +``` + +### Go multi-api + +```yaml $(go) && $(multiapi) +batch: + - tag: package-2020-11-01-preview + - tag: package-preview-2021-01 +``` + +### Tag: package-preview-2021-01 and go + +These settings apply only when `--tag=package-preview-2021-01 --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-preview-2021-01' && $(go) +namespace: azurestackhci +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-01-01-preview/$(namespace) +``` + +### Tag: package-2020-11-01-preview and go + +These settings apply only when `--tag=package-2020-11-01-preview --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2020-11-01-preview' && $(go) +namespace: azurestackhci +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-11-01-preview/$(namespace) +``` diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.md new file mode 100644 index 000000000000..8b0a92feed18 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.md @@ -0,0 +1,69 @@ +# azurestackhci + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for azurestackhci. + +## 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 azurestackhci. + +```yaml +title: Microsoft.AzureStackHCI +description: Azure Stack HCI management service +openapi-type: arm +openapi-subtype: rpaas +tag: package-preview-2024-02-01 +``` + +## Suppression + +```yaml +directive: + - suppress: R3020 + from: + - stackhcivm.json + reason: Microsoft.AzureStackHCI is the correct name for our RP. +suppressions: + - code: PathResourceProviderNamePascalCase + reason: We had already gone to production with "HCI" in our namespace, so changing it to "Hci" now would be disruptive. + from: + - stackhcivm.json + - code: DefinitionsPropertiesNamesCamelCase + reason: There is a false positive reporting the two letter acronym ID should be lower camel case. The property is correctly capitalized according to guidance. + from: + - stackhcivm.json + - code: XmsPageableForListCalls + reason: XmsPageable not needed for GET calls + from: + - stackhcivm.json + - code: EvenSegmentedPathForPutOperation + reason: resourceUri in virtualmachineinstances is the parent resource. It consists of an even number of segmented paths. + from: + - stackhcivm.json +``` + +### Tag: package-preview-2024-02 + +These settings apply only when `--tag=package-preview-2024-02-01` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-02-01' +input-file: + - preview/2024-02-01-preview/stackhcivm.json +``` diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.python.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.python.md new file mode 100644 index 000000000000..0b1caa65986b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-stackhcivm +namespace: azure.mgmt.azurestackhci +package-version: 1.0.0b1 +clear-output-folder: true +``` + +```yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/azurestackhci/azure-mgmt-azurestackhci/azure/mgmt/azurestackhci +``` + +```yaml $(python) +modelerfour: + lenient-model-deduplication: true +``` diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.ruby.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.ruby.md new file mode 100644 index 000000000000..a1e874dca52f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_stackhcivm +package-version: 2020-03-01-preview +azure-arm: true +``` + +### Tag: package-2020-03-01-preview and ruby + +These settings apply only when `--tag=package-2020-03-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2020-03-01-preview' && $(ruby) +namespace: Microsoft.AzureStackHCI +output-folder: $(ruby-sdks-folder)/azurestackhci +``` diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.typescript.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.typescript.md new file mode 100644 index 000000000000..402698d05ba3 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-stackhcivm" + output-folder: "$(typescript-sdks-folder)/sdk/azurestackhci/arm-azurestackhci" + payload-flattening-threshold: 1 + generate-metadata: true +``` diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-02-01-preview/examples/Operations_List.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-02-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..4a5ff103d84a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-02-01-preview/examples/Operations_List.json @@ -0,0 +1,305 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Deletes virtual hard disk resource", + "description": "Deletes virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Creates/Updates virtual hard disk resource", + "description": "Creates/Updates virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Gets/Lists virtual hard disk resource", + "description": "Gets/Lists virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Deletes network interfaces resource", + "description": "Deletes network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Creates/Updates network interfaces resource", + "description": "Creates/Updates network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Gets/Lists network interfaces resource", + "description": "Gets/Lists network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Deletes gallery images resource", + "description": "Deletes gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Creates/Updates gallery images resource", + "description": "Creates/Updates gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Gets/Lists gallery images resource", + "description": "Gets/Lists gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/HybridIdentityMetadata/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances/HybridIdentityMetadata", + "operation": "Gets/Lists virtual machine instance hybrid identity metadata proxy resource", + "description": "Gets/Lists virtual machine instance hybrid identity metadata proxy resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/attestationStatus/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances/attestationStatus", + "operation": "Gets/Lists virtual machine instance's attestation status", + "description": "Gets/Lists virtual machine instance's attestation status" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Deletes logical networks resource", + "description": "Deletes logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Creates/Updates logical networks resource", + "description": "Creates/Updates logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Gets/Lists logical networks resource", + "description": "Gets/Lists logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/join/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Joins logical networks resource", + "description": "Joins logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Restart/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Restarts virtual machine instance resource", + "description": "Restarts virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Start/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Starts virtual machine instance resource", + "description": "Starts virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Stop/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Stops virtual machine instance resource", + "description": "Stops virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Deletes virtual machine instance resource", + "description": "Deletes virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Creates/Updates virtual machine instance resource", + "description": "Creates/Updates virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Gets/Lists virtual machine instance resource", + "description": "Gets/Lists virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Deletes storage containers resource", + "description": "Deletes storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Creates/Updates storage containers resource", + "description": "Creates/Updates storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Gets/Lists storage containers resource", + "description": "Gets/Lists storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/deploy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Deploys storage containers resource", + "description": "Deploys storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Deletes market place gallery images resource", + "description": "Deletes market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Creates/Updates market place gallery images resource", + "description": "Creates/Updates market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Gets/Lists market place gallery images resource", + "description": "Gets/Lists market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/deploy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Deploys market place gallery images resource", + "description": "Deploys market place gallery images resource" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List the operations for the provider." +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-02-01-preview/operations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-02-01-preview/operations.json new file mode 100644 index 000000000000..129e01b5403a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-02-01-preview/operations.json @@ -0,0 +1,86 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AzureStackHCI", + "version": "2024-02-01-preview", + "description": "Azure Stack HCI management service", + "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" + } + ], + "paths": { + "/providers/Microsoft.AzureStackHCI/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 the operations for the provider.": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/azurestackhci/resource-manager/readme.azureresourceschema.md b/specification/azurestackhci/resource-manager/readme.azureresourceschema.md new file mode 100644 index 000000000000..520ed2927cdc --- /dev/null +++ b/specification/azurestackhci/resource-manager/readme.azureresourceschema.md @@ -0,0 +1,18 @@ +## AzureResourceSchema + +These settings apply only when `--azureresourceschema` is specified on the command line. + +### AzureResourceSchema multi-api + +```yaml $(azureresourceschema) && $(multiapi) +batch: + - tag: package-2020-11-01 +``` + +Please also specify `--azureresourceschema-folder=`. + +### Tag: package-2020-11-01 and azureresourceschema + +```yaml $(tag) == '2020-11-01-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas +``` \ No newline at end of file From f6f50c6388fd5836fa142384641b8353a99874ef Mon Sep 17 00:00:00 2001 From: Sean McCullough <44180881+seanmcc-msft@users.noreply.github.com> Date: Tue, 4 Jun 2024 17:39:18 -0500 Subject: [PATCH 36/49] Storage STG 94 (#28327) * added swagger (#28199) * [STG94] Updated STG94 Files Readme (#28201) * added swagger * updated readme * small fix * added new blob swagger (#28245) * added blob readme (#28246) * Ran prettier on the 2024-08-04 files swagger file (#28358) * Added AuthenticationErrorDetail to StorageError (#28360) * NFS Share Snapshot (#28362) * Added GetAccountInfo() API to Container and Blob level (#28297) * Storage Error Codes for Copies (#28359) * Revert "Storage Error Codes for Copies (#28359)" This reverts commit 8b14ba4a3232adb8538d96832a47dfd695904341. --------- Co-authored-by: Tamer Sherif <69483382+tasherif-msft@users.noreply.github.com> --- .../Microsoft.BlobStorage/readme.md | 11 +- .../stable/2024-08-04/blob.json | 12327 ++++++++++++++++ .../Microsoft.FileStorage/readme.md | 11 +- .../stable/2024-08-04/file.json | 7447 ++++++++++ 4 files changed, 19794 insertions(+), 2 deletions(-) create mode 100644 specification/storage/data-plane/Microsoft.BlobStorage/stable/2024-08-04/blob.json create mode 100644 specification/storage/data-plane/Microsoft.FileStorage/stable/2024-08-04/file.json diff --git a/specification/storage/data-plane/Microsoft.BlobStorage/readme.md b/specification/storage/data-plane/Microsoft.BlobStorage/readme.md index ec4c29ae9a81..7595ea088ec1 100644 --- a/specification/storage/data-plane/Microsoft.BlobStorage/readme.md +++ b/specification/storage/data-plane/Microsoft.BlobStorage/readme.md @@ -25,7 +25,7 @@ These are the global settings for the BlobStorage API. ``` yaml openapi-type: data-plane -tag: package-2021-12 +tag: package-2024-08 use-internal-constructors: true add-credentials: true ``` @@ -93,6 +93,15 @@ input-file: - stable/2021-12-02/blob.json ``` +### Tag: package-2024-08 + +These settings apply only when `--tag=package-2024-08` is specified on the command line. + +``` yaml $(tag) == 'package-2024-08' +input-file: +- stable/2024-08-04/blob.json +``` + ### Suppression ``` yaml directive: diff --git a/specification/storage/data-plane/Microsoft.BlobStorage/stable/2024-08-04/blob.json b/specification/storage/data-plane/Microsoft.BlobStorage/stable/2024-08-04/blob.json new file mode 100644 index 000000000000..60bc38a3050b --- /dev/null +++ b/specification/storage/data-plane/Microsoft.BlobStorage/stable/2024-08-04/blob.json @@ -0,0 +1,12327 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Blob Storage", + "version": "2024-08-04", + "x-ms-code-generation-settings": { + "header": "MIT", + "strictSpecAdherence": false + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Url" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "paths": {}, + "x-ms-paths": { + "/?restype=service&comp=properties": { + "put": { + "tags": [ + "service" + ], + "operationId": "Service_SetProperties", + "description": "Sets properties for a storage account's Blob service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", + "parameters": [ + { + "$ref": "#/parameters/StorageServiceProperties" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "Success (Accepted)", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "service" + ], + "operationId": "Service_GetProperties", + "description": "gets the properties of a storage account's Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/?restype=service&comp=stats": { + "get": { + "tags": [ + "service" + ], + "operationId": "Service_GetStatistics", + "description": "Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceStats" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "stats" + ] + } + ] + }, + "/?comp=list": { + "get": { + "tags": [ + "service" + ], + "operationId": "Service_ListContainersSegment", + "description": "The List Containers Segment operation returns a list of the containers under the specified account", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ListContainersInclude" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + }, + "schema": { + "$ref": "#/definitions/ListContainersSegmentResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/?restype=service&comp=userdelegationkey": { + "post": { + "tags": [ + "service" + ], + "operationId": "Service_GetUserDelegationKey", + "description": "Retrieves a user delegation key for the Blob service. This is only a valid operation when using bearer token authentication.", + "parameters": [ + { + "$ref": "#/parameters/KeyInfo" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/UserDelegationKey" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "userdelegationkey" + ] + } + ] + }, + "/?restype=account&comp=properties": { + "get": { + "tags": [ + "service" + ], + "operationId": "Service_GetAccountInfo", + "description": "Returns the sku name and account kind ", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success (OK)", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-sku-name": { + "x-ms-client-name": "SkuName", + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + }, + "description": "Identifies the sku name of the account" + }, + "x-ms-account-kind": { + "x-ms-client-name": "AccountKind", + "type": "string", + "enum": [ + "Storage", + "BlobStorage", + "StorageV2", + "FileStorage", + "BlockBlobStorage" + ], + "x-ms-enum": { + "name": "AccountKind", + "modelAsString": false + }, + "description": "Identifies the account kind" + }, + "x-ms-is-hns-enabled": { + "x-ms-client-name": "IsHierarchicalNamespaceEnabled", + "type": "boolean", + "description": "Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "account" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/?comp=batch": { + "post": { + "tags": [ + "service" + ], + "operationId": "Service_SubmitBatch", + "description": "The Batch operation allows multiple API calls to be embedded into a single HTTP request.", + "parameters": [ + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/MultipartContentType" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "batch" + ] + } + ] + }, + "/?comp=blobs": { + "get": { + "tags": [ + "service" + ], + "operationId": "Service_FilterBlobs", + "description": "The Filter Blobs operation enables callers to list blobs across all containers whose tags match a given search expression. Filter blobs searches across all containers within a storage account but can be scoped within the expression to a single container.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/FilterBlobsWhere" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/FilterBlobsInclude" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/FilterBlobSegment" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "blobs" + ] + } + ] + }, + "/{containerName}?restype=container": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_Create", + "description": "creates a new container under the specified account. If the container with the same name already exists, the operation fails", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/BlobPublicAccess" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DefaultEncryptionScope" + }, + { + "$ref": "#/parameters/DenyEncryptionScopeOverride" + } + ], + "responses": { + "201": { + "description": "Success, Container created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "container" + ], + "operationId": "Container_GetProperties", + "description": "returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-public-access": { + "x-ms-client-name": "BlobPublicAccess", + "description": "Indicated whether data in the container may be accessed publicly and the level of access", + "type": "string", + "enum": [ + "container", + "blob" + ], + "x-ms-enum": { + "name": "PublicAccessType", + "modelAsString": true + } + }, + "x-ms-has-immutability-policy": { + "x-ms-client-name": "HasImmutabilityPolicy", + "description": "Indicates whether the container has an immutability policy set on it.", + "type": "boolean" + }, + "x-ms-has-legal-hold": { + "x-ms-client-name": "HasLegalHold", + "description": "Indicates whether the container has a legal hold.", + "type": "boolean" + }, + "x-ms-default-encryption-scope": { + "x-ms-client-name": "DefaultEncryptionScope", + "description": "The default encryption scope for the container.", + "type": "string" + }, + "x-ms-deny-encryption-scope-override": { + "x-ms-client-name": "DenyEncryptionScopeOverride", + "description": "Indicates whether the container's default encryption scope can be overriden.", + "type": "boolean" + }, + "x-ms-immutable-storage-with-versioning-enabled": { + "x-ms-client-name": "IsImmutableStorageWithVersioningEnabled", + "description": "Indicates whether version level worm is enabled on a container.", + "type": "boolean" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "container" + ], + "operationId": "Container_Delete", + "description": "operation marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + } + ] + }, + "/{containerName}?restype=container&comp=metadata": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_SetMetadata", + "description": "operation sets one or more user-defined name-value pairs for the specified container.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{containerName}?restype=container&comp=acl": { + "get": { + "tags": [ + "container" + ], + "operationId": "Container_GetAccessPolicy", + "description": "gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-blob-public-access": { + "x-ms-client-name": "BlobPublicAccess", + "description": "Indicated whether data in the container may be accessed publicly and the level of access", + "type": "string", + "enum": [ + "container", + "blob" + ], + "x-ms-enum": { + "name": "PublicAccessType", + "modelAsString": true + } + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "put": { + "tags": [ + "container" + ], + "operationId": "Container_SetAccessPolicy", + "description": "sets the permissions for the specified container. The permissions indicate whether blobs in a container may be accessed publicly.", + "parameters": [ + { + "$ref": "#/parameters/ContainerAcl" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobPublicAccess" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "acl" + ] + } + ] + }, + "/{containerName}?restype=container&comp=undelete": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_Restore", + "description": "Restores a previously-deleted container.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DeletedContainerName" + }, + { + "$ref": "#/parameters/DeletedContainerVersion" + } + ], + "responses": { + "201": { + "description": "Created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "undelete" + ] + } + ] + }, + "/{containerName}?restype=container&comp=rename": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_Rename", + "description": "Renames an existing container.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/SourceContainerName" + }, + { + "$ref": "#/parameters/SourceLeaseId" + } + ], + "responses": { + "200": { + "description": "Created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "rename" + ] + } + ] + }, + "/{containerName}?restype=container&comp=batch": { + "post": { + "tags": [ + "container" + ], + "operationId": "Container_SubmitBatch", + "description": "The Batch operation allows multiple API calls to be embedded into a single HTTP request.", + "parameters": [ + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/MultipartContentType" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "batch" + ] + } + ] + }, + "/{containerName}?restype=container&comp=blobs": { + "get": { + "tags": [ + "container" + ], + "operationId": "Container_FilterBlobs", + "description": "The Filter Blobs operation enables callers to list blobs in a container whose tags match a given search expression. Filter blobs searches within the given container.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/FilterBlobsWhere" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/FilterBlobsInclude" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/FilterBlobSegment" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "blobs" + ] + } + ] + }, + "/{containerName}?comp=lease&restype=container&acquire": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_AcquireLease", + "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The Acquire operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a container's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}?comp=lease&restype=container&release": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_ReleaseLease", + "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Release operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}?comp=lease&restype=container&renew": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_RenewLease", + "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Renew operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a container's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "renew" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}?comp=lease&restype=container&break": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_BreakLease", + "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseBreakPeriod" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "The Break operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-time": { + "x-ms-client-name": "LeaseTime", + "type": "integer", + "description": "Approximate time remaining in the lease period, in seconds." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}?comp=lease&restype=container&change": { + "put": { + "tags": [ + "container" + ], + "operationId": "Container_ChangeLease", + "description": "[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ProposedLeaseIdRequired" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Change operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a container's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}?restype=container&comp=list&flat": { + "get": { + "tags": [ + "containers" + ], + "operationId": "Container_ListBlobFlatSegment", + "description": "[Update] The List Blobs operation returns a list of the blobs under the specified container", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ListBlobsInclude" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For List Blobs this is 'application/xml'" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/ListBlobsFlatSegmentResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{containerName}?restype=container&comp=list&hierarchy": { + "get": { + "tags": [ + "containers" + ], + "operationId": "Container_ListBlobHierarchySegment", + "description": "[Update] The List Blobs operation returns a list of the blobs under the specified container", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Delimiter" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ListBlobsInclude" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For List Blobs this is 'application/xml'" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/ListBlobsHierarchySegmentResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "container" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{containerName}?restype=account&comp=properties": { + "get": { + "tags": [ + "container" + ], + "operationId": "Container_GetAccountInfo", + "description": "Returns the sku name and account kind ", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success (OK)", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-sku-name": { + "x-ms-client-name": "SkuName", + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + }, + "description": "Identifies the sku name of the account" + }, + "x-ms-account-kind": { + "x-ms-client-name": "AccountKind", + "type": "string", + "enum": [ + "Storage", + "BlobStorage", + "StorageV2", + "FileStorage", + "BlockBlobStorage" + ], + "x-ms-enum": { + "name": "AccountKind", + "modelAsString": false + }, + "description": "Identifies the account kind" + }, + "x-ms-is-hns-enabled": { + "x-ms-client-name": "IsHierarchicalNamespaceEnabled", + "type": "boolean", + "description": "Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "account" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{containerName}/{blob}": { + "get": { + "tags": [ + "blob" + ], + "operationId": "Blob_Download", + "description": "The Download operation reads or downloads a blob from the system, including its metadata and properties. You can also call Download to read a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/GetRangeContentMD5" + }, + { + "$ref": "#/parameters/GetRangeContentCRC64" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Returns the content of the entire blob.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-creation-time": { + "x-ms-client-name": "CreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was created." + }, + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "x-ms-or-policy-id": { + "x-ms-client-name": "ObjectReplicationPolicyId", + "type": "string", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." + }, + "x-ms-or": { + "type": "string", + "x-ms-client-name": "ObjectReplicationRules", + "x-ms-header-collection-prefix": "x-ms-or-", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed)." + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Encoding request header" + }, + "Cache-Control": { + "type": "string", + "description": "This header is returned if it was previously specified for the blob." + }, + "Content-Disposition": { + "type": "string", + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." + }, + "Content-Language": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Language request header." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-blob-type": { + "x-ms-client-name": "BlobType", + "description": "The blob's type.", + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "x-ms-is-current-version": { + "x-ms-client-name": "IsCurrentVersion", + "type": "boolean", + "description": "The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial blob content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-blob-content-md5": { + "x-ms-client-name": "BlobContentMD5", + "type": "string", + "format": "byte", + "description": "If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range" + }, + "x-ms-tag-count": { + "x-ms-client-name": "TagCount", + "type": "integer", + "format": "int64", + "description": "The number of tags associated with the blob" + }, + "x-ms-blob-sealed": { + "x-ms-client-name": "IsSealed", + "type": "boolean", + "description": "If this blob has been sealed" + }, + "x-ms-last-access-time": { + "x-ms-client-name": "LastAccessed", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob was last read or written to" + }, + "x-ms-immutability-policy-until-date": { + "x-ms-client-name": "ImmutabilityPolicyExpiresOn", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire." + }, + "x-ms-immutability-policy-mode": { + "x-ms-client-name": "ImmutabilityPolicyMode", + "type": "string", + "enum": [ + "Mutable", + "Unlocked", + "Locked" + ], + "x-ms-enum": { + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false + }, + "description": "Indicates immutability policy mode." + }, + "x-ms-legal-hold": { + "x-ms-client-name": "LegalHold", + "type": "boolean", + "description": "Indicates if a legal hold is present on the blob." + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "206": { + "description": "Returns the content of a specified range of the blob.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-creation-time": { + "x-ms-client-name": "CreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was created." + }, + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "x-ms-or-policy-id": { + "x-ms-client-name": "ObjectReplicationPolicyId", + "type": "string", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." + }, + "x-ms-or": { + "type": "string", + "x-ms-client-name": "ObjectReplicationRules", + "x-ms-header-collection-prefix": "x-ms-or-", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed)." + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Encoding request header" + }, + "Cache-Control": { + "type": "string", + "description": "This header is returned if it was previously specified for the blob." + }, + "Content-Disposition": { + "type": "string", + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." + }, + "Content-Language": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Language request header." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-blob-type": { + "x-ms-client-name": "BlobType", + "description": "The blob's type.", + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "x-ms-content-crc64": { + "x-ms-client-name": "ContentCrc64", + "type": "string", + "format": "byte", + "description": "If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)" + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "x-ms-is-current-version": { + "x-ms-client-name": "IsCurrentVersion", + "type": "boolean", + "description": "The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial blob content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-blob-content-md5": { + "x-ms-client-name": "BlobContentMD5", + "type": "string", + "format": "byte", + "description": "If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range" + }, + "x-ms-tag-count": { + "x-ms-client-name": "TagCount", + "type": "integer", + "format": "int64", + "description": "The number of tags associated with the blob" + }, + "x-ms-blob-sealed": { + "x-ms-client-name": "IsSealed", + "type": "boolean", + "description": "If this blob has been sealed" + }, + "x-ms-last-access-time": { + "x-ms-client-name": "LastAccessed", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob was last read or written to" + }, + "x-ms-immutability-policy-until-date": { + "x-ms-client-name": "ImmutabilityPolicyExpiresOn", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire." + }, + "x-ms-immutability-policy-mode": { + "x-ms-client-name": "ImmutabilityPolicyMode", + "type": "string", + "description": "Indicates immutability policy mode." + }, + "x-ms-legal-hold": { + "x-ms-client-name": "LegalHold", + "type": "boolean", + "description": "Indicates if a legal hold is present on the blob." + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "head": { + "tags": [ + "blob" + ], + "operationId": "Blob_GetProperties", + "description": "The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Returns the properties of the blob.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-creation-time": { + "x-ms-client-name": "CreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was created." + }, + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "x-ms-or-policy-id": { + "x-ms-client-name": "ObjectReplicationPolicyId", + "type": "string", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." + }, + "x-ms-or": { + "type": "string", + "x-ms-client-name": "ObjectReplicationRules", + "x-ms-header-collection-prefix": "x-ms-or-", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed)." + }, + "x-ms-blob-type": { + "x-ms-client-name": "BlobType", + "description": "The blob's type.", + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-incremental-copy": { + "x-ms-client-name": "IsIncrementalCopy", + "type": "boolean", + "description": "Included if the blob is incremental copy blob." + }, + "x-ms-copy-destination-snapshot": { + "x-ms-client-name": "DestinationSnapshot", + "type": "string", + "description": "Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. Snapshot time of the last successful incremental copy snapshot for this blob." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the blob. The default content type is 'application/octet-stream'" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Encoding request header" + }, + "Content-Disposition": { + "type": "string", + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." + }, + "Content-Language": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Language request header." + }, + "Cache-Control": { + "type": "string", + "description": "This header is returned if it was previously specified for the blob." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial blob content." + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-access-tier": { + "x-ms-client-name": "AccessTier", + "type": "string", + "description": "The tier of page blob on a premium storage account or tier of block blob on blob storage LRS accounts. For a list of allowed premium page blob tiers, see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features. For blob storage LRS accounts, valid values are Hot/Cool/Archive." + }, + "x-ms-access-tier-inferred": { + "x-ms-client-name": "AccessTierInferred", + "type": "boolean", + "description": "For page blobs on a premium storage account only. If the access tier is not explicitly set on the blob, the tier is inferred based on its content length and this header will be returned with true value." + }, + "x-ms-archive-status": { + "x-ms-client-name": "ArchiveStatus", + "type": "string", + "description": "For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being rehydrated and is not complete then this header is returned indicating that rehydrate is pending and also tells the destination tier." + }, + "x-ms-access-tier-change-time": { + "x-ms-client-name": "AccessTierChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "x-ms-is-current-version": { + "x-ms-client-name": "IsCurrentVersion", + "type": "boolean", + "description": "The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header." + }, + "x-ms-tag-count": { + "x-ms-client-name": "TagCount", + "type": "integer", + "format": "int64", + "description": "The number of tags associated with the blob" + }, + "x-ms-expiry-time": { + "x-ms-client-name": "ExpiresOn", + "type": "string", + "format": "date-time-rfc1123", + "description": "The time this blob will expire." + }, + "x-ms-blob-sealed": { + "x-ms-client-name": "IsSealed", + "type": "boolean", + "description": "If this blob has been sealed" + }, + "x-ms-rehydrate-priority": { + "x-ms-client-name": "RehydratePriority", + "description": "If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard.", + "type": "string" + }, + "x-ms-last-access-time": { + "x-ms-client-name": "LastAccessed", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob was last read or written to" + }, + "x-ms-immutability-policy-until-date": { + "x-ms-client-name": "ImmutabilityPolicyExpiresOn", + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire." + }, + "x-ms-immutability-policy-mode": { + "x-ms-client-name": "ImmutabilityPolicyMode", + "type": "string", + "enum": [ + "Mutable", + "Unlocked", + "Locked" + ], + "x-ms-enum": { + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false + }, + "description": "Indicates immutability policy mode." + }, + "x-ms-legal-hold": { + "x-ms-client-name": "LegalHold", + "type": "boolean", + "description": "Indicates if a legal hold is present on the blob." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "blob" + ], + "operationId": "Blob_Delete", + "description": "If the storage account's soft delete feature is disabled then, when a blob is deleted, it is permanently removed from the storage account. If the storage account's soft delete feature is enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible immediately. However, the blob service retains the blob or snapshot for the number of days specified by the DeleteRetentionPolicy section of [Storage service properties] (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is permanently removed from the storage account. Note that you continue to be charged for the soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the \"include=deleted\" query parameter to discover which blobs and snapshots have been soft deleted. You can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a soft-deleted blob or snapshot causes the service to return an HTTP status code of 404 (ResourceNotFound).", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/DeleteSnapshots" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobDeleteType" + } + ], + "responses": { + "202": { + "description": "The delete request was accepted and the blob will be deleted.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + } + ] + }, + "/{containerName}/{blob}?PageBlob": { + "put": { + "tags": [ + "blob" + ], + "operationId": "PageBlob_Create", + "description": "The Create operation creates a new page blob.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/PremiumPageBlobAccessTierOptional" + }, + { + "$ref": "#/parameters/BlobContentType" + }, + { + "$ref": "#/parameters/BlobContentEncoding" + }, + { + "$ref": "#/parameters/BlobContentLanguage" + }, + { + "$ref": "#/parameters/BlobContentMD5" + }, + { + "$ref": "#/parameters/BlobCacheControl" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobContentDisposition" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/BlobContentLengthRequired" + }, + { + "$ref": "#/parameters/BlobSequenceNumber" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/LegalHoldOptional" + } + ], + "responses": { + "201": { + "description": "The blob was created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "x-ms-blob-type", + "x-ms-client-name": "blobType", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Specifies the type of blob to create: block blob, page blob, or append blob.", + "type": "string", + "enum": [ + "PageBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?AppendBlob": { + "put": { + "tags": [ + "blob" + ], + "operationId": "AppendBlob_Create", + "description": "The Create Append Blob operation creates a new append blob.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/BlobContentType" + }, + { + "$ref": "#/parameters/BlobContentEncoding" + }, + { + "$ref": "#/parameters/BlobContentLanguage" + }, + { + "$ref": "#/parameters/BlobContentMD5" + }, + { + "$ref": "#/parameters/BlobCacheControl" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobContentDisposition" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/LegalHoldOptional" + } + ], + "responses": { + "201": { + "description": "The blob was created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "x-ms-blob-type", + "x-ms-client-name": "blobType", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Specifies the type of blob to create: block blob, page blob, or append blob.", + "type": "string", + "enum": [ + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?BlockBlob": { + "put": { + "tags": [ + "blob" + ], + "operationId": "BlockBlob_Upload", + "description": "The Upload Block Blob operation updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with Put Blob; the content of the existing blob is overwritten with the content of the new blob. To perform a partial update of the content of a block blob, use the Put Block List operation.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/BlobContentType" + }, + { + "$ref": "#/parameters/BlobContentEncoding" + }, + { + "$ref": "#/parameters/BlobContentLanguage" + }, + { + "$ref": "#/parameters/BlobContentMD5" + }, + { + "$ref": "#/parameters/BlobCacheControl" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobContentDisposition" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/LegalHoldOptional" + }, + { + "$ref": "#/parameters/ContentCrc64" + } + ], + "responses": { + "201": { + "description": "The blob was updated.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "x-ms-blob-type", + "x-ms-client-name": "blobType", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Specifies the type of blob to create: block blob, page blob, or append blob.", + "type": "string", + "enum": [ + "BlockBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?BlockBlob&fromUrl": { + "put": { + "tags": [ + "blob" + ], + "operationId": "BlockBlob_PutBlobFromUrl", + "description": "The Put Blob from URL operation creates a new Block Blob where the contents of the blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. Partial updates are not supported with Put Blob from URL; the content of an existing blob is overwritten with the content of the new blob. To perform partial updates to a block blob’s contents using a source URL, use the Put Block from URL API in conjunction with Put Block List.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/BlobContentType" + }, + { + "$ref": "#/parameters/BlobContentEncoding" + }, + { + "$ref": "#/parameters/BlobContentLanguage" + }, + { + "$ref": "#/parameters/BlobContentMD5" + }, + { + "$ref": "#/parameters/BlobCacheControl" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobContentDisposition" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/SourceIfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/SourceContentMD5" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/CopySourceBlobProperties" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + }, + { + "$ref": "#/parameters/CopySourceTags" + } + ], + "responses": { + "201": { + "description": "The blob was updated.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "x-ms-blob-type", + "x-ms-client-name": "blobType", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Specifies the type of blob to create: block blob, page blob, or append blob.", + "type": "string", + "enum": [ + "BlockBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?comp=undelete": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_Undelete", + "description": "Undelete a blob that was previously soft deleted", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The blob was undeleted successfully.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "undelete" + ] + } + ] + }, + "/{containerName}/{blob}?comp=expiry": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_SetExpiry", + "description": "Sets the time a blob will expire and be deleted.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobExpiryOptions" + }, + { + "$ref": "#/parameters/BlobExpiryTime" + } + ], + "responses": { + "200": { + "description": "The blob expiry was set successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "expiry" + ] + } + ] + }, + "/{containerName}/{blob}?comp=properties&SetHTTPHeaders": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_SetHTTPHeaders", + "description": "The Set HTTP Headers operation sets system properties on the blob", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/BlobCacheControl" + }, + { + "$ref": "#/parameters/BlobContentType" + }, + { + "$ref": "#/parameters/BlobContentMD5" + }, + { + "$ref": "#/parameters/BlobContentEncoding" + }, + { + "$ref": "#/parameters/BlobContentLanguage" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/BlobContentDisposition" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The properties were set successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{containerName}/{blob}?comp=immutabilityPolicies": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_SetImmutabilityPolicy", + "description": "The Set Immutability Policy operation sets the immutability policy on the blob", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + } + ], + "responses": { + "200": { + "description": "The immutability policy was successfully set.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-immutability-policy-until-date": { + "x-ms-client-name": "ImmutabilityPolicyExpiry", + "type": "string", + "format": "date-time-rfc1123", + "description": "Indicates the time the immutability policy will expire." + }, + "x-ms-immutability-policy-mode": { + "x-ms-client-name": "ImmutabilityPolicyMode", + "type": "string", + "enum": [ + "Mutable", + "Unlocked", + "Locked" + ], + "x-ms-enum": { + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false + }, + "description": "Indicates immutability policy mode." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "blob" + ], + "operationId": "Blob_DeleteImmutabilityPolicy", + "description": "The Delete Immutability Policy operation deletes the immutability policy on the blob", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The delete immutability policy request was accepted and the immutability policy will be deleted.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "immutabilityPolicies" + ] + } + ] + }, + "/{containerName}/{blob}?comp=legalhold": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_SetLegalHold", + "description": "The Set Legal Hold operation sets a legal hold on the blob.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/LegalHoldRequired" + } + ], + "responses": { + "200": { + "description": "The legal hold was successfully set on the blob.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-legal-hold": { + "x-ms-client-name": "LegalHold", + "type": "boolean", + "description": "Indicates if the blob has a legal hold." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "legalhold" + ] + } + ] + }, + "/{containerName}/{blob}?comp=metadata": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_SetMetadata", + "description": "The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more name-value pairs", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The metadata was set successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{containerName}/{blob}?comp=lease&acquire": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_AcquireLease", + "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The Acquire operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a blobs' lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}/{blob}?comp=lease&release": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_ReleaseLease", + "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Release operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}/{blob}?comp=lease&renew": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_RenewLease", + "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Renew operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a blobs' lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "renew" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}/{blob}?comp=lease&change": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_ChangeLease", + "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ProposedLeaseIdRequired" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Change operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a blobs' lease" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}/{blob}?comp=lease&break": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_BreakLease", + "description": "[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseBreakPeriod" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "The Break operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-lease-time": { + "x-ms-client-name": "LeaseTime", + "type": "integer", + "description": "Approximate time remaining in the lease period, in seconds." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{containerName}/{blob}?comp=snapshot": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_CreateSnapshot", + "description": "The Create Snapshot operation creates a read-only snapshot of a blob", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The snaptshot was taken successfully.", + "headers": { + "x-ms-snapshot": { + "x-ms-client-name": "Snapshot", + "type": "string", + "description": "Uniquely identifies the snapshot and indicates the snapshot version. It may be used in subsequent requests to access the snapshot" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "True if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. For a snapshot request, this header is set to true when metadata was provided in the request and encrypted with a customer-provided key." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "snapshot" + ] + } + ] + }, + "/{containerName}/{blob}?comp=copy": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_StartCopyFromURL", + "description": "The Start Copy From URL operation copies a blob or an internet resource to a new blob.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/RehydratePriority" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/SourceIfTags" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/SealBlob" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/LegalHoldOptional" + } + ], + "responses": { + "202": { + "description": "The copy blob has been accepted with the specified copy status.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + } + ] + }, + "/{containerName}/{blob}?comp=copy&sync": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_CopyFromURL", + "description": "The Copy From URL operation copies a blob or an internet resource to a new blob. It will not return a response until the copy is complete.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/SourceContentMD5" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/LegalHoldOptional" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/CopySourceTags" + } + ], + "responses": { + "202": { + "description": "The copy has completed.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "success" + ], + "x-ms-enum": { + "name": "SyncCopyStatusType", + "modelAsString": false + } + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "This response header is returned so that the client can check for the integrity of the copied content. This header is only returned if the source content MD5 was specified." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This response header is returned so that the client can check for the integrity of the copied content." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "x-ms-requires-sync", + "description": "This header indicates that this is a synchronous Copy Blob From URL instead of a Asynchronous Copy Blob.", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "true" + ] + } + ] + }, + "/{containerName}/{blob}?comp=copy©id": { + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_AbortCopyFromURL", + "description": "The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination blob with zero length and full metadata.", + "parameters": [ + { + "$ref": "#/parameters/CopyId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "204": { + "description": "The delete request was accepted and the blob will be deleted.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "copy" + ] + }, + { + "name": "x-ms-copy-action", + "description": "Copy action.", + "x-ms-client-name": "copyActionAbortConstant", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "abort" + ], + "x-ms-parameter-location": "method" + } + ] + }, + "/{containerName}/{blob}?comp=tier": { + "put": { + "tags": [ + "blobs" + ], + "operationId": "Blob_SetTier", + "description": "The Set Tier operation sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag.", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/AccessTierRequired" + }, + { + "$ref": "#/parameters/RehydratePriority" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfTags" + } + ], + "responses": { + "200": { + "description": "The new tier will take effect immediately.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and newer." + } + } + }, + "202": { + "description": "The transition to the new tier is pending.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and newer." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "tier" + ] + } + ] + }, + "/{containerName}/{blob}?restype=account&comp=properties&blob": { + "get": { + "tags": [ + "blob" + ], + "operationId": "Blob_GetAccountInfo", + "description": "Returns the sku name and account kind ", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success (OK)", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-sku-name": { + "x-ms-client-name": "SkuName", + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + }, + "description": "Identifies the sku name of the account" + }, + "x-ms-account-kind": { + "x-ms-client-name": "AccountKind", + "type": "string", + "enum": [ + "Storage", + "BlobStorage", + "StorageV2", + "FileStorage", + "BlockBlobStorage" + ], + "x-ms-enum": { + "name": "AccountKind", + "modelAsString": false + }, + "description": "Identifies the account kind" + }, + "x-ms-is-hns-enabled": { + "x-ms-client-name": "IsHierarchicalNamespaceEnabled", + "type": "boolean", + "description": "Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "account" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{containerName}/{blob}?comp=block": { + "put": { + "tags": [ + "blockblob" + ], + "operationId": "BlockBlob_StageBlock", + "description": "The Stage Block operation creates a new block to be committed as part of a blob", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/BlockId" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentCrc64" + }, + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The block was created.", + "headers": { + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "block" + ] + } + ] + }, + "/{containerName}/{blob}?comp=block&fromURL": { + "put": { + "tags": [ + "blockblob" + ], + "operationId": "BlockBlob_StageBlockFromURL", + "description": "The Stage Block operation creates a new block to be committed as part of a blob where the contents are read from a URL.", + "parameters": [ + { + "$ref": "#/parameters/BlockId" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/SourceUrl" + }, + { + "$ref": "#/parameters/SourceRange" + }, + { + "$ref": "#/parameters/SourceContentMD5" + }, + { + "$ref": "#/parameters/SourceContentCRC64" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + } + ], + "responses": { + "201": { + "description": "The block was created.", + "headers": { + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "block" + ] + } + ] + }, + "/{containerName}/{blob}?comp=blocklist": { + "put": { + "tags": [ + "blockblob" + ], + "operationId": "BlockBlob_CommitBlockList", + "description": "The Commit Block List operation writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior Put Block operation. You can call Put Block List to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/BlobCacheControl" + }, + { + "$ref": "#/parameters/BlobContentType" + }, + { + "$ref": "#/parameters/BlobContentEncoding" + }, + { + "$ref": "#/parameters/BlobContentLanguage" + }, + { + "$ref": "#/parameters/BlobContentMD5" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentCrc64" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobContentDisposition" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "name": "blocks", + "description": "Blob Blocks.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlockLookupList" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/BlobTagsHeader" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyExpiry" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyMode" + }, + { + "$ref": "#/parameters/LegalHoldOptional" + } + ], + "responses": { + "201": { + "description": "The block list was recorded.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "x-ms-version-id": { + "x-ms-client-name": "VersionId", + "type": "string", + "description": "A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "blockblob" + ], + "operationId": "BlockBlob_GetBlockList", + "description": "The Get Block List operation retrieves the list of blocks that have been uploaded as part of a block blob", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/BlockListType" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The page range was written.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For Get Block List this is 'application/xml'" + }, + "x-ms-blob-content-length": { + "x-ms-client-name": "BlobContentLength", + "type": "integer", + "format": "int64", + "description": "The size of the blob in bytes." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/BlockList" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "blocklist" + ] + } + ] + }, + "/{containerName}/{blob}?comp=page&update": { + "put": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_UploadPages", + "description": "The Upload Pages operation writes a range of pages to a page blob", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentCrc64" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfSequenceNumberLessThanOrEqualTo" + }, + { + "$ref": "#/parameters/IfSequenceNumberLessThan" + }, + { + "$ref": "#/parameters/IfSequenceNumberEqualTo" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The page range was written.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for the page blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the pages. This header is only returned when the pages were encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "page" + ] + }, + { + "name": "x-ms-page-write", + "x-ms-client-name": "pageWrite", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Required. You may specify one of the following options:\n - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update.\n - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and the Range header to a value that indicates the range to clear, up to maximum blob size.", + "type": "string", + "enum": [ + "update" + ], + "x-ms-enum": { + "name": "PageWriteType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?comp=page&clear": { + "put": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_ClearPages", + "description": "The Clear Pages operation clears a set of pages from a page blob", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfSequenceNumberLessThanOrEqualTo" + }, + { + "$ref": "#/parameters/IfSequenceNumberLessThan" + }, + { + "$ref": "#/parameters/IfSequenceNumberEqualTo" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The page range was cleared.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for the page blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "page" + ] + }, + { + "name": "x-ms-page-write", + "x-ms-client-name": "pageWrite", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Required. You may specify one of the following options:\n - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update.\n - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and the Range header to a value that indicates the range to clear, up to maximum blob size.", + "type": "string", + "enum": [ + "clear" + ], + "x-ms-enum": { + "name": "PageWriteType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?comp=page&update&fromUrl": { + "put": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_UploadPagesFromURL", + "description": "The Upload Pages operation writes a range of pages to a page blob where the contents are read from a URL", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/SourceUrl" + }, + { + "$ref": "#/parameters/SourceRangeRequiredPutPageFromUrl" + }, + { + "$ref": "#/parameters/SourceContentMD5" + }, + { + "$ref": "#/parameters/SourceContentCRC64" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/RangeRequiredPutPageFromUrl" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfSequenceNumberLessThanOrEqualTo" + }, + { + "$ref": "#/parameters/IfSequenceNumberLessThan" + }, + { + "$ref": "#/parameters/IfSequenceNumberEqualTo" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + } + ], + "responses": { + "201": { + "description": "The page range was written.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for the page blob." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "page" + ] + }, + { + "name": "x-ms-page-write", + "x-ms-client-name": "pageWrite", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Required. You may specify one of the following options:\n - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update.\n - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and the Range header to a value that indicates the range to clear, up to maximum blob size.", + "type": "string", + "enum": [ + "update" + ], + "x-ms-enum": { + "name": "PageWriteType", + "modelAsString": false + } + } + ] + }, + "/{containerName}/{blob}?comp=pagelist": { + "get": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_GetPageRanges", + "description": "The Get Page Ranges operation returns the list of valid page ranges for a page blob or snapshot of a page blob", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + } + ], + "responses": { + "200": { + "description": "Information on the page blob was found.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "x-ms-blob-content-length": { + "x-ms-client-name": "BlobContentLength", + "type": "integer", + "format": "int64", + "description": "The size of the blob in bytes." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/PageList" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "pagelist" + ] + } + ] + }, + "/{containerName}/{blob}?comp=pagelist&diff": { + "get": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_GetPageRangesDiff", + "description": "The Get Page Ranges Diff operation returns the list of valid page ranges for a page blob that were changed between target blob and previous snapshot.", + "parameters": [ + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/PrevSnapshot" + }, + { + "$ref": "#/parameters/PrevSnapshotUrl" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + } + ], + "responses": { + "200": { + "description": "Information on the page blob was found.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "x-ms-blob-content-length": { + "x-ms-client-name": "BlobContentLength", + "type": "integer", + "format": "int64", + "description": "The size of the blob in bytes." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/PageList" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "pagelist" + ] + } + ] + }, + "/{containerName}/{blob}?comp=properties&Resize": { + "put": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_Resize", + "description": "Resize the Blob", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/BlobContentLengthRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Blob was resized successfully", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{containerName}/{blob}?comp=properties&UpdateSequenceNumber": { + "put": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_UpdateSequenceNumber", + "description": "Update the sequence number of the blob", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/SequenceNumberAction" + }, + { + "$ref": "#/parameters/BlobSequenceNumber" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The sequence numbers were updated successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{containerName}/{blob}?comp=incrementalcopy": { + "put": { + "tags": [ + "pageblob" + ], + "operationId": "PageBlob_CopyIncremental", + "description": "The Copy Incremental operation copies a snapshot of the source page blob to a destination page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. This API is supported since REST version 2016-05-31.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "The blob was copied.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "incrementalcopy" + ] + } + ] + }, + "/{containerName}/{blob}?comp=appendblock": { + "put": { + "tags": [ + "appendblob" + ], + "consumes": [ + "application/octet-stream" + ], + "operationId": "AppendBlob_AppendBlock", + "description": "The Append Block operation commits a new block of data to the end of an existing append blob. The Append Block operation is permitted only if the blob was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version 2015-02-21 version or later.", + "parameters": [ + { + "$ref": "#/parameters/Body" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentCrc64" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobConditionMaxSize" + }, + { + "$ref": "#/parameters/BlobConditionAppendPos" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The block was created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-append-offset": { + "x-ms-client-name": "BlobAppendOffset", + "type": "string", + "description": "This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes." + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "appendblock" + ] + } + ] + }, + "/{containerName}/{blob}?comp=appendblock&fromUrl": { + "put": { + "tags": [ + "appendblob" + ], + "operationId": "AppendBlob_AppendBlockFromUrl", + "description": "The Append Block operation commits a new block of data to the end of an existing append blob where the contents are read from a source url. The Append Block operation is permitted only if the blob was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version 2015-02-21 version or later.", + "parameters": [ + { + "$ref": "#/parameters/SourceUrl" + }, + { + "$ref": "#/parameters/SourceRange" + }, + { + "$ref": "#/parameters/SourceContentMD5" + }, + { + "$ref": "#/parameters/SourceContentCRC64" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/EncryptionScope" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobConditionMaxSize" + }, + { + "$ref": "#/parameters/BlobConditionAppendPos" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/SourceIfModifiedSince" + }, + { + "$ref": "#/parameters/SourceIfUnmodifiedSince" + }, + { + "$ref": "#/parameters/SourceIfMatch" + }, + { + "$ref": "#/parameters/SourceIfNoneMatch" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + } + ], + "responses": { + "201": { + "description": "The block was created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-append-offset": { + "x-ms-client-name": "BlobAppendOffset", + "type": "string", + "description": "This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes." + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "appendblock" + ] + } + ] + }, + "/{containerName}/{blob}?comp=seal": { + "put": { + "tags": [ + "appendblob" + ], + "operationId": "AppendBlob_Seal", + "description": "The Seal operation seals the Append Blob to make it read-only. Seal is supported only on version 2019-12-12 version or later.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/BlobConditionAppendPos" + } + ], + "responses": { + "200": { + "description": "The blob was sealed.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-sealed": { + "x-ms-client-name": "IsSealed", + "type": "boolean", + "description": "If this blob has been sealed" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "seal" + ] + } + ] + }, + "/{containerName}/{blob}?comp=query": { + "post": { + "tags": [ + "blob" + ], + "operationId": "Blob_Query", + "description": "The Query operation enables users to select/project on blob data by providing simple query expressions.", + "parameters": [ + { + "$ref": "#/parameters/QueryRequest" + }, + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/EncryptionKey" + }, + { + "$ref": "#/parameters/EncryptionKeySha256" + }, + { + "$ref": "#/parameters/EncryptionAlgorithm" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Returns the content of the entire blob.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Encoding request header" + }, + "Cache-Control": { + "type": "string", + "description": "This header is returned if it was previously specified for the blob." + }, + "Content-Disposition": { + "type": "string", + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." + }, + "Content-Language": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Language request header." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-blob-type": { + "x-ms-client-name": "BlobType", + "description": "The blob's type.", + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial blob content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-blob-content-md5": { + "x-ms-client-name": "BlobContentMD5", + "type": "string", + "format": "byte", + "description": "If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range" + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "206": { + "description": "Returns the content of a specified range of the blob.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob." + }, + "x-ms-meta": { + "type": "string", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The media type of the body of the response. For Download Blob this is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Encoding request header" + }, + "Cache-Control": { + "type": "string", + "description": "This header is returned if it was previously specified for the blob." + }, + "Content-Disposition": { + "type": "string", + "description": "This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified." + }, + "Content-Language": { + "type": "string", + "description": "This header returns the value that was specified for the Content-Language request header." + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "BlobSequenceNumber", + "type": "integer", + "format": "int64", + "description": "The current sequence number for a page blob. This header is not returned for block blobs or append blobs" + }, + "x-ms-blob-type": { + "x-ms-client-name": "BlobType", + "description": "The blob's type.", + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "x-ms-content-crc64": { + "x-ms-client-name": "ContentCrc64", + "type": "string", + "format": "byte", + "description": "If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 and x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)" + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List" + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a blob is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the blob.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the blob.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial blob content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-blob-committed-block-count": { + "x-ms-client-name": "BlobCommittedBlockCount", + "type": "integer", + "description": "The number of committed blocks present in the blob. This header is returned only for append blobs." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)." + }, + "x-ms-encryption-key-sha256": { + "x-ms-client-name": "EncryptionKeySha256", + "type": "string", + "description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key." + }, + "x-ms-encryption-scope": { + "x-ms-client-name": "EncryptionScope", + "type": "string", + "description": "Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope." + }, + "x-ms-blob-content-md5": { + "x-ms-client-name": "BlobContentMD5", + "type": "string", + "format": "byte", + "description": "If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range" + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "query" + ] + } + ] + }, + "/{containerName}/{blob}?comp=tags": { + "get": { + "tags": [ + "blob" + ], + "operationId": "Blob_GetTags", + "description": "The Get Tags operation enables users to get the tags associated with a blob.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Snapshot" + }, + { + "$ref": "#/parameters/VersionId" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Retrieved blob tags", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/BlobTags" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "put": { + "tags": [ + "blob" + ], + "operationId": "Blob_SetTags", + "description": "The Set Tags operation enables users to set tags on a blob.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/VersionId" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ContentCrc64" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/IfTags" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/BlobTagsBody" + } + ], + "responses": { + "204": { + "description": "The tags were applied to the blob", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/Blob" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "tags" + ] + } + ] + } + }, + "definitions": { + "KeyInfo": { + "type": "object", + "required": [ + "Start", + "Expiry" + ], + "description": "Key information", + "properties": { + "Start": { + "description": "The date-time the key is active in ISO 8601 UTC time", + "type": "string" + }, + "Expiry": { + "description": "The date-time the key expires in ISO 8601 UTC time", + "type": "string" + } + } + }, + "UserDelegationKey": { + "type": "object", + "required": [ + "SignedOid", + "SignedTid", + "SignedStart", + "SignedExpiry", + "SignedService", + "SignedVersion", + "Value" + ], + "description": "A user delegation key", + "properties": { + "SignedOid": { + "description": "The Azure Active Directory object ID in GUID format.", + "type": "string" + }, + "SignedTid": { + "description": "The Azure Active Directory tenant ID in GUID format", + "type": "string" + }, + "SignedStart": { + "description": "The date-time the key is active", + "type": "string", + "format": "date-time" + }, + "SignedExpiry": { + "description": "The date-time the key expires", + "type": "string", + "format": "date-time" + }, + "SignedService": { + "description": "Abbreviation of the Azure Storage service that accepts the key", + "type": "string" + }, + "SignedVersion": { + "description": "The service version that created the key", + "type": "string" + }, + "Value": { + "description": "The key as a base64 string", + "type": "string" + } + } + }, + "PublicAccessType": { + "type": "string", + "enum": [ + "container", + "blob" + ], + "x-ms-enum": { + "name": "PublicAccessType", + "modelAsString": true + } + }, + "CopyStatus": { + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "LeaseDuration": { + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "LeaseState": { + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "LeaseStatus": { + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "StorageError": { + "type": "object", + "properties": { + "Message": { + "type": "string" + } + } + }, + "AccessPolicy": { + "type": "object", + "description": "An Access policy", + "properties": { + "Start": { + "description": "the date-time the policy is active", + "type": "string", + "format": "date-time" + }, + "Expiry": { + "description": "the date-time the policy expires", + "type": "string", + "format": "date-time" + }, + "Permission": { + "description": "the permissions for the acl policy", + "type": "string" + } + } + }, + "AccessTier": { + "type": "string", + "enum": [ + "P4", + "P6", + "P10", + "P15", + "P20", + "P30", + "P40", + "P50", + "P60", + "P70", + "P80", + "Hot", + "Cool", + "Archive", + "Premium", + "Cold" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": true + } + }, + "ArchiveStatus": { + "type": "string", + "enum": [ + "rehydrate-pending-to-hot", + "rehydrate-pending-to-cool", + "rehydrate-pending-to-cold" + ], + "x-ms-enum": { + "name": "ArchiveStatus", + "modelAsString": true + } + }, + "BlobItemInternal": { + "xml": { + "name": "Blob" + }, + "description": "An Azure Storage blob", + "type": "object", + "required": [ + "Name", + "Deleted", + "Snapshot", + "Properties" + ], + "properties": { + "Name": { + "$ref": "#/definitions/BlobName" + }, + "Deleted": { + "type": "boolean" + }, + "Snapshot": { + "type": "string" + }, + "VersionId": { + "type": "string" + }, + "IsCurrentVersion": { + "type": "boolean" + }, + "Properties": { + "$ref": "#/definitions/BlobPropertiesInternal" + }, + "Metadata": { + "$ref": "#/definitions/BlobMetadata" + }, + "BlobTags": { + "$ref": "#/definitions/BlobTags" + }, + "ObjectReplicationMetadata": { + "$ref": "#/definitions/ObjectReplicationMetadata" + }, + "HasVersionsOnly": { + "type": "boolean" + } + } + }, + "BlobPropertiesInternal": { + "xml": { + "name": "Properties" + }, + "description": "Properties of a blob", + "type": "object", + "required": [ + "Etag", + "Last-Modified" + ], + "properties": { + "Creation-Time": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Etag": { + "type": "string" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "Size in bytes" + }, + "Content-Type": { + "type": "string" + }, + "Content-Encoding": { + "type": "string" + }, + "Content-Language": { + "type": "string" + }, + "Content-MD5": { + "type": "string", + "format": "byte" + }, + "Content-Disposition": { + "type": "string" + }, + "Cache-Control": { + "type": "string" + }, + "x-ms-blob-sequence-number": { + "x-ms-client-name": "blobSequenceNumber", + "type": "integer", + "format": "int64" + }, + "BlobType": { + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AppendBlob" + ], + "x-ms-enum": { + "name": "BlobType", + "modelAsString": false + } + }, + "LeaseStatus": { + "$ref": "#/definitions/LeaseStatus" + }, + "LeaseState": { + "$ref": "#/definitions/LeaseState" + }, + "LeaseDuration": { + "$ref": "#/definitions/LeaseDuration" + }, + "CopyId": { + "type": "string" + }, + "CopyStatus": { + "$ref": "#/definitions/CopyStatus" + }, + "CopySource": { + "type": "string" + }, + "CopyProgress": { + "type": "string" + }, + "CopyCompletionTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "CopyStatusDescription": { + "type": "string" + }, + "ServerEncrypted": { + "type": "boolean" + }, + "IncrementalCopy": { + "type": "boolean" + }, + "DestinationSnapshot": { + "type": "string" + }, + "DeletedTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "RemainingRetentionDays": { + "type": "integer" + }, + "AccessTier": { + "$ref": "#/definitions/AccessTier" + }, + "AccessTierInferred": { + "type": "boolean" + }, + "ArchiveStatus": { + "$ref": "#/definitions/ArchiveStatus" + }, + "CustomerProvidedKeySha256": { + "type": "string" + }, + "EncryptionScope": { + "type": "string", + "description": "The name of the encryption scope under which the blob is encrypted." + }, + "AccessTierChangeTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "TagCount": { + "type": "integer" + }, + "Expiry-Time": { + "x-ms-client-name": "ExpiresOn", + "type": "string", + "format": "date-time-rfc1123" + }, + "Sealed": { + "x-ms-client-name": "IsSealed", + "type": "boolean" + }, + "RehydratePriority": { + "$ref": "#/definitions/RehydratePriority" + }, + "LastAccessTime": { + "x-ms-client-name": "LastAccessedOn", + "type": "string", + "format": "date-time-rfc1123" + }, + "ImmutabilityPolicyUntilDate": { + "x-ms-client-name": "ImmutabilityPolicyExpiresOn", + "type": "string", + "format": "date-time-rfc1123" + }, + "ImmutabilityPolicyMode": { + "type": "string", + "enum": [ + "Mutable", + "Unlocked", + "Locked" + ], + "x-ms-enum": { + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false + } + }, + "LegalHold": { + "type": "boolean" + } + } + }, + "ListBlobsFlatSegmentResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of blobs", + "type": "object", + "required": [ + "ServiceEndpoint", + "ContainerName", + "Segment" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "ContainerName": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "type": "string" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "Segment": { + "$ref": "#/definitions/BlobFlatListSegment" + }, + "NextMarker": { + "type": "string" + } + } + }, + "ListBlobsHierarchySegmentResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of blobs", + "type": "object", + "required": [ + "ServiceEndpoint", + "ContainerName", + "Segment" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "ContainerName": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "type": "string" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "Delimiter": { + "type": "string" + }, + "Segment": { + "$ref": "#/definitions/BlobHierarchyListSegment" + }, + "NextMarker": { + "type": "string" + } + } + }, + "BlobFlatListSegment": { + "xml": { + "name": "Blobs" + }, + "required": [ + "BlobItems" + ], + "type": "object", + "properties": { + "BlobItems": { + "type": "array", + "items": { + "$ref": "#/definitions/BlobItemInternal" + } + } + } + }, + "BlobHierarchyListSegment": { + "xml": { + "name": "Blobs" + }, + "type": "object", + "required": [ + "BlobItems" + ], + "properties": { + "BlobPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/BlobPrefix" + } + }, + "BlobItems": { + "type": "array", + "items": { + "$ref": "#/definitions/BlobItemInternal" + } + } + } + }, + "BlobPrefix": { + "type": "object", + "required": [ + "Name" + ], + "properties": { + "Name": { + "$ref": "#/definitions/BlobName" + } + } + }, + "BlobName": { + "type": "object", + "properties": { + "Encoded": { + "xml": { + "attribute": true, + "name": "Encoded" + }, + "type": "boolean", + "description": "Indicates if the blob name is encoded." + }, + "content": { + "xml": { + "x-ms-text": true + }, + "type": "string", + "description": "The name of the blob." + } + } + }, + "BlobTag": { + "xml": { + "name": "Tag" + }, + "type": "object", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + } + }, + "BlobTags": { + "type": "object", + "xml": { + "name": "Tags" + }, + "description": "Blob tags", + "required": [ + "BlobTagSet" + ], + "properties": { + "BlobTagSet": { + "xml": { + "wrapped": true, + "name": "TagSet" + }, + "type": "array", + "items": { + "$ref": "#/definitions/BlobTag" + } + } + } + }, + "Block": { + "type": "object", + "required": [ + "Name", + "Size" + ], + "description": "Represents a single block in a block blob. It describes the block's ID and size.", + "properties": { + "Name": { + "description": "The base64 encoded block ID.", + "type": "string" + }, + "Size": { + "description": "The block size in bytes.", + "type": "integer", + "format": "int64" + } + } + }, + "BlockList": { + "type": "object", + "properties": { + "CommittedBlocks": { + "xml": { + "wrapped": true + }, + "type": "array", + "items": { + "$ref": "#/definitions/Block" + } + }, + "UncommittedBlocks": { + "xml": { + "wrapped": true + }, + "type": "array", + "items": { + "$ref": "#/definitions/Block" + } + } + } + }, + "BlockLookupList": { + "type": "object", + "properties": { + "Committed": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "Committed" + } + } + }, + "Uncommitted": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "Uncommitted" + } + } + }, + "Latest": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "Latest" + } + } + } + }, + "xml": { + "name": "BlockList" + } + }, + "ContainerItem": { + "xml": { + "name": "Container" + }, + "type": "object", + "required": [ + "Name", + "Properties" + ], + "description": "An Azure Storage container", + "properties": { + "Name": { + "type": "string" + }, + "Deleted": { + "type": "boolean" + }, + "Version": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/ContainerProperties" + }, + "Metadata": { + "$ref": "#/definitions/ContainerMetadata" + } + } + }, + "ContainerProperties": { + "type": "object", + "required": [ + "Last-Modified", + "Etag" + ], + "description": "Properties of a container", + "properties": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Etag": { + "type": "string" + }, + "LeaseStatus": { + "$ref": "#/definitions/LeaseStatus" + }, + "LeaseState": { + "$ref": "#/definitions/LeaseState" + }, + "LeaseDuration": { + "$ref": "#/definitions/LeaseDuration" + }, + "PublicAccess": { + "$ref": "#/definitions/PublicAccessType" + }, + "HasImmutabilityPolicy": { + "type": "boolean" + }, + "HasLegalHold": { + "type": "boolean" + }, + "DefaultEncryptionScope": { + "type": "string" + }, + "DenyEncryptionScopeOverride": { + "type": "boolean", + "x-ms-client-name": "PreventEncryptionScopeOverride" + }, + "DeletedTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "RemainingRetentionDays": { + "type": "integer" + }, + "ImmutableStorageWithVersioningEnabled": { + "x-ms-client-name": "IsImmutableStorageWithVersioningEnabled", + "type": "boolean", + "description": "Indicates if version level worm is enabled on this container." + } + } + }, + "DelimitedTextConfiguration": { + "xml": { + "name": "DelimitedTextConfiguration" + }, + "description": "Groups the settings used for interpreting the blob data if the blob is delimited text formatted.", + "type": "object", + "properties": { + "ColumnSeparator": { + "type": "string", + "description": "The string used to separate columns.", + "xml": { + "name": "ColumnSeparator" + } + }, + "FieldQuote": { + "type": "string", + "description": "The string used to quote a specific field.", + "xml": { + "name": "FieldQuote" + } + }, + "RecordSeparator": { + "type": "string", + "description": "The string used to separate records.", + "xml": { + "name": "RecordSeparator" + } + }, + "EscapeChar": { + "type": "string", + "description": "The string used as an escape character.", + "xml": { + "name": "EscapeChar" + } + }, + "HeadersPresent": { + "type": "boolean", + "description": "Represents whether the data has headers.", + "xml": { + "name": "HasHeaders" + } + } + } + }, + "JsonTextConfiguration": { + "xml": { + "name": "JsonTextConfiguration" + }, + "description": "json text configuration", + "type": "object", + "properties": { + "RecordSeparator": { + "type": "string", + "description": "The string used to separate records.", + "xml": { + "name": "RecordSeparator" + } + } + } + }, + "ArrowConfiguration": { + "xml": { + "name": "ArrowConfiguration" + }, + "description": "Groups the settings used for formatting the response if the response should be Arrow formatted.", + "type": "object", + "required": [ + "Schema" + ], + "properties": { + "Schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ArrowField" + }, + "xml": { + "wrapped": true, + "name": "Schema" + } + } + } + }, + "ParquetConfiguration": { + "xml": { + "name": "ParquetTextConfiguration" + }, + "description": "parquet configuration", + "type": "object" + }, + "ArrowField": { + "xml": { + "name": "Field" + }, + "description": "Groups settings regarding specific field of an arrow schema", + "type": "object", + "required": [ + "Type" + ], + "properties": { + "Type": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Precision": { + "type": "integer" + }, + "Scale": { + "type": "integer" + } + } + }, + "ListContainersSegmentResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of containers", + "type": "object", + "required": [ + "ServiceEndpoint", + "ContainerItems" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "type": "string" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "ContainerItems": { + "xml": { + "wrapped": true, + "name": "Containers" + }, + "type": "array", + "items": { + "$ref": "#/definitions/ContainerItem" + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "CorsRule": { + "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain", + "type": "object", + "required": [ + "AllowedOrigins", + "AllowedMethods", + "AllowedHeaders", + "ExposedHeaders", + "MaxAgeInSeconds" + ], + "properties": { + "AllowedOrigins": { + "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", + "type": "string" + }, + "AllowedMethods": { + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", + "type": "string" + }, + "AllowedHeaders": { + "description": "the request headers that the origin domain may specify on the CORS request.", + "type": "string" + }, + "ExposedHeaders": { + "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer", + "type": "string" + }, + "MaxAgeInSeconds": { + "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", + "type": "integer", + "minimum": 0 + } + } + }, + "ErrorCode": { + "description": "Error codes returned by the service", + "type": "string", + "enum": [ + "AccountAlreadyExists", + "AccountBeingCreated", + "AccountIsDisabled", + "AuthenticationFailed", + "AuthorizationFailure", + "ConditionHeadersNotSupported", + "ConditionNotMet", + "EmptyMetadataKey", + "InsufficientAccountPermissions", + "InternalError", + "InvalidAuthenticationInfo", + "InvalidHeaderValue", + "InvalidHttpVerb", + "InvalidInput", + "InvalidMd5", + "InvalidMetadata", + "InvalidQueryParameterValue", + "InvalidRange", + "InvalidResourceName", + "InvalidUri", + "InvalidXmlDocument", + "InvalidXmlNodeValue", + "Md5Mismatch", + "MetadataTooLarge", + "MissingContentLengthHeader", + "MissingRequiredQueryParameter", + "MissingRequiredHeader", + "MissingRequiredXmlNode", + "MultipleConditionHeadersNotSupported", + "OperationTimedOut", + "OutOfRangeInput", + "OutOfRangeQueryParameterValue", + "RequestBodyTooLarge", + "ResourceTypeMismatch", + "RequestUrlFailedToParse", + "ResourceAlreadyExists", + "ResourceNotFound", + "ServerBusy", + "UnsupportedHeader", + "UnsupportedXmlNode", + "UnsupportedQueryParameter", + "UnsupportedHttpVerb", + "AppendPositionConditionNotMet", + "BlobAlreadyExists", + "BlobImmutableDueToPolicy", + "BlobNotFound", + "BlobOverwritten", + "BlobTierInadequateForContentLength", + "BlobUsesCustomerSpecifiedEncryption", + "BlockCountExceedsLimit", + "BlockListTooLong", + "CannotChangeToLowerTier", + "CannotVerifyCopySource", + "ContainerAlreadyExists", + "ContainerBeingDeleted", + "ContainerDisabled", + "ContainerNotFound", + "ContentLengthLargerThanTierLimit", + "CopyAcrossAccountsNotSupported", + "CopyIdMismatch", + "FeatureVersionMismatch", + "IncrementalCopyBlobMismatch", + "IncrementalCopyOfEarlierVersionSnapshotNotAllowed", + "IncrementalCopySourceMustBeSnapshot", + "InfiniteLeaseDurationRequired", + "InvalidBlobOrBlock", + "InvalidBlobTier", + "InvalidBlobType", + "InvalidBlockId", + "InvalidBlockList", + "InvalidOperation", + "InvalidPageRange", + "InvalidSourceBlobType", + "InvalidSourceBlobUrl", + "InvalidVersionForPageBlobOperation", + "LeaseAlreadyPresent", + "LeaseAlreadyBroken", + "LeaseIdMismatchWithBlobOperation", + "LeaseIdMismatchWithContainerOperation", + "LeaseIdMismatchWithLeaseOperation", + "LeaseIdMissing", + "LeaseIsBreakingAndCannotBeAcquired", + "LeaseIsBreakingAndCannotBeChanged", + "LeaseIsBrokenAndCannotBeRenewed", + "LeaseLost", + "LeaseNotPresentWithBlobOperation", + "LeaseNotPresentWithContainerOperation", + "LeaseNotPresentWithLeaseOperation", + "MaxBlobSizeConditionNotMet", + "NoAuthenticationInformation", + "NoPendingCopyOperation", + "OperationNotAllowedOnIncrementalCopyBlob", + "PendingCopyOperation", + "PreviousSnapshotCannotBeNewer", + "PreviousSnapshotNotFound", + "PreviousSnapshotOperationNotSupported", + "SequenceNumberConditionNotMet", + "SequenceNumberIncrementTooLarge", + "SnapshotCountExceeded", + "SnapshotOperationRateExceeded", + "SnapshotsPresent", + "SourceConditionNotMet", + "SystemInUse", + "TargetConditionNotMet", + "UnauthorizedBlobOverwrite", + "BlobBeingRehydrated", + "BlobArchived", + "BlobNotArchived", + "AuthorizationSourceIPMismatch", + "AuthorizationProtocolMismatch", + "AuthorizationPermissionMismatch", + "AuthorizationServiceMismatch", + "AuthorizationResourceTypeMismatch" + ], + "x-ms-enum": { + "name": "StorageErrorCode", + "modelAsString": true + } + }, + "FilterBlobItem": { + "xml": { + "name": "Blob" + }, + "description": "Blob info from a Filter Blobs API call", + "type": "object", + "required": [ + "Name", + "ContainerName" + ], + "properties": { + "Name": { + "type": "string" + }, + "ContainerName": { + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/BlobTags" + }, + "VersionId": { + "type": "string" + }, + "IsCurrentVersion": { + "type": "boolean" + } + } + }, + "FilterBlobSegment": { + "description": "The result of a Filter Blobs API call", + "xml": { + "name": "EnumerationResults" + }, + "type": "object", + "required": [ + "ServiceEndpoint", + "Where", + "Blobs" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Where": { + "type": "string" + }, + "Blobs": { + "xml": { + "name": "Blobs", + "wrapped": true + }, + "type": "array", + "items": { + "$ref": "#/definitions/FilterBlobItem" + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "GeoReplication": { + "description": "Geo-Replication information for the Secondary Storage Service", + "type": "object", + "required": [ + "Status", + "LastSyncTime" + ], + "properties": { + "Status": { + "description": "The status of the secondary location", + "type": "string", + "enum": [ + "live", + "bootstrap", + "unavailable" + ], + "x-ms-enum": { + "name": "GeoReplicationStatusType", + "modelAsString": true + } + }, + "LastSyncTime": { + "description": "A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.", + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "Logging": { + "description": "Azure Analytics Logging settings.", + "type": "object", + "required": [ + "Version", + "Delete", + "Read", + "Write", + "RetentionPolicy" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string" + }, + "Delete": { + "description": "Indicates whether all delete requests should be logged.", + "type": "boolean" + }, + "Read": { + "description": "Indicates whether all read requests should be logged.", + "type": "boolean" + }, + "Write": { + "description": "Indicates whether all write requests should be logged.", + "type": "boolean" + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + } + } + }, + "ContainerMetadata": { + "type": "object", + "xml": { + "name": "Metadata" + }, + "additionalProperties": { + "type": "string" + } + }, + "BlobMetadata": { + "type": "object", + "xml": { + "name": "Metadata" + }, + "properties": { + "Encrypted": { + "type": "string", + "xml": { + "attribute": true + } + } + }, + "additionalProperties": { + "type": "string" + } + }, + "ObjectReplicationMetadata": { + "type": "object", + "xml": { + "name": "OrMetadata" + }, + "additionalProperties": { + "type": "string" + } + }, + "Metrics": { + "description": "a summary of request statistics grouped by API in hour or minute aggregates for blobs", + "required": [ + "Enabled" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string" + }, + "Enabled": { + "description": "Indicates whether metrics are enabled for the Blob service.", + "type": "boolean" + }, + "IncludeAPIs": { + "description": "Indicates whether metrics should generate summary statistics for called API operations.", + "type": "boolean" + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + } + } + }, + "PageList": { + "description": "the list of pages", + "type": "object", + "properties": { + "PageRange": { + "type": "array", + "items": { + "$ref": "#/definitions/PageRange" + } + }, + "ClearRange": { + "type": "array", + "items": { + "$ref": "#/definitions/ClearRange" + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "PageRange": { + "type": "object", + "required": [ + "Start", + "End" + ], + "properties": { + "Start": { + "type": "integer", + "format": "int64", + "xml": { + "name": "Start" + } + }, + "End": { + "type": "integer", + "format": "int64", + "xml": { + "name": "End" + } + } + }, + "xml": { + "name": "PageRange" + } + }, + "ClearRange": { + "type": "object", + "required": [ + "Start", + "End" + ], + "properties": { + "Start": { + "type": "integer", + "format": "int64", + "xml": { + "name": "Start" + } + }, + "End": { + "type": "integer", + "format": "int64", + "xml": { + "name": "End" + } + } + }, + "xml": { + "name": "ClearRange" + } + }, + "QueryRequest": { + "description": "Groups the set of query request settings.", + "type": "object", + "required": [ + "QueryType", + "Expression" + ], + "properties": { + "QueryType": { + "type": "string", + "description": "Required. The type of the provided query expression.", + "xml": { + "name": "QueryType" + }, + "enum": [ + "SQL" + ] + }, + "Expression": { + "type": "string", + "description": "The query expression in SQL. The maximum size of the query expression is 256KiB.", + "xml": { + "name": "Expression" + } + }, + "InputSerialization": { + "$ref": "#/definitions/QuerySerialization", + "xml": { + "name": "InputSerialization" + } + }, + "OutputSerialization": { + "$ref": "#/definitions/QuerySerialization", + "xml": { + "name": "OutputSerialization" + } + } + }, + "xml": { + "name": "QueryRequest" + } + }, + "QueryFormat": { + "type": "object", + "required": [ + "Type" + ], + "properties": { + "Type": { + "$ref": "#/definitions/QueryType" + }, + "DelimitedTextConfiguration": { + "$ref": "#/definitions/DelimitedTextConfiguration" + }, + "JsonTextConfiguration": { + "$ref": "#/definitions/JsonTextConfiguration" + }, + "ArrowConfiguration": { + "$ref": "#/definitions/ArrowConfiguration" + }, + "ParquetTextConfiguration": { + "$ref": "#/definitions/ParquetConfiguration" + } + } + }, + "QuerySerialization": { + "type": "object", + "required": [ + "Format" + ], + "properties": { + "Format": { + "$ref": "#/definitions/QueryFormat", + "xml": { + "name": "Format" + } + } + } + }, + "QueryType": { + "type": "string", + "description": "The quick query format type.", + "enum": [ + "delimited", + "json", + "arrow", + "parquet" + ], + "x-ms-enum": { + "name": "QueryFormatType", + "modelAsString": false + }, + "xml": { + "name": "Type" + } + }, + "RehydratePriority": { + "description": "If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard.", + "type": "string", + "enum": [ + "High", + "Standard" + ], + "x-ms-enum": { + "name": "RehydratePriority", + "modelAsString": true + }, + "xml": { + "name": "RehydratePriority" + } + }, + "RetentionPolicy": { + "description": "the retention policy which determines how long the associated data should persist", + "type": "object", + "required": [ + "Enabled" + ], + "properties": { + "Enabled": { + "description": "Indicates whether a retention policy is enabled for the storage service", + "type": "boolean" + }, + "Days": { + "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted", + "type": "integer", + "minimum": 1 + }, + "AllowPermanentDelete": { + "description": "Indicates whether permanent delete is allowed on this storage account.", + "type": "boolean" + } + } + }, + "SignedIdentifier": { + "xml": { + "name": "SignedIdentifier" + }, + "description": "signed identifier", + "type": "object", + "required": [ + "Id", + "AccessPolicy" + ], + "properties": { + "Id": { + "type": "string", + "description": "a unique id" + }, + "AccessPolicy": { + "$ref": "#/definitions/AccessPolicy" + } + } + }, + "SignedIdentifiers": { + "description": "a collection of signed identifiers", + "type": "array", + "items": { + "$ref": "#/definitions/SignedIdentifier" + }, + "xml": { + "wrapped": true, + "name": "SignedIdentifiers" + } + }, + "StaticWebsite": { + "description": "The properties that enable an account to host a static website", + "type": "object", + "required": [ + "Enabled" + ], + "properties": { + "Enabled": { + "description": "Indicates whether this account is hosting a static website", + "type": "boolean" + }, + "IndexDocument": { + "description": "The default name of the index page under each directory", + "type": "string" + }, + "ErrorDocument404Path": { + "description": "The absolute path of the custom 404 page", + "type": "string" + }, + "DefaultIndexDocumentPath": { + "description": "Absolute path of the default index page", + "type": "string" + } + } + }, + "StorageServiceProperties": { + "description": "Storage Service Properties.", + "type": "object", + "properties": { + "Logging": { + "$ref": "#/definitions/Logging" + }, + "HourMetrics": { + "$ref": "#/definitions/Metrics" + }, + "MinuteMetrics": { + "$ref": "#/definitions/Metrics" + }, + "Cors": { + "description": "The set of CORS rules.", + "type": "array", + "items": { + "$ref": "#/definitions/CorsRule" + }, + "xml": { + "wrapped": true + } + }, + "DefaultServiceVersion": { + "description": "The default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions", + "type": "string" + }, + "DeleteRetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + }, + "StaticWebsite": { + "$ref": "#/definitions/StaticWebsite" + } + } + }, + "StorageServiceStats": { + "description": "Stats for the storage service.", + "type": "object", + "properties": { + "GeoReplication": { + "$ref": "#/definitions/GeoReplication" + } + } + } + }, + "parameters": { + "Url": { + "name": "url", + "description": "The URL of the service account, container, or blob that is the target of the desired operation.", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "ApiVersionParameter": { + "name": "x-ms-version", + "x-ms-parameter-location": "client", + "x-ms-client-name": "version", + "in": "header", + "required": true, + "type": "string", + "description": "Specifies the version of the operation to use for this request.", + "enum": [ + "2024-08-04" + ] + }, + "Blob": { + "name": "blob", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(?:/[a-zA-Z0-9]+)*(?:\\.[a-zA-Z0-9]+){0,1}$", + "minLength": 1, + "maxLength": 1024, + "x-ms-parameter-location": "method", + "description": "The blob name." + }, + "BlobCacheControl": { + "name": "x-ms-blob-cache-control", + "x-ms-client-name": "blobCacheControl", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request." + }, + "BlobConditionAppendPos": { + "name": "x-ms-blob-condition-appendpos", + "x-ms-client-name": "appendPosition", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "append-position-access-conditions" + }, + "description": "Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed)." + }, + "BlobConditionMaxSize": { + "name": "x-ms-blob-condition-maxsize", + "x-ms-client-name": "maxSize", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "append-position-access-conditions" + }, + "description": "Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed)." + }, + "BlobPublicAccess": { + "name": "x-ms-blob-public-access", + "x-ms-client-name": "access", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "description": "Specifies whether data in the container may be accessed publicly and the level of access", + "type": "string", + "enum": [ + "container", + "blob" + ], + "x-ms-enum": { + "name": "PublicAccessType", + "modelAsString": true + } + }, + "BlobTagsBody": { + "name": "Tags", + "in": "body", + "schema": { + "$ref": "#/definitions/BlobTags" + }, + "x-ms-parameter-location": "method", + "description": "Blob tags" + }, + "BlobTagsHeader": { + "name": "x-ms-tags", + "x-ms-client-name": "BlobTagsString", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional. Used to set blob tags in various blob operations." + }, + "AccessTierRequired": { + "name": "x-ms-access-tier", + "x-ms-client-name": "tier", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "P4", + "P6", + "P10", + "P15", + "P20", + "P30", + "P40", + "P50", + "P60", + "P70", + "P80", + "Hot", + "Cool", + "Archive", + "Cold" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "Indicates the tier to be set on the blob." + }, + "AccessTierOptional": { + "name": "x-ms-access-tier", + "x-ms-client-name": "tier", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "P4", + "P6", + "P10", + "P15", + "P20", + "P30", + "P40", + "P50", + "P60", + "P70", + "P80", + "Hot", + "Cool", + "Archive", + "Cold" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "Optional. Indicates the tier to be set on the blob." + }, + "PremiumPageBlobAccessTierOptional": { + "name": "x-ms-access-tier", + "x-ms-client-name": "tier", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "P4", + "P6", + "P10", + "P15", + "P20", + "P30", + "P40", + "P50", + "P60", + "P70", + "P80" + ], + "x-ms-enum": { + "name": "PremiumPageBlobAccessTier", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "Optional. Indicates the tier to be set on the page blob." + }, + "RehydratePriority": { + "name": "x-ms-rehydrate-priority", + "x-ms-client-name": "rehydratePriority", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "High", + "Standard" + ], + "x-ms-enum": { + "name": "RehydratePriority", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "Optional: Indicates the priority with which to rehydrate an archived blob." + }, + "BlobContentDisposition": { + "name": "x-ms-blob-content-disposition", + "x-ms-client-name": "blobContentDisposition", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. Sets the blob's Content-Disposition header." + }, + "BlobContentEncoding": { + "name": "x-ms-blob-content-encoding", + "x-ms-client-name": "blobContentEncoding", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request." + }, + "BlobContentLanguage": { + "name": "x-ms-blob-content-language", + "x-ms-client-name": "blobContentLanguage", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request." + }, + "BlobContentLengthOptional": { + "name": "x-ms-blob-content-length", + "x-ms-client-name": "blobContentLength", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "description": "This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary." + }, + "BlobContentLengthRequired": { + "name": "x-ms-blob-content-length", + "x-ms-client-name": "blobContentLength", + "in": "header", + "required": true, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "description": "This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary." + }, + "BlobContentMD5": { + "name": "x-ms-blob-content-md5", + "x-ms-client-name": "blobContentMD5", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded." + }, + "BlobContentType": { + "name": "x-ms-blob-content-type", + "x-ms-client-name": "blobContentType", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request." + }, + "BlobDeleteType": { + "name": "deletetype", + "x-ms-client-name": "blobDeleteType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "Permanent" + ], + "x-ms-enum": { + "name": "BlobDeleteType", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Optional. Only possible value is 'permanent', which specifies to permanently delete a blob if blob soft delete is enabled." + }, + "BlobExpiryOptions": { + "name": "x-ms-expiry-option", + "x-ms-client-name": "ExpiryOptions", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "NeverExpire", + "RelativeToCreation", + "RelativeToNow", + "Absolute" + ], + "x-ms-enum": { + "name": "BlobExpiryOptions", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "Required. Indicates mode of the expiry time" + }, + "BlobExpiryTime": { + "name": "x-ms-expiry-time", + "x-ms-client-name": "ExpiresOn", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The time to set the blob to expiry" + }, + "BlobSequenceNumber": { + "name": "x-ms-blob-sequence-number", + "x-ms-client-name": "blobSequenceNumber", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "default": 0, + "x-ms-parameter-location": "method", + "description": "Set for page blobs only. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1." + }, + "BlockId": { + "name": "blockid", + "x-ms-client-name": "blockId", + "in": "query", + "type": "string", + "required": true, + "x-ms-parameter-location": "method", + "description": "A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block." + }, + "BlockListType": { + "name": "blocklisttype", + "x-ms-client-name": "listType", + "in": "query", + "required": true, + "default": "committed", + "x-ms-parameter-location": "method", + "description": "Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together.", + "type": "string", + "enum": [ + "committed", + "uncommitted", + "all" + ], + "x-ms-enum": { + "name": "BlockListType", + "modelAsString": false + } + }, + "Body": { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "format": "file" + }, + "x-ms-parameter-location": "method", + "description": "Initial data" + }, + "ContainerAcl": { + "name": "containerAcl", + "in": "body", + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + }, + "x-ms-parameter-location": "method", + "description": "the acls for the container" + }, + "CopyId": { + "name": "copyid", + "x-ms-client-name": "copyId", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The copy identifier provided in the x-ms-copy-id header of the original Copy Blob operation." + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "requestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "ContainerName": { + "name": "containerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The container name." + }, + "ContentCrc64": { + "name": "x-ms-content-crc64", + "x-ms-client-name": "transactionalContentCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the transactional crc64 for the body, to be validated by the service." + }, + "ContentLength": { + "name": "Content-Length", + "in": "header", + "required": true, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "description": "The length of the request." + }, + "ContentMD5": { + "name": "Content-MD5", + "x-ms-client-name": "transactionalContentMD5", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the transactional md5 for the body, to be validated by the service." + }, + "CopySource": { + "name": "x-ms-copy-source", + "x-ms-client-name": "copySource", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature." + }, + "CopySourceAuthorization": { + "name": "x-ms-copy-source-authorization", + "x-ms-client-name": "copySourceAuthorization", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source." + }, + "CopySourceBlobProperties": { + "name": "x-ms-copy-source-blob-properties", + "x-ms-client-name": "copySourceBlobProperties", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Optional, default is true. Indicates if properties from the source blob should be copied." + }, + "CopySourceTags": { + "name": "x-ms-copy-source-tag-option", + "x-ms-client-name": "copySourceTags", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "REPLACE", + "COPY" + ], + "x-ms-enum": { + "name": "BlobCopySourceTags", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Optional, default 'replace'. Indicates if source tags should be copied or replaced with the tags specified by x-ms-tags." + }, + "DeleteSnapshots": { + "name": "x-ms-delete-snapshots", + "x-ms-client-name": "deleteSnapshots", + "description": "Required if the blob has associated snapshots. Specify one of the following two options: include: Delete the base blob and all of its snapshots. only: Delete only the blob's snapshots and not the blob itself", + "x-ms-parameter-location": "method", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "include", + "only" + ], + "x-ms-enum": { + "name": "DeleteSnapshotsOptionType", + "modelAsString": false + } + }, + "Delimiter": { + "name": "delimiter", + "description": "When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.", + "type": "string", + "x-ms-parameter-location": "method", + "in": "query", + "required": true + }, + "EncryptionKey": { + "name": "x-ms-encryption-key", + "x-ms-client-name": "encryptionKey", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "cpk-info" + }, + "description": "Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services." + }, + "EncryptionKeySha256": { + "name": "x-ms-encryption-key-sha256", + "x-ms-client-name": "encryptionKeySha256", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "cpk-info" + }, + "description": "The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided." + }, + "EncryptionAlgorithm": { + "name": "x-ms-encryption-algorithm", + "x-ms-client-name": "encryptionAlgorithm", + "type": "string", + "in": "header", + "required": false, + "enum": [ + "AES256" + ], + "x-ms-enum": { + "name": "EncryptionAlgorithmType", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "cpk-info" + }, + "description": "The algorithm used to produce the encryption key hash. Currently, the only accepted value is \"AES256\". Must be provided if the x-ms-encryption-key header is provided." + }, + "EncryptionScope": { + "name": "x-ms-encryption-scope", + "x-ms-client-name": "encryptionScope", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "cpk-scope-info" + }, + "description": "Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services." + }, + "DefaultEncryptionScope": { + "name": "x-ms-default-encryption-scope", + "x-ms-client-name": "DefaultEncryptionScope", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "container-cpk-scope-info" + }, + "description": "Optional. Version 2019-07-07 and later. Specifies the default encryption scope to set on the container and use for all future writes." + }, + "DeletedContainerName": { + "name": "x-ms-deleted-container-name", + "x-ms-client-name": "DeletedContainerName", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "description": "Optional. Version 2019-12-12 and later. Specifies the name of the deleted container to restore." + }, + "DeletedContainerVersion": { + "name": "x-ms-deleted-container-version", + "x-ms-client-name": "DeletedContainerVersion", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "description": "Optional. Version 2019-12-12 and later. Specifies the version of the deleted container to restore." + }, + "DenyEncryptionScopeOverride": { + "name": "x-ms-deny-encryption-scope-override", + "x-ms-client-name": "PreventEncryptionScopeOverride", + "type": "boolean", + "in": "header", + "required": false, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "container-cpk-scope-info" + }, + "description": "Optional. Version 2019-07-07 and newer. If true, prevents any request from specifying a different encryption scope than the scope set on the container." + }, + "FilterBlobsInclude": { + "name": "include", + "in": "query", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "none", + "versions" + ], + "x-ms-enum": { + "name": "FilterBlobsIncludeItem", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method", + "description": "Include this parameter to specify one or more datasets to include in the response." + }, + "FilterBlobsWhere": { + "name": "where", + "in": "query", + "required": false, + "type": "string", + "description": "Filters the results to return only to return only blobs whose tags match the specified expression.", + "x-ms-parameter-location": "method" + }, + "GetRangeContentMD5": { + "name": "x-ms-range-get-content-md5", + "x-ms-client-name": "rangeGetContentMD5", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "When set to true and specified together with the Range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size." + }, + "GetRangeContentCRC64": { + "name": "x-ms-range-get-content-crc64", + "x-ms-client-name": "rangeGetContentCRC64", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "When set to true and specified together with the Range, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size." + }, + "IfMatch": { + "name": "If-Match", + "x-ms-client-name": "ifMatch", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs with a matching value." + }, + "IfModifiedSince": { + "name": "If-Modified-Since", + "x-ms-client-name": "ifModifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time." + }, + "IfNoneMatch": { + "name": "If-None-Match", + "x-ms-client-name": "ifNoneMatch", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs without a matching value." + }, + "IfUnmodifiedSince": { + "name": "If-Unmodified-Since", + "x-ms-client-name": "ifUnmodifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time." + }, + "IfSequenceNumberEqualTo": { + "name": "x-ms-if-sequence-number-eq", + "x-ms-client-name": "ifSequenceNumberEqualTo", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "sequence-number-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has the specified sequence number." + }, + "IfSequenceNumberLessThan": { + "name": "x-ms-if-sequence-number-lt", + "x-ms-client-name": "ifSequenceNumberLessThan", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "sequence-number-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has a sequence number less than the specified." + }, + "IfSequenceNumberLessThanOrEqualTo": { + "name": "x-ms-if-sequence-number-le", + "x-ms-client-name": "ifSequenceNumberLessThanOrEqualTo", + "in": "header", + "required": false, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "sequence-number-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified." + }, + "IfTags": { + "name": "x-ms-if-tags", + "x-ms-client-name": "ifTags", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify a SQL where clause on blob tags to operate only on blobs with a matching value." + }, + "ImmutabilityPolicyExpiry": { + "name": "x-ms-immutability-policy-until-date", + "x-ms-client-name": "immutabilityPolicyExpiry", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "description": "Specifies the date time when the blobs immutability policy is set to expire." + }, + "ImmutabilityPolicyMode": { + "name": "x-ms-immutability-policy-mode", + "x-ms-client-name": "immutabilityPolicyMode", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "Unlocked", + "Locked" + ], + "x-ms-enum": { + "name": "BlobImmutabilityPolicyMode", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Specifies the immutability policy mode to set on the blob." + }, + "KeyInfo": { + "description": "Key information", + "name": "KeyInfo", + "in": "body", + "x-ms-parameter-location": "method", + "required": true, + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, + "ListBlobsInclude": { + "name": "include", + "in": "query", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "copy", + "deleted", + "metadata", + "snapshots", + "uncommittedblobs", + "versions", + "tags", + "immutabilitypolicy", + "legalhold", + "deletedwithversions" + ], + "x-ms-enum": { + "name": "ListBlobsIncludeItem", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method", + "description": "Include this parameter to specify one or more datasets to include in the response." + }, + "ListContainersInclude": { + "name": "include", + "in": "query", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "metadata", + "deleted", + "system" + ], + "x-ms-enum": { + "name": "ListContainersIncludeType", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method", + "description": "Include this parameter to specify that the container's metadata be returned as part of the response body." + }, + "LeaseBreakPeriod": { + "name": "x-ms-lease-break-period", + "x-ms-client-name": "breakPeriod", + "in": "header", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method", + "description": "For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately." + }, + "LeaseDuration": { + "name": "x-ms-lease-duration", + "x-ms-client-name": "duration", + "in": "header", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method", + "description": "Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change." + }, + "LeaseIdOptional": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "lease-access-conditions" + }, + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID." + }, + "LeaseIdRequired": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the current lease ID on the resource." + }, + "LegalHoldOptional": { + "name": "x-ms-legal-hold", + "x-ms-client-name": "legalHold", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Specified if a legal hold should be set on the blob." + }, + "LegalHoldRequired": { + "name": "x-ms-legal-hold", + "x-ms-client-name": "legalHold", + "in": "header", + "required": true, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Specified if a legal hold should be set on the blob." + }, + "Marker": { + "name": "marker", + "in": "query", + "required": false, + "type": "string", + "description": "A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client.", + "x-ms-parameter-location": "method" + }, + "MaxResults": { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "x-ms-parameter-location": "method", + "description": "Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000." + }, + "Metadata": { + "name": "x-ms-meta", + "x-ms-client-name": "metadata", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information.", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "MultipartContentType": { + "name": "Content-Type", + "x-ms-client-name": "multipartContentType", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Required. The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_" + }, + "ObjectReplicationPolicyId": { + "name": "x-ms-or-policy-id", + "x-ms-client-name": "objectReplicationPolicyId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication." + }, + "ObjectReplicationRules": { + "name": "x-ms-or", + "x-ms-client-name": "ObjectReplicationRules", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed).", + "x-ms-header-collection-prefix": "x-ms-or-" + }, + "Prefix": { + "name": "prefix", + "in": "query", + "required": false, + "type": "string", + "description": "Filters the results to return only containers whose name begins with the specified prefix.", + "x-ms-parameter-location": "method" + }, + "PrevSnapshot": { + "name": "prevsnapshot", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional in version 2015-07-08 and newer. The prevsnapshot parameter is a DateTime value that specifies that the response will contain only pages that were changed between target blob and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, as long as the snapshot specified by prevsnapshot is the older of the two. Note that incremental snapshots are currently supported only for blobs created on or after January 1, 2016." + }, + "PrevSnapshotUrl": { + "name": "x-ms-previous-snapshot-url", + "x-ms-client-name": "prevSnapshotUrl", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional. This header is only supported in service versions 2019-04-19 and after and specifies the URL of a previous snapshot of the target blob. The response will only contain pages that were changed between the target blob and its previous snapshot." + }, + "ProposedLeaseIdOptional": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "ProposedLeaseIdRequired": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "QueryRequest": { + "name": "queryRequest", + "in": "body", + "x-ms-parameter-location": "client", + "schema": { + "$ref": "#/definitions/QueryRequest" + }, + "description": "the query request" + }, + "Range": { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Return only the bytes of the blob in the specified range." + }, + "RangeRequiredPutPageFromUrl": { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The range of bytes to which the source range would be written. The range should be 512 aligned and range-end is required." + }, + "SequenceNumberAction": { + "name": "x-ms-sequence-number-action", + "x-ms-client-name": "sequenceNumberAction", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Required if the x-ms-blob-sequence-number header is set for the request. This property applies to page blobs only. This property indicates how the service should modify the blob's sequence number", + "type": "string", + "enum": [ + "max", + "update", + "increment" + ], + "x-ms-enum": { + "name": "SequenceNumberActionType", + "modelAsString": false + } + }, + "Snapshot": { + "name": "snapshot", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob." + }, + "VersionId": { + "name": "versionid", + "x-ms-client-name": "versionId", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer." + }, + "SealBlob": { + "name": "x-ms-seal-blob", + "x-ms-client-name": "SealBlob", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Overrides the sealed state of the destination blob. Service version 2019-12-12 and newer." + }, + "SourceContainerName": { + "name": "x-ms-source-container-name", + "x-ms-client-name": "SourceContainerName", + "type": "string", + "in": "header", + "required": true, + "x-ms-parameter-location": "method", + "description": "Required. Specifies the name of the container to rename." + }, + "SourceContentMD5": { + "name": "x-ms-source-content-md5", + "x-ms-client-name": "sourceContentMD5", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the md5 calculated for the range of bytes that must be read from the copy source." + }, + "SourceContentCRC64": { + "name": "x-ms-source-content-crc64", + "x-ms-client-name": "sourceContentcrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the crc64 calculated for the range of bytes that must be read from the copy source." + }, + "SourceRange": { + "name": "x-ms-source-range", + "x-ms-client-name": "sourceRange", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Bytes of source data in the specified range." + }, + "SourceRangeRequiredPutPageFromUrl": { + "name": "x-ms-source-range", + "x-ms-client-name": "sourceRange", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Bytes of source data in the specified range. The length of this range should match the ContentLength header and x-ms-range/Range destination range header." + }, + "SourceIfMatch": { + "name": "x-ms-source-if-match", + "x-ms-client-name": "sourceIfMatch", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs with a matching value." + }, + "SourceIfModifiedSince": { + "name": "x-ms-source-if-modified-since", + "x-ms-client-name": "sourceIfModifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time." + }, + "SourceIfNoneMatch": { + "name": "x-ms-source-if-none-match", + "x-ms-client-name": "sourceIfNoneMatch", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs without a matching value." + }, + "SourceIfUnmodifiedSince": { + "name": "x-ms-source-if-unmodified-since", + "x-ms-client-name": "sourceIfUnmodifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time." + }, + "SourceLeaseId": { + "name": "x-ms-source-lease-id", + "x-ms-client-name": "sourceLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match." + }, + "SourceIfTags": { + "name": "x-ms-source-if-tags", + "x-ms-client-name": "sourceIfTags", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify a SQL where clause on blob tags to operate only on blobs with a matching value." + }, + "SourceUrl": { + "name": "x-ms-copy-source", + "x-ms-client-name": "sourceUrl", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specify a URL to the copy source." + }, + "StorageServiceProperties": { + "name": "StorageServiceProperties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + }, + "x-ms-parameter-location": "method", + "description": "The StorageService properties." + }, + "Timeout": { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "x-ms-parameter-location": "method", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations." + } + } +} diff --git a/specification/storage/data-plane/Microsoft.FileStorage/readme.md b/specification/storage/data-plane/Microsoft.FileStorage/readme.md index b6d4b9ac5730..4533a1398f89 100644 --- a/specification/storage/data-plane/Microsoft.FileStorage/readme.md +++ b/specification/storage/data-plane/Microsoft.FileStorage/readme.md @@ -25,7 +25,7 @@ These are the global settings for the FileStorage API. ``` yaml openapi-type: data-plane -tag: package-2024-05 +tag: package-2024-08 use-internal-constructors: true add-credentials: true ``` @@ -129,6 +129,15 @@ input-file: - stable/2024-05-04/file.json ``` +### Tag: package-2024-08 + +These settings apply only when `--tag=package-2024-08` is specified on the command line. + +``` yaml $(tag) == 'package-2024-08' +input-file: +- stable/2024-08-04/file.json +``` + ### Suppression ``` yaml directive: diff --git a/specification/storage/data-plane/Microsoft.FileStorage/stable/2024-08-04/file.json b/specification/storage/data-plane/Microsoft.FileStorage/stable/2024-08-04/file.json new file mode 100644 index 000000000000..c97aad28c158 --- /dev/null +++ b/specification/storage/data-plane/Microsoft.FileStorage/stable/2024-08-04/file.json @@ -0,0 +1,7447 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure File Storage", + "version": "2024-08-04", + "x-ms-code-generation-settings": { + "header": "MIT", + "strictSpecAdherence": false + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Url" + } + ] + }, + "securityDefinitions": { + "File_shared_key": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "paths": {}, + "x-ms-paths": { + "/?restype=service&comp=properties": { + "put": { + "tags": [ + "service" + ], + "operationId": "Service_SetProperties", + "description": "Sets properties for a storage account's File service endpoint, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/StorageServiceProperties" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success (Accepted)", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "service" + ], + "operationId": "Service_GetProperties", + "description": "Gets the properties of a storage account's File service, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/?comp=list": { + "get": { + "tags": [ + "service" + ], + "operationId": "Service_ListSharesSegment", + "description": "The List Shares Segment operation returns a list of the shares and share snapshots under the specified account.", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ListSharesInclude" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + } + }, + "schema": { + "$ref": "#/definitions/ListSharesResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{shareName}?restype=share": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_Create", + "description": "Creates a new share under the specified account. If the share with the same name already exists, the operation fails.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ShareQuota" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareEnabledProtocols" + }, + { + "$ref": "#/parameters/ShareRootSquash" + }, + { + "$ref": "#/parameters/EnableSnapshotVirtualDirectoryAccess" + } + ], + "responses": { + "201": { + "description": "Success, Share created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the share, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetProperties", + "description": "Returns all user-defined metadata and system properties for the specified share or share snapshot. The data returned does not include the share's list of files.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs that contain the user-defined metadata of the share.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-quota": { + "x-ms-client-name": "Quota", + "type": "integer", + "description": "Returns the current share quota in GB." + }, + "x-ms-share-provisioned-iops": { + "x-ms-client-name": "ProvisionedIops", + "type": "integer", + "description": "Returns the current share provisioned ipos." + }, + "x-ms-share-provisioned-ingress-mbps": { + "x-ms-client-name": "ProvisionedIngressMBps", + "type": "integer", + "description": "Returns the current share provisioned ingress in megabytes per second." + }, + "x-ms-share-provisioned-egress-mbps": { + "x-ms-client-name": "ProvisionedEgressMBps", + "type": "integer", + "description": "Returns the current share provisioned egress in megabytes per second." + }, + "x-ms-share-next-allowed-quota-downgrade-time": { + "x-ms-client-name": "NextAllowedQuotaDowngradeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the current share next allowed quota downgrade time." + }, + "x-ms-share-provisioned-bandwidth-mibps": { + "x-ms-client-name": "ProvisionedBandwidthMibps", + "type": "integer", + "description": "Returns the current share provisioned bandwidth in megabits per second." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a share is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the share.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the share.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-access-tier": { + "x-ms-client-name": "AccessTier", + "type": "string", + "description": "Returns the access tier set on the share." + }, + "x-ms-access-tier-change-time": { + "x-ms-client-name": "AccessTierChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the last modified time (in UTC) of the access tier of the share." + }, + "x-ms-access-tier-transition-state": { + "x-ms-client-name": "AccessTierTransitionState", + "type": "string", + "description": "Returns the transition state between access tiers, when present." + }, + "x-ms-enabled-protocols": { + "x-ms-client-name": "EnabledProtocols", + "description": "The protocols that have been enabled on the share.", + "type": "string" + }, + "x-ms-root-squash": { + "x-ms-client-name": "RootSquash", + "description": "Valid for NFS shares only.", + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false + } + }, + "x-ms-enable-snapshot-virtual-directory-access": { + "x-ms-client-name": "EnableSnapshotVirtualDirectoryAccess", + "description": "Version 2023-08-03 and newer. Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled. This header is only returned for shares, not for snapshots.", + "type": "boolean" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "share" + ], + "operationId": "Share_Delete", + "description": "Operation marks the specified share or share snapshot for deletion. The share or share snapshot and any files contained within it are later deleted during garbage collection.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/DeleteSnapshots" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&acquire": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_AcquireLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The Acquire operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&release": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_ReleaseLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Release operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&change": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_ChangeLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Change operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&renew": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_RenewLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Renew operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the current share next allowed quota downgrade time." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "renew" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&break": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_BreakLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseBreakPeriod" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ShareSnapshot" + } + ], + "responses": { + "202": { + "description": "The Break operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-time": { + "x-ms-client-name": "LeaseTime", + "type": "integer", + "description": "Approximate time remaining in the lease period, in seconds." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=snapshot": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_CreateSnapshot", + "description": "Creates a read-only snapshot of a share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Success, Share snapshot created.", + "headers": { + "x-ms-snapshot": { + "x-ms-client-name": "Snapshot", + "type": "string", + "description": "This header is a DateTime value that uniquely identifies the share snapshot. The value of this header may be used in subsequent requests to access the share snapshot. This value is opaque." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the share snapshot, in quotes. A share snapshot cannot be modified, so the ETag of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the ETag of the share snapshot differs from that of the base share. If no metadata was specified with the request, the ETag of the share snapshot is identical to that of the base share at the time the share snapshot was taken." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. A share snapshot cannot be modified, so the last modified time of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the last modified time of the share snapshot differs from that of the base share. If no metadata was specified with the request, the last modified time of the share snapshot is identical to that of the base share at the time the share snapshot was taken." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "snapshot" + ] + } + ] + }, + "/{shareName}?restype=share&comp=filepermission": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_CreatePermission", + "description": "Create a permission (a security descriptor).", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SharePermission" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success, Share level permission created.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory/file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetPermission", + "description": "Returns the permission (security descriptor) for a given key", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/FilePermissionKeyRequired" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/SharePermission" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "filepermission" + ] + } + ] + }, + "/{shareName}?restype=share&comp=properties": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_SetProperties", + "description": "Sets properties for the specified share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareQuota" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ShareRootSquash" + }, + { + "$ref": "#/parameters/EnableSnapshotVirtualDirectoryAccess" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{shareName}?restype=share&comp=metadata": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_SetMetadata", + "description": "Sets one or more user-defined name-value pairs for the specified share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{shareName}?restype=share&comp=acl": { + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetAccessPolicy", + "description": "Returns information about stored access policies specified on the share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "put": { + "tags": [ + "share" + ], + "operationId": "Share_SetAccessPolicy", + "description": "Sets a stored access policy for use with shared access signatures.", + "parameters": [ + { + "$ref": "#/parameters/ShareAcl" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "acl" + ] + } + ] + }, + "/{shareName}?restype=share&comp=stats": { + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetStatistics", + "description": "Retrieves statistics related to the share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ShareStats" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "stats" + ] + } + ] + }, + "/{shareName}?restype=share&comp=undelete": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_Restore", + "description": "Restores a previously deleted Share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DeletedShareName" + }, + { + "$ref": "#/parameters/DeletedShareVersion" + } + ], + "responses": { + "201": { + "description": "Created", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "undelete" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_Create", + "description": "Creates a new directory under the specified share or parent directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/FileChangeTime" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success, Directory created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the directory, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the directory." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the directory." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the directory." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the directory." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "directory" + ], + "operationId": "Directory_GetProperties", + "description": "Returns all system properties for the specified directory, and can also be used to check the existence of a directory. The data returned does not include the files in the directory or any subdirectories.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs that contain metadata for the directory.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the Directory was last modified. Operations on files within the directory do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the directory." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the directory." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the directory." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the directory." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "directory" + ], + "operationId": "Directory_Delete", + "description": "Removes the specified empty directory. Note that the directory must be empty before it can be deleted.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "Success (Accepted).", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "$ref": "#/parameters/AllowTrailingDot" + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=properties": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_SetProperties", + "description": "Sets properties on the directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/FileChangeTime" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the directory." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the directory." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the directory." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the directory." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=metadata": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_SetMetadata", + "description": "Updates user defined metadata for the specified directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success (OK).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the directory, in quotes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=list": { + "get": { + "tags": [ + "directory" + ], + "operationId": "Directory_ListFilesAndDirectoriesSegment", + "description": "Returns a list of files or directories under the specified share or directory. It lists the contents only for a single level of the directory hierarchy.", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListFilesInclude" + }, + { + "$ref": "#/parameters/ListFilesExtendedInfo" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ListFilesAndDirectoriesSegmentResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{shareName}/{directory}?comp=listhandles": { + "get": { + "tags": [ + "directory" + ], + "operationId": "Directory_ListHandles", + "description": "Lists handles for directory.", + "parameters": [ + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Recursive" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ListHandlesResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "listhandles" + ] + } + ] + }, + "/{shareName}/{directory}?comp=forceclosehandles": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_ForceCloseHandles", + "description": "Closes all handles open for given directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/HandleId" + }, + { + "$ref": "#/parameters/Recursive" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-marker": { + "x-ms-client-name": "marker", + "type": "string", + "description": "A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request." + }, + "x-ms-number-of-handles-closed": { + "x-ms-client-name": "numberOfHandlesClosed", + "type": "integer", + "description": "Contains count of number of handles closed." + }, + "x-ms-number-of-handles-failed": { + "x-ms-client-name": "numberOfHandlesFailedToClose", + "type": "integer", + "description": "Contains count of number of handles that failed to close." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "forceclosehandles" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=rename": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_Rename", + "description": "Renames a directory", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RenameSource" + }, + { + "$ref": "#/parameters/RenameReplaceIfExists" + }, + { + "$ref": "#/parameters/RenameIgnoreReadOnly" + }, + { + "$ref": "#/parameters/SourceLeaseId" + }, + { + "$ref": "#/parameters/DestinationLeaseId" + }, + { + "$ref": "#/parameters/FileCopyFileAttributes" + }, + { + "$ref": "#/parameters/FileCopyFileCreationTime" + }, + { + "$ref": "#/parameters/FileCopyFileLastWriteTime" + }, + { + "$ref": "#/parameters/FileCopyFileChangeTime" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/SourceAllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "rename" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_Create", + "description": "Creates a new file or replaces a file. Note it only initializes the file with no content.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-content-length", + "x-ms-client-name": "fileContentLength", + "in": "header", + "description": "Specifies the maximum size for the file, up to 4 TB.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "$ref": "#/parameters/FileType" + }, + { + "$ref": "#/parameters/FileContentType" + }, + { + "$ref": "#/parameters/FileContentEncoding" + }, + { + "$ref": "#/parameters/FileContentLanguage" + }, + { + "$ref": "#/parameters/FileCacheControl" + }, + { + "$ref": "#/parameters/FileContentMD5" + }, + { + "$ref": "#/parameters/FileContentDisposition" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/FileChangeTime" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success, File created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "file" + ], + "operationId": "File_Download", + "description": "Reads or downloads a file from the system, including its metadata and properties.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/GetRangeContentMD5" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Succeeded to read the entire file.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time." + }, + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs associated with this file as user-defined metadata.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the file. The default content type is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header." + }, + "Content-Encoding": { + "type": "string", + "description": "Returns the value that was specified for the Content-Encoding request header." + }, + "Cache-Control": { + "type": "string", + "description": "Returned if it was previously specified for the file." + }, + "Content-Disposition": { + "type": "string", + "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." + }, + "Content-Language": { + "type": "string", + "description": "Returns the value that was specified for the Content-Language request header." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial file content." + }, + "Date": { + "type": "string", + "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-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by 'x-ms-copy-id'.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-content-md5": { + "x-ms-client-name": "FileContentMD5", + "type": "string", + "format": "byte", + "description": "If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the file.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the file.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "206": { + "description": "Succeeded to read a specified range of the file.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time." + }, + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs associated with this file as user-defined metadata.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the file. The default content type is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header." + }, + "Content-Encoding": { + "type": "string", + "description": "Returns the value that was specified for the Content-Encoding request header." + }, + "Cache-Control": { + "type": "string", + "description": "Returned if it was previously specified for the file." + }, + "Content-Disposition": { + "type": "string", + "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." + }, + "Content-Language": { + "type": "string", + "description": "Returns the value that was specified for the Content-Language request header." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial file content." + }, + "Date": { + "type": "string", + "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-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by 'x-ms-copy-id'.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-content-md5": { + "x-ms-client-name": "FileContentMD5", + "type": "string", + "format": "byte", + "description": "If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the file.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the file.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "head": { + "tags": [ + "file" + ], + "operationId": "File_GetProperties", + "description": "Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It does not return the content of the file.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. The date format follows RFC 1123. Any operation that modifies the file or its properties updates the last modified time." + }, + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs associated with this file as user-defined metadata.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "x-ms-type": { + "x-ms-client-name": "FileType", + "description": "Returns the type File. Reserved for future use.", + "type": "string", + "enum": [ + "File" + ] + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the file. The default content type is 'application/octet-stream'" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the Content-MD5 header has been set for the file, the Content-MD5 response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header." + }, + "Cache-Control": { + "type": "string", + "description": "If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header." + }, + "Content-Disposition": { + "type": "string", + "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." + }, + "Content-Language": { + "type": "string", + "description": "Returns the value that was specified for the Content-Language request header." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by 'x-ms-copy-id'.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the file.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the file.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "file" + ], + "operationId": "File_Delete", + "description": "removes the file from the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "Success (Accepted).", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=properties": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_SetHTTPHeaders", + "description": "Sets HTTP headers on the file.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-content-length", + "x-ms-client-name": "fileContentLength", + "in": "header", + "description": "Resizes a file to the specified size. If the specified byte value is less than the current size of the file, then all ranges above the specified byte value are cleared.", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "$ref": "#/parameters/FileContentType" + }, + { + "$ref": "#/parameters/FileContentEncoding" + }, + { + "$ref": "#/parameters/FileContentLanguage" + }, + { + "$ref": "#/parameters/FileCacheControl" + }, + { + "$ref": "#/parameters/FileContentMD5" + }, + { + "$ref": "#/parameters/FileContentDisposition" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/FileChangeTime" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=metadata": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_SetMetadata", + "description": "Updates user-defined metadata for the specified file.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success (OK).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&acquire": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_AcquireLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "The Acquire operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a file's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&release": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_ReleaseLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The Release operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&change": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_ChangeLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The Change operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a file's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&break": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_BreakLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "The Break operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a file's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=range": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_UploadRange", + "description": "Upload a range of bytes to a file.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/OptionalBody" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "description": "Specifies the range of bytes to be written. Both the start and end of the range must be specified. For an update operation, the range can be up to 4 MB in size. For a clear operation, the range can be up to the value of the file's full size. The File service accepts only a single byte range for the Range and 'x-ms-range' headers, and the byte range must be specified in the following format: bytes=startByte-endByte.", + "required": true, + "type": "string" + }, + { + "name": "x-ms-write", + "x-ms-client-name": "FileRangeWrite", + "in": "header", + "description": "Specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update. - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and set the Range header to a value that indicates the range to clear, up to maximum file size.", + "required": true, + "type": "string", + "enum": [ + "update", + "clear" + ], + "default": "update", + "x-ms-enum": { + "name": "FileRangeWriteType", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileLastWriteTimeMode" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success (Created).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "range" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=range&fromURL": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_UploadRangeFromURL", + "description": "Upload a range of bytes to a file where the contents are read from a URL.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/TargetRange" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/SourceRange" + }, + { + "$ref": "#/parameters/FileRangeWriteFromUrl" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/SourceContentCrc64" + }, + { + "$ref": "#/parameters/SourceIfMatchCrc64" + }, + { + "$ref": "#/parameters/SourceIfNoneMatchCrc64" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + }, + { + "$ref": "#/parameters/FileLastWriteTimeMode" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/SourceAllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success (Created).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "range" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=rangelist": { + "get": { + "tags": [ + "file" + ], + "operationId": "File_GetRangeList", + "description": "Returns the list of valid ranges for a file.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/PrevShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "description": "Specifies the range of bytes over which to list ranges, inclusively.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + }, + { + "$ref": "#/parameters/SupportRename" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "The date/time that the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the file's last modified time." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "x-ms-content-length": { + "x-ms-client-name": "FileContentLength", + "type": "integer", + "format": "int64", + "description": "The size of the file in bytes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ShareFileRangeList" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "rangelist" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=copy": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_StartCopy", + "description": "Copies a blob or file to a destination file within the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileCopyPermissionCopyMode" + }, + { + "$ref": "#/parameters/FileCopyIgnoreReadOnly" + }, + { + "$ref": "#/parameters/FileCopyFileAttributes" + }, + { + "$ref": "#/parameters/FileCopyFileCreationTime" + }, + { + "$ref": "#/parameters/FileCopyFileLastWriteTime" + }, + { + "$ref": "#/parameters/FileCopyFileChangeTime" + }, + { + "$ref": "#/parameters/FileCopySetArchiveAttribute" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/SourceAllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "The copy file has been accepted with the specified copy status.", + "headers": { + "ETag": { + "type": "string", + "description": "If the copy is completed, contains the ETag of the destination file. If the copy is not complete, contains the ETag of the empty file created at the start of the copy." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date/time that the copy operation to the destination file completed." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get File or Get File Properties to check the status of this copy operation, or pass to Abort Copy File to abort a pending copy." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=copy©id": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_AbortCopy", + "description": "Aborts a pending Copy File operation, and leaves a destination file with zero length and full metadata.", + "parameters": [ + { + "$ref": "#/parameters/CopyId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/CopyActionAbort" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "204": { + "description": "The delete request was accepted and the file will be deleted.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "copy" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=listhandles": { + "get": { + "tags": [ + "file" + ], + "operationId": "File_ListHandles", + "description": "Lists handles for file", + "parameters": [ + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ListHandlesResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "listhandles" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=forceclosehandles": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_ForceCloseHandles", + "description": "Closes all handles open for given file", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/HandleId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-marker": { + "x-ms-client-name": "marker", + "type": "string", + "description": "A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request." + }, + "x-ms-number-of-handles-closed": { + "x-ms-client-name": "numberOfHandlesClosed", + "type": "integer", + "description": "Contains count of number of handles closed." + }, + "x-ms-number-of-handles-failed": { + "x-ms-client-name": "numberOfHandlesFailedToClose", + "type": "integer", + "description": "Contains count of number of handles that failed to close." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "forceclosehandles" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=rename": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_Rename", + "description": "Renames a file", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RenameSource" + }, + { + "$ref": "#/parameters/RenameReplaceIfExists" + }, + { + "$ref": "#/parameters/RenameIgnoreReadOnly" + }, + { + "$ref": "#/parameters/SourceLeaseId" + }, + { + "$ref": "#/parameters/DestinationLeaseId" + }, + { + "$ref": "#/parameters/FileCopyFileAttributes" + }, + { + "$ref": "#/parameters/FileCopyFileCreationTime" + }, + { + "$ref": "#/parameters/FileCopyFileLastWriteTime" + }, + { + "$ref": "#/parameters/FileCopyFileChangeTime" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/FileContentType" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/SourceAllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "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-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "rename" + ] + } + ] + } + }, + "definitions": { + "AccessRight": { + "description": "Access rights of the access policy.", + "type": "string", + "enum": [ + "Read", + "Write", + "Delete" + ], + "x-ms-enum": { + "name": "AccessRight", + "modelAsString": false + } + }, + "AccessPolicy": { + "description": "An Access policy.", + "type": "object", + "properties": { + "Start": { + "description": "The date-time the policy is active.", + "type": "string", + "format": "date-time" + }, + "Expiry": { + "description": "The date-time the policy expires.", + "type": "string", + "format": "date-time" + }, + "Permission": { + "description": "The permissions for the ACL policy.", + "type": "string" + } + } + }, + "CorsRule": { + "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain.", + "type": "object", + "required": [ + "AllowedOrigins", + "AllowedMethods", + "AllowedHeaders", + "ExposedHeaders", + "MaxAgeInSeconds" + ], + "properties": { + "AllowedOrigins": { + "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", + "type": "string" + }, + "AllowedMethods": { + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", + "type": "string" + }, + "AllowedHeaders": { + "description": "The request headers that the origin domain may specify on the CORS request.", + "type": "string" + }, + "ExposedHeaders": { + "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.", + "type": "string" + }, + "MaxAgeInSeconds": { + "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", + "type": "integer", + "minimum": 0 + } + } + }, + "ErrorCode": { + "description": "Error codes returned by the service", + "type": "string", + "enum": [ + "AccountAlreadyExists", + "AccountBeingCreated", + "AccountIsDisabled", + "AuthenticationFailed", + "AuthorizationFailure", + "ConditionHeadersNotSupported", + "ConditionNotMet", + "EmptyMetadataKey", + "InsufficientAccountPermissions", + "InternalError", + "InvalidAuthenticationInfo", + "InvalidHeaderValue", + "InvalidHttpVerb", + "InvalidInput", + "InvalidMd5", + "InvalidMetadata", + "InvalidQueryParameterValue", + "InvalidRange", + "InvalidResourceName", + "InvalidUri", + "InvalidXmlDocument", + "InvalidXmlNodeValue", + "Md5Mismatch", + "MetadataTooLarge", + "MissingContentLengthHeader", + "MissingRequiredQueryParameter", + "MissingRequiredHeader", + "MissingRequiredXmlNode", + "MultipleConditionHeadersNotSupported", + "OperationTimedOut", + "OutOfRangeInput", + "OutOfRangeQueryParameterValue", + "RequestBodyTooLarge", + "ResourceTypeMismatch", + "RequestUrlFailedToParse", + "ResourceAlreadyExists", + "ResourceNotFound", + "ServerBusy", + "UnsupportedHeader", + "UnsupportedXmlNode", + "UnsupportedQueryParameter", + "UnsupportedHttpVerb", + "CannotDeleteFileOrDirectory", + "ClientCacheFlushDelay", + "DeletePending", + "DirectoryNotEmpty", + "FileLockConflict", + "InvalidFileOrDirectoryPathName", + "ParentNotFound", + "ReadOnlyAttribute", + "ShareAlreadyExists", + "ShareBeingDeleted", + "ShareDisabled", + "ShareNotFound", + "SharingViolation", + "ShareSnapshotInProgress", + "ShareSnapshotCountExceeded", + "ShareSnapshotOperationNotSupported", + "ShareHasSnapshots", + "PreviousSnapshotNotFound", + "ContainerQuotaDowngradeNotAllowed", + "AuthorizationSourceIPMismatch", + "AuthorizationProtocolMismatch", + "AuthorizationPermissionMismatch", + "AuthorizationServiceMismatch", + "AuthorizationResourceTypeMismatch", + "FeatureVersionMismatch" + ], + "x-ms-enum": { + "name": "StorageErrorCode", + "modelAsString": true + } + }, + "FilesAndDirectoriesListSegment": { + "description": "Abstract for entries that can be listed from Directory.", + "type": "object", + "required": [ + "DirectoryItems", + "FileItems" + ], + "properties": { + "DirectoryItems": { + "type": "array", + "items": { + "$ref": "#/definitions/DirectoryItem" + } + }, + "FileItems": { + "type": "array", + "items": { + "$ref": "#/definitions/FileItem" + } + } + }, + "xml": { + "name": "Entries" + } + }, + "DirectoryItem": { + "xml": { + "name": "Directory" + }, + "description": "A listed directory item.", + "type": "object", + "required": [ + "Name" + ], + "properties": { + "Name": { + "$ref": "#/definitions/StringEncoded" + }, + "FileId": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/FileProperty" + }, + "Attributes": { + "type": "string" + }, + "PermissionKey": { + "type": "string" + } + } + }, + "FileItem": { + "xml": { + "name": "File" + }, + "description": "A listed file item.", + "type": "object", + "required": [ + "Name", + "Properties" + ], + "properties": { + "Name": { + "$ref": "#/definitions/StringEncoded" + }, + "FileId": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/FileProperty" + }, + "Attributes": { + "type": "string" + }, + "PermissionKey": { + "type": "string" + } + } + }, + "StringEncoded": { + "type": "object", + "properties": { + "Encoded": { + "xml": { + "name": "Encoded", + "attribute": true + }, + "type": "boolean" + }, + "content": { + "xml": { + "x-ms-text": true + }, + "type": "string" + } + } + }, + "FileProperty": { + "description": "File properties.", + "type": "object", + "required": [ + "Content-Length" + ], + "properties": { + "Content-Length": { + "description": "Content length of the file. This value may not be up-to-date since an SMB client may have modified the file locally. The value of Content-Length may not reflect that fact until the handle is closed or the op-lock is broken. To retrieve current property values, call Get File Properties.", + "type": "integer", + "format": "int64" + }, + "CreationTime": { + "type": "string", + "format": "date-time" + }, + "LastAccessTime": { + "type": "string", + "format": "date-time" + }, + "LastWriteTime": { + "type": "string", + "format": "date-time" + }, + "ChangeTime": { + "type": "string", + "format": "date-time" + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Etag": { + "type": "string" + } + } + }, + "HandleItem": { + "xml": { + "name": "Handle" + }, + "description": "A listed Azure Storage handle item.", + "type": "object", + "required": [ + "HandleId", + "Path", + "FileId", + "SessionId", + "ClientIp", + "ClientName", + "OpenTime" + ], + "properties": { + "HandleId": { + "type": "string", + "description": "XSMB service handle ID" + }, + "Path": { + "$ref": "#/definitions/StringEncoded" + }, + "FileId": { + "type": "string", + "description": "FileId uniquely identifies the file or directory." + }, + "ParentId": { + "type": "string", + "description": "ParentId uniquely identifies the parent directory of the object." + }, + "SessionId": { + "type": "string", + "description": "SMB session ID in context of which the file handle was opened" + }, + "ClientIp": { + "type": "string", + "description": "Client IP that opened the handle" + }, + "ClientName": { + "type": "string", + "description": "Name of the client machine where the share is being mounted" + }, + "OpenTime": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Time when the session that previously opened the handle has last been reconnected. (UTC)" + }, + "LastReconnectTime": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Time handle was last connected to (UTC)" + }, + "AccessRightList": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessRight" + }, + "xml": { + "wrapped": true + } + } + } + }, + "LeaseDuration": { + "xml": { + "name": "LeaseDuration" + }, + "description": "When a share is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "LeaseState": { + "xml": { + "name": "LeaseState" + }, + "description": "Lease state of the share.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "LeaseStatus": { + "xml": { + "name": "LeaseStatus" + }, + "description": "The current lease status of the share.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "ListFilesAndDirectoriesSegmentResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of directories and files.", + "type": "object", + "required": [ + "ServiceEndpoint", + "ShareName", + "DirectoryPath", + "Prefix", + "NextMarker", + "Segment" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "ShareName": { + "type": "string", + "xml": { + "attribute": true + } + }, + "ShareSnapshot": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Encoded": { + "type": "boolean", + "xml": { + "attribute": true + } + }, + "DirectoryPath": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "$ref": "#/definitions/StringEncoded" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "Segment": { + "$ref": "#/definitions/FilesAndDirectoriesListSegment" + }, + "NextMarker": { + "type": "string" + }, + "DirectoryId": { + "type": "string" + } + } + }, + "ListHandlesResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of handles.", + "type": "object", + "required": [ + "NextMarker" + ], + "properties": { + "HandleList": { + "type": "array", + "items": { + "$ref": "#/definitions/HandleItem" + }, + "xml": { + "name": "Entries", + "wrapped": true + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "ListSharesResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of shares.", + "type": "object", + "required": [ + "ServiceEndpoint", + "NextMarker" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "type": "string" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "ShareItems": { + "type": "array", + "items": { + "$ref": "#/definitions/ShareItemInternal" + }, + "xml": { + "name": "Shares", + "wrapped": true + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "Metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "Metrics": { + "description": "Storage Analytics metrics for file service.", + "required": [ + "Version", + "Enabled" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string" + }, + "Enabled": { + "description": "Indicates whether metrics are enabled for the File service.", + "type": "boolean" + }, + "IncludeAPIs": { + "description": "Indicates whether metrics should generate summary statistics for called API operations.", + "type": "boolean" + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + } + } + }, + "SmbMultichannel": { + "description": "Settings for SMB multichannel", + "type": "object", + "properties": { + "Enabled": { + "type": "boolean", + "description": "If SMB multichannel is enabled." + } + }, + "xml": { + "name": "Multichannel" + } + }, + "FileRange": { + "description": "An Azure Storage file range.", + "type": "object", + "required": [ + "Start", + "End" + ], + "properties": { + "Start": { + "type": "integer", + "format": "int64", + "description": "Start of the range." + }, + "End": { + "type": "integer", + "format": "int64", + "description": "End of the range." + } + }, + "xml": { + "name": "Range" + } + }, + "ClearRange": { + "type": "object", + "required": [ + "Start", + "End" + ], + "properties": { + "Start": { + "type": "integer", + "format": "int64", + "xml": { + "name": "Start" + } + }, + "End": { + "type": "integer", + "format": "int64", + "xml": { + "name": "End" + } + } + }, + "xml": { + "name": "ClearRange" + } + }, + "ShareProtocolSettings": { + "description": "Protocol settings", + "type": "object", + "xml": { + "name": "ProtocolSettings" + }, + "properties": { + "Smb": { + "description": "Settings for SMB protocol.", + "$ref": "#/definitions/ShareSmbSettings" + } + } + }, + "ShareFileRangeList": { + "description": "The list of file ranges", + "type": "object", + "properties": { + "Ranges": { + "type": "array", + "items": { + "$ref": "#/definitions/FileRange" + } + }, + "ClearRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/ClearRange" + } + } + } + }, + "StorageError": { + "type": "object", + "properties": { + "Message": { + "type": "string" + }, + "AuthenticationErrorDetail": { + "type": "string" + } + } + }, + "RetentionPolicy": { + "description": "The retention policy.", + "type": "object", + "required": [ + "Enabled" + ], + "properties": { + "Enabled": { + "description": "Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and the user is responsible for deleting it.", + "type": "boolean" + }, + "Days": { + "description": "Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics data is deleted on a best-effort basis after the retention period expires.", + "type": "integer", + "minimum": 1, + "maximum": 365 + } + } + }, + "ShareItemInternal": { + "xml": { + "name": "Share" + }, + "description": "A listed Azure Storage share item.", + "type": "object", + "required": [ + "Name", + "Properties" + ], + "properties": { + "Name": { + "type": "string" + }, + "Snapshot": { + "type": "string" + }, + "Deleted": { + "type": "boolean" + }, + "Version": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/SharePropertiesInternal" + }, + "Metadata": { + "$ref": "#/definitions/Metadata" + } + } + }, + "SharePropertiesInternal": { + "description": "Properties of a share.", + "type": "object", + "required": [ + "Last-Modified", + "Etag", + "Quota" + ], + "properties": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Etag": { + "type": "string" + }, + "Quota": { + "type": "integer" + }, + "ProvisionedIops": { + "type": "integer" + }, + "ProvisionedIngressMBps": { + "type": "integer" + }, + "ProvisionedEgressMBps": { + "type": "integer" + }, + "ProvisionedBandwidthMiBps": { + "type": "integer" + }, + "NextAllowedQuotaDowngradeTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "DeletedTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "RemainingRetentionDays": { + "type": "integer" + }, + "AccessTier": { + "type": "string" + }, + "AccessTierChangeTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "AccessTierTransitionState": { + "type": "string" + }, + "LeaseStatus": { + "$ref": "#/definitions/LeaseStatus" + }, + "LeaseState": { + "$ref": "#/definitions/LeaseState" + }, + "LeaseDuration": { + "$ref": "#/definitions/LeaseDuration" + }, + "EnabledProtocols": { + "$ref": "#/definitions/ShareEnabledProtocols" + }, + "RootSquash": { + "$ref": "#/definitions/ShareRootSquash" + }, + "EnableSnapshotVirtualDirectoryAccess": { + "type": "boolean" + } + } + }, + "ShareStats": { + "description": "Stats for the share.", + "type": "object", + "required": [ + "ShareUsageBytes" + ], + "properties": { + "ShareUsageBytes": { + "description": "The approximate size of the data stored in bytes. Note that this value may not include all recently created or recently resized files.", + "type": "integer" + } + } + }, + "SignedIdentifier": { + "description": "Signed identifier.", + "type": "object", + "required": [ + "Id" + ], + "properties": { + "Id": { + "type": "string", + "description": "A unique id." + }, + "AccessPolicy": { + "description": "The access policy.", + "$ref": "#/definitions/AccessPolicy" + } + } + }, + "SignedIdentifiers": { + "description": "A collection of signed identifiers.", + "type": "array", + "items": { + "$ref": "#/definitions/SignedIdentifier", + "xml": { + "name": "SignedIdentifier" + } + }, + "xml": { + "wrapped": true, + "name": "SignedIdentifiers" + } + }, + "ShareSmbSettings": { + "description": "Settings for SMB protocol.", + "type": "object", + "xml": { + "name": "SMB" + }, + "properties": { + "Multichannel": { + "description": "Settings for SMB Multichannel.", + "$ref": "#/definitions/SmbMultichannel" + } + } + }, + "StorageServiceProperties": { + "description": "Storage service properties.", + "type": "object", + "properties": { + "HourMetrics": { + "description": "A summary of request statistics grouped by API in hourly aggregates for files.", + "$ref": "#/definitions/Metrics" + }, + "MinuteMetrics": { + "description": "A summary of request statistics grouped by API in minute aggregates for files.", + "$ref": "#/definitions/Metrics" + }, + "Cors": { + "description": "The set of CORS rules.", + "type": "array", + "items": { + "$ref": "#/definitions/CorsRule" + }, + "xml": { + "wrapped": true + } + }, + "Protocol": { + "description": "Protocol settings", + "$ref": "#/definitions/ShareProtocolSettings" + } + } + }, + "SharePermission": { + "description": "A permission (a security descriptor) at the share level.", + "type": "object", + "required": [ + "permission" + ], + "properties": { + "permission": { + "type": "string", + "description": "The permission in the Security Descriptor Definition Language (SDDL)." + } + } + }, + "ShareEnabledProtocols": { + "type": "string" + }, + "ShareRootSquash": { + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false + } + } + }, + "parameters": { + "AccessTierOptional": { + "name": "x-ms-access-tier", + "x-ms-client-name": "accessTier", + "in": "header", + "description": "Specifies the access tier of the share.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "enum": [ + "TransactionOptimized", + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "ShareAccessTier", + "modelAsString": true + } + }, + "ApiVersionParameter": { + "name": "x-ms-version", + "x-ms-client-name": "version", + "x-ms-parameter-location": "client", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "enum": [ + "2024-08-04" + ] + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "requestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "ContentLength": { + "name": "Content-Length", + "x-ms-client-name": "contentLength", + "in": "header", + "description": "Specifies the number of bytes being transmitted in the request body. When the x-ms-write header is set to clear, the value of this header must be set to zero.", + "required": true, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method" + }, + "ContentMD5": { + "name": "Content-MD5", + "x-ms-client-name": "contentMD5", + "in": "header", + "description": "An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request).", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method" + }, + "CopyActionAbort": { + "name": "x-ms-copy-action", + "x-ms-client-name": "copyActionAbortConstant", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "abort" + ], + "x-ms-parameter-location": "method", + "description": "Abort." + }, + "CopyId": { + "name": "copyid", + "x-ms-client-name": "copyId", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The copy identifier provided in the x-ms-copy-id header of the original Copy File operation." + }, + "CopySource": { + "name": "x-ms-copy-source", + "x-ms-client-name": "copySource", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file to another file within the same storage account, you may use Shared Key to authenticate the source file. If you are copying a file from another storage account, or if you are copying a blob from the same storage account or another storage account, then you must authenticate the source file or blob using a shared access signature. If the source is a public blob, no authentication is required to perform the copy operation. A file in a share snapshot can also be specified as a copy source." + }, + "CopySourceAuthorization": { + "name": "x-ms-copy-source-authorization", + "x-ms-client-name": "copySourceAuthorization", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source." + }, + "FileCopyPermissionCopyMode": { + "name": "x-ms-file-permission-copy-mode", + "x-ms-client-name": "filePermissionCopyMode", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "source", + "override" + ], + "x-ms-enum": { + "name": "PermissionCopyModeType", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key." + }, + "FileCopyIgnoreReadOnly": { + "name": "x-ms-file-copy-ignore-readonly", + "x-ms-client-name": "ignoreReadOnly", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies the option to overwrite the target file if it already exists and has read-only attribute set." + }, + "FileCopyFileAttributes": { + "name": "x-ms-file-attributes", + "x-ms-client-name": "fileAttributes", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file attributes from a source file(source) to a target file or a list of attributes to set on a target file." + }, + "FileCopyFileCreationTime": { + "name": "x-ms-file-creation-time", + "x-ms-client-name": "fileCreationTime", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file creation time from a source file(source) to a target file or a time value in ISO 8601 format to set as creation time on a target file." + }, + "FileCopyFileLastWriteTime": { + "name": "x-ms-file-last-write-time", + "x-ms-client-name": "fileLastWriteTime", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file." + }, + "FileCopyFileChangeTime": { + "name": "x-ms-file-change-time", + "x-ms-client-name": "fileChangeTime", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file." + }, + "FileCopySetArchiveAttribute": { + "name": "x-ms-file-copy-set-archive", + "x-ms-client-name": "setArchiveAttribute", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies the option to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state." + }, + "DeletedShareName": { + "name": "x-ms-deleted-share-name", + "x-ms-client-name": "DeletedShareName", + "description": "Specifies the name of the previously-deleted share.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DirectoryPath": { + "name": "directory", + "in": "path", + "description": "The path of the target directory.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": false + }, + "FilePath": { + "name": "fileName", + "in": "path", + "description": "The path of the target file.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": false + }, + "ShareName": { + "name": "shareName", + "in": "path", + "description": "The name of the target share.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeletedShareVersion": { + "name": "x-ms-deleted-share-version", + "x-ms-client-name": "DeletedShareVersion", + "description": "Specifies the version of the previously-deleted share.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeleteSnapshots": { + "name": "x-ms-delete-snapshots", + "x-ms-client-name": "deleteSnapshots", + "description": "Specifies the option include to delete the base share and all of its snapshots.", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "include", + "include-leased" + ], + "x-ms-enum": { + "name": "DeleteSnapshotsOptionType", + "modelAsString": false + }, + "x-ms-parameter-location": "method" + }, + "DestinationLeaseId": { + "name": "x-ms-destination-lease-id", + "x-ms-client-name": "destinationLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "destination-lease-access-conditions" + }, + "description": "Required if the destination file has an active infinite lease. The lease ID specified for this header must match the lease ID of the destination file. If the request does not include the lease ID or it is not valid, the operation fails with status code 412 (Precondition Failed). If this header is specified and the destination file does not currently have an active lease, the operation will also fail with status code 412 (Precondition Failed)." + }, + "EnableSnapshotVirtualDirectoryAccess": { + "name": "x-ms-enable-snapshot-virtual-directory-access", + "x-ms-client-name": "enableSnapshotVirtualDirectoryAccess", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "FileAttributes": { + "name": "x-ms-file-attributes", + "x-ms-client-name": "FileAttributes", + "in": "header", + "description": "If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FileCacheControl": { + "name": "x-ms-cache-control", + "x-ms-client-name": "fileCacheControl", + "description": "Sets the file's cache control. The File service stores this value but does not use or modify it.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentDisposition": { + "name": "x-ms-content-disposition", + "x-ms-client-name": "fileContentDisposition", + "description": "Sets the file's Content-Disposition header.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentEncoding": { + "name": "x-ms-content-encoding", + "x-ms-client-name": "fileContentEncoding", + "in": "header", + "description": "Specifies which content encodings have been applied to the file.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentLanguage": { + "name": "x-ms-content-language", + "x-ms-client-name": "fileContentLanguage", + "in": "header", + "description": "Specifies the natural languages used by this resource.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentMD5": { + "name": "x-ms-content-md5", + "x-ms-client-name": "fileContentMD5", + "in": "header", + "description": "Sets the file's MD5 hash.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentType": { + "name": "x-ms-content-type", + "x-ms-client-name": "fileContentType", + "in": "header", + "description": "Sets the MIME content type of the file. The default type is 'application/octet-stream'.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileCreationTime": { + "name": "x-ms-file-creation-time", + "x-ms-client-name": "FileCreationTime", + "in": "header", + "description": "Creation time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method" + }, + "FileLastWriteTime": { + "name": "x-ms-file-last-write-time", + "x-ms-client-name": "FileLastWriteTime", + "in": "header", + "description": "Last write time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method" + }, + "FileChangeTime": { + "name": "x-ms-file-change-time", + "x-ms-client-name": "FileChangeTime", + "in": "header", + "description": "Change time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method" + }, + "FileLastWriteTimeMode": { + "name": "x-ms-file-last-write-time", + "x-ms-client-name": "FileLastWrittenMode", + "in": "header", + "description": "If the file last write time should be preserved or overwritten", + "required": false, + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Now", + "Preserve" + ], + "x-ms-enum": { + "name": "FileLastWrittenMode", + "modelAsString": false + } + }, + "FilePermission": { + "name": "x-ms-file-permission", + "x-ms-client-name": "FilePermission", + "in": "header", + "description": "If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FilePermissionKey": { + "name": "x-ms-file-permission-key", + "x-ms-client-name": "FilePermissionKey", + "in": "header", + "description": "Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FilePermissionKeyRequired": { + "name": "x-ms-file-permission-key", + "x-ms-client-name": "FilePermissionKey", + "in": "header", + "description": "Key of the permission to be set for the directory/file.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FileRangeWriteFromUrl": { + "name": "x-ms-write", + "x-ms-parameter-location": "client", + "x-ms-client-name": "fileRangeWriteFromUrl", + "in": "header", + "description": "Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range.", + "required": true, + "type": "string", + "enum": [ + "update" + ], + "default": "update", + "x-ms-enum": { + "name": "FileRangeWriteFromUrlType", + "modelAsString": false + } + }, + "FileRequestIntent": { + "name": "x-ms-file-request-intent", + "x-ms-client-name": "fileRequestIntent", + "in": "header", + "description": "Valid value is backup", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true + } + }, + "SupportRename": { + "name": "x-ms-file-support-rename", + "x-ms-client-name": "SupportRename", + "in": "header", + "required": false, + "type": "boolean", + "description": "This header is allowed only when PrevShareSnapshot query parameter is set. Determines whether the changed ranges for a file that has been renamed or moved between the target snapshot (or the live file) and the previous snapshot should be listed. If the value is true, the valid changed ranges for the file will be returned. If the value is false, the operation will result in a failure with 409 (Conflict) response. The default value is false.", + "x-ms-parameter-location": "method" + }, + "FileType": { + "name": "x-ms-type", + "x-ms-client-name": "fileTypeConstant", + "in": "header", + "required": true, + "description": "Dummy constant parameter, file type can only be file.", + "type": "string", + "enum": [ + "file" + ], + "x-ms-parameter-location": "method" + }, + "GetRangeContentMD5": { + "name": "x-ms-range-get-content-md5", + "x-ms-client-name": "rangeGetContentMD5", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size." + }, + "HandleId": { + "name": "x-ms-handle-id", + "x-ms-client-name": "handleId", + "in": "header", + "description": "Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is a wildcard that specifies all handles.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "LeaseBreakPeriod": { + "name": "x-ms-lease-break-period", + "x-ms-client-name": "breakPeriod", + "in": "header", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method", + "description": "For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately." + }, + "LeaseDuration": { + "name": "x-ms-lease-duration", + "x-ms-client-name": "duration", + "in": "header", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method", + "description": "Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change." + }, + "LeaseIdOptional": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "lease-access-conditions" + }, + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID." + }, + "LeaseIdRequired": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the current lease ID on the resource." + }, + "ListFilesInclude": { + "name": "include", + "in": "query", + "description": "Include this parameter to specify one or more datasets to include in the response.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "Timestamps", + "Etag", + "Attributes", + "PermissionKey" + ], + "x-ms-enum": { + "name": "ListFilesIncludeType", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method" + }, + "ListFilesExtendedInfo": { + "name": "x-ms-file-extended-info", + "x-ms-client-name": "includeExtendedInfo", + "x-ms-parameter-location": "method", + "in": "header", + "type": "boolean", + "required": false, + "description": "Include extended information." + }, + "ListSharesInclude": { + "name": "include", + "in": "query", + "description": "Include this parameter to specify one or more datasets to include in the response.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "snapshots", + "metadata", + "deleted" + ], + "x-ms-enum": { + "name": "ListSharesIncludeType", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method" + }, + "Marker": { + "name": "marker", + "in": "query", + "description": "A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MaxResults": { + "name": "maxresults", + "in": "query", + "description": "Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items.", + "required": false, + "type": "integer", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "Metadata": { + "name": "x-ms-meta", + "x-ms-client-name": "metadata", + "in": "header", + "description": "A name-value pair to associate with a file storage object.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "OptionalBody": { + "name": "optionalbody", + "in": "body", + "description": "Initial data.", + "required": false, + "schema": { + "type": "object", + "format": "file" + }, + "x-ms-parameter-location": "method" + }, + "Prefix": { + "name": "prefix", + "in": "query", + "description": "Filters the results to return only entries whose name begins with the specified prefix.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrevShareSnapshot": { + "name": "prevsharesnapshot", + "in": "query", + "description": "The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ProposedLeaseIdOptional": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "ProposedLeaseIdRequired": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "Range": { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "description": "Return file data only from the specified byte range.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Recursive": { + "name": "x-ms-recursive", + "x-ms-client-name": "recursive", + "in": "header", + "description": "Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "RenameIgnoreReadOnly": { + "name": "x-ms-file-rename-ignore-readonly", + "x-ms-client-name": "ignoreReadOnly", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail." + }, + "RenameReplaceIfExists": { + "name": "x-ms-file-rename-replace-if-exists", + "x-ms-client-name": "replaceIfExists", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value." + }, + "RenameSource": { + "name": "x-ms-file-rename-source", + "x-ms-client-name": "renameSource", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Required. Specifies the URI-style path of the source file, up to 2 KB in length." + }, + "Url": { + "name": "url", + "x-ms-parameter-location": "client", + "in": "path", + "description": "The URL of the service account, share, directory or file that is the target of the desired operation.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + "ShareAcl": { + "name": "shareAcl", + "in": "body", + "description": "The ACL for the share.", + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + }, + "x-ms-parameter-location": "method" + }, + "ShareQuota": { + "name": "x-ms-share-quota", + "x-ms-client-name": "quota", + "in": "header", + "description": "Specifies the maximum size of the share, in gigabytes.", + "required": false, + "type": "integer", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "ShareSnapshot": { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SourceContentCrc64": { + "name": "x-ms-source-content-crc64", + "x-ms-client-name": "sourceContentCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the crc64 calculated for the range of bytes that must be read from the copy source." + }, + "SourceIfMatchCrc64": { + "name": "x-ms-source-if-match-crc64", + "x-ms-client-name": "sourceIfMatchCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify the crc64 value to operate only on range with a matching crc64 checksum." + }, + "SourceIfNoneMatchCrc64": { + "name": "x-ms-source-if-none-match-crc64", + "x-ms-client-name": "sourceIfNoneMatchCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify the crc64 value to operate only on range without a matching crc64 checksum." + }, + "SourceLeaseId": { + "name": "x-ms-source-lease-id", + "x-ms-client-name": "sourceLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-lease-access-conditions" + }, + "description": "Required if the source file has an active infinite lease." + }, + "SourceRange": { + "name": "x-ms-source-range", + "x-ms-client-name": "sourceRange", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Bytes of source data in the specified range." + }, + "StorageServiceProperties": { + "name": "StorageServiceProperties", + "in": "body", + "description": "The StorageService properties.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + }, + "x-ms-parameter-location": "method" + }, + "TargetRange": { + "name": "x-ms-range", + "x-ms-client-name": "Range", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Writes data to the specified byte range in the file." + }, + "Timeout": { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.", + "required": false, + "type": "integer", + "minimum": 0, + "x-ms-parameter-location": "method" + }, + "SharePermission": { + "name": "sharePermission", + "in": "body", + "description": "A permission (a security descriptor) at the share level.", + "required": true, + "schema": { + "$ref": "#/definitions/SharePermission" + }, + "x-ms-parameter-location": "method" + }, + "ShareEnabledProtocols": { + "name": "x-ms-enabled-protocols", + "description": "Protocols to enable on the share.", + "x-ms-client-name": "enabledProtocols", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ShareRootSquash": { + "name": "x-ms-root-squash", + "description": "Root squash to set on the share. Only valid for NFS shares.", + "x-ms-client-name": "rootSquash", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false + }, + "x-ms-parameter-location": "method" + }, + "AllowTrailingDot": { + "name": "x-ms-allow-trailing-dot", + "description": "If true, the trailing dot will not be trimmed from the target URI.", + "x-ms-client-name": "allowTrailingDot", + "in": "header", + "required": false, + "type": "boolean" + }, + "SourceAllowTrailingDot": { + "name": "x-ms-source-allow-trailing-dot", + "description": "If true, the trailing dot will not be trimmed from the source URI.", + "x-ms-client-name": "allowSourceTrailingDot", + "in": "header", + "required": false, + "type": "boolean" + } + } +} From 09c187c9589a143a477ed02c6639e914a4818179 Mon Sep 17 00:00:00 2001 From: Tricia Rosario Date: Tue, 4 Jun 2024 20:39:42 -0700 Subject: [PATCH 37/49] Storage Task Assignment Swagger Updates (#29050) * SDK team improvements * Report APIs contain filtering * PR comment add more examples * Fix example path * Fix duplicate schema issue --------- Co-authored-by: Tricia Rosario --- .../stable/2023-05-01/common.json | 2 +- ...orageTaskAssignmentRequiredProperties.json | 82 +++++++++++++++++++ .../2023-05-01/storageTaskAssignments.json | 44 +++------- 3 files changed, 93 insertions(+), 35 deletions(-) create mode 100644 specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/storageTaskAssignmentsCrud/PutStorageTaskAssignmentRequiredProperties.json diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/common.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/common.json index 82d76dbfcc6c..e4ffa0c6e532 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/common.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/common.json @@ -237,7 +237,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Storage Tasks run report instance" diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/storageTaskAssignmentsCrud/PutStorageTaskAssignmentRequiredProperties.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/storageTaskAssignmentsCrud/PutStorageTaskAssignmentRequiredProperties.json new file mode 100644 index 000000000000..b0f5f81e611b --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/storageTaskAssignmentsCrud/PutStorageTaskAssignmentRequiredProperties.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "1f31ba14-ce16-4281-b9b4-3e78da6e1616", + "resourceGroupName": "res4228", + "accountName": "sto4445", + "storageTaskAssignmentName": "myassignment1", + "api-version": "2023-05-01", + "parameters": { + "properties": { + "taskId": "/subscriptions/1f31ba14-ce16-4281-b9b4-3e78da6e1616/resourceGroups/res4228/providers/Microsoft.StorageActions/storageTasks/mytask1", + "enabled": true, + "description": "My Storage task assignment", + "executionContext": { + "trigger": { + "type": "RunOnce", + "parameters": { + "startOn": "2022-11-15T21:52:47.8145095Z" + } + } + }, + "report": { + "prefix": "container1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1f31ba14-ce16-4281-b9b4-3e78da6e1616/resourceGroups/res4228/providers/Microsoft.Storage/storageAccounts/sto4445/storageTaskAssignments/myassignment1", + "name": "myassignment1", + "type": "Microsoft.Storage/storageAccounts/storageTaskAssignments", + "properties": { + "taskId": "/subscriptions/1f31ba14-ce16-4281-b9b4-3e78da6e1616/resourceGroups/res4228/providers/Microsoft.StorageActions/storageTasks/mytask1", + "enabled": true, + "description": "My Storage task assignment", + "executionContext": { + "trigger": { + "type": "RunOnce", + "parameters": { + "startOn": "2022-11-15T21:52:47.8145095Z" + } + } + }, + "report": { + "prefix": "container1" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/1f31ba14-ce16-4281-b9b4-3e78da6e1616/resourceGroups/res4228/providers/Microsoft.Storage/storageAccounts/sto4445/storageTaskAssignments/myassignment1", + "name": "myassignment1", + "type": "Microsoft.Storage/storageAccounts/storageTaskAssignments", + "properties": { + "taskId": "/subscriptions/1f31ba14-ce16-4281-b9b4-3e78da6e1616/resourceGroups/res4228/providers/Microsoft.StorageActions/storageTasks/mytask1", + "enabled": true, + "description": "My Storage task assignment", + "executionContext": { + "trigger": { + "type": "RunOnce", + "parameters": { + "startOn": "2022-11-15T21:52:47.8145095Z" + } + } + }, + "report": { + "prefix": "container1" + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9101/providers/Microsoft.Storage/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json index a96f4a030650..1f6ee88b81b9 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json @@ -26,6 +26,9 @@ "x-ms-examples": { "PutStorageTaskAssignment": { "$ref": "./examples/storageTaskAssignmentsCrud/PutStorageTaskAssignment.json" + }, + "PutStorageTaskAssignmentRequiredProperties": { + "$ref": "./examples/storageTaskAssignmentsCrud/PutStorageTaskAssignmentRequiredProperties.json" } }, "parameters": [ @@ -275,12 +278,6 @@ "type": "string", "description": "Optional, specifies the maximum number of storage task assignment Ids to be included in the list response." }, - { - "name": "$filter", - "in": "query", - "type": "string", - "description": "Optional. When specified, it can be used to query using reporting properties." - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } @@ -336,7 +333,7 @@ "name": "$filter", "in": "query", "type": "string", - "description": "Optional. When specified, it can be used to query using reporting properties." + "description": "Optional. When specified, it can be used to query using reporting properties. See [Constructing Filter Strings](https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#constructing-filter-strings) for details." }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" @@ -396,7 +393,7 @@ "name": "$filter", "in": "query", "type": "string", - "description": "Optional. When specified, it can be used to query using reporting properties." + "description": "Optional. When specified, it can be used to query using reporting properties. See [Constructing Filter Strings](https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#constructing-filter-strings) for details." }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" @@ -433,9 +430,12 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" } ], + "required": [ + "properties" + ], "description": "The storage task assignment." }, "StorageTaskAssignmentProperties": { @@ -507,7 +507,6 @@ } }, "required": [ - "target", "trigger" ], "description": "Execution context of the storage task assignment." @@ -530,9 +529,6 @@ "description": "List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor" } }, - "required": [ - "prefix" - ], "description": "Target helps provide filter parameters for the objects in the storage account and forms the execution context for the storage task" }, "ExecutionTrigger": { @@ -675,7 +671,7 @@ "type": "object", "properties": { "target": { - "$ref": "#/definitions/ExecutionTargetUpdate", + "$ref": "#/definitions/ExecutionTarget", "description": "Execution target of the storage task assignment" }, "trigger": { @@ -685,26 +681,6 @@ }, "description": "Execution context of the storage task assignment update." }, - "ExecutionTargetUpdate": { - "type": "object", - "properties": { - "prefix": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of object prefixes to be included for task execution" - }, - "excludePrefix": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor" - } - }, - "description": "Target helps provide filter parameters for the objects in the storage account and forms the execution context for the storage task" - }, "ExecutionTriggerUpdate": { "type": "object", "properties": { From ceb3b7f6f6f46d2c158e072cee394a778b2110b8 Mon Sep 17 00:00:00 2001 From: jaclin1111 Date: Tue, 4 Jun 2024 20:41:22 -0700 Subject: [PATCH 38/49] Update virtualMachine.json (#29112) remove "feature in preview" Co-authored-by: Theodore Chang --- .../ComputeRP/stable/2024-03-01/virtualMachine.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachine.json index 673adb34b9e2..2b8db8b31876 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachine.json +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachine.json @@ -1046,7 +1046,7 @@ "in": "query", "required": false, "type": "boolean", - "description": "Optional parameter to hibernate a virtual machine. (Feature in Preview)" + "description": "Optional parameter to hibernate a virtual machine." }, { "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" From 32f566eb38af9593cfc1ed183362471c50d67fb2 Mon Sep 17 00:00:00 2001 From: Samir Solanki Date: Tue, 4 Jun 2024 20:42:48 -0700 Subject: [PATCH 39/49] Merge release api management 2023 09 01 preview - Active (#29184) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Adds base for updating Microsoft.ApiManagement from version preview/2023-05-01-preview to version 2023-09-01-preview * Updates readme * Updates API version in new specs and examples * feat(apim): Introduce gateway resource (#27757) * WIP * Update sample * WIP * Add GatewayNameParameter * Clean up * Update sample * Add another sample * Add sample for delete gateway * Remove endpoints * Fix typo * Add list sample * Clean up Signed-off-by: Tom Kerkhove * Add disclaimer Signed-off-by: Tom Kerkhove * Make it pretty 💄 Signed-off-by: Tom Kerkhove * Refer to new file Signed-off-by: Tom Kerkhove * Add missing ApiManagementGatewayListResult Signed-off-by: Tom Kerkhove * Update sample reference Signed-off-by: Tom Kerkhove * Remove ApiManagementGatewayIdentity + List by operation Signed-off-by: Tom Kerkhove * Add more sample Signed-off-by: Tom Kerkhove * Latest version of common types Signed-off-by: Tom Kerkhove * Remove 200 for delete Signed-off-by: Tom Kerkhove * Formatting and re-order Signed-off-by: Tom Kerkhove * Align with spec Signed-off-by: Tom Kerkhove * Align sample with spec Signed-off-by: Tom Kerkhove * Error response from common types Signed-off-by: Tom Kerkhove * Rename SKU name * Have seperate SKU for patch to not make it mandatory * Remove empty required * Improve note * Rename schema * Remove unused type * sku.capacity should not be required --------- Signed-off-by: Tom Kerkhove * Add loggers, diagnostics, certificates and backends to workspace (#27262) * Add loggers to workspaces * Add diagnostics to workspace * Add certificates to workspace * Add backends to workspaces * Change DiagnosticContract to DiagnosticContractProperties in patch * Revert back DiagnosticContractProperties to DiagnosticContract * Fix CI and add files to readme * Fix example * remove reconnect endpoint * Add suppressions * Try different suppression where * Try different suppression * Try other suppression * another test * finally working suppression * remove unwanted line * remove secret examples (#28409) * Modify CircuitBreaker and BackendPool Contract (#28397) * md cb contract * modify pool contract * correct the limits --------- Co-authored-by: Samir Solanki * Common Error Response (#28408) * add operation statuses resource (#28591) * add operation statuses resource * fix api-version * Add locations/operationsResults endpoint for DELETE workflow (#28808) * add operation results * fix spec * operationresults * fix file name * feat(Workspace): Add new SkuType for Workspace (#28903) * new skutype * virtualNetworkType * remove default from patch * List skus API * add model for sku * caps enums * feat)Gateway): Adding gateway config resource (#28478) * added gateway config resource * removing Head gateway Config call * updates * resolving errors * trying to resolve more model validations * resolving some model validations * resolving model validations * resoloving delete example errors * Swagger Prettier * prettier * updating so patch has same response as get and put * removing path for gateway config * addressing comment * addressing comments * nit * path updatess * updating as per comments * Adding workspaceLinks * resolving some of the errors * resolved some errors * resolving some of the errors * resolving some more errors * npx prettier * addressing comments * updated based on comments * lint updates * nit updates --------- Co-authored-by: Samir Solanki * Fix generation errors (#29207) * fix(apim): Remove duplicate ErrorResponse schema due to move to common schema * Gateway -> ApiGateway to prevent SDK collision with self-hosted gateway * Revert "Gateway -> ApiGateway to prevent SDK collision with self-hosted gateway" This reverts commit 8d4753d36664ef91e2c4f605e422a99a5dd4854d. * Remove ApiManagement Prefix for GatewayConfigConnections * Revert "Remove ApiManagement Prefix for GatewayConfigConnections" This reverts commit 3e8197fb1845795ad97b1e6975f0495a0dca1295. * Gateway -> ApiGateway to prevent SDK collision with self-hosted gateway * Create sdk-suppressions.yaml --------- Signed-off-by: Tom Kerkhove Co-authored-by: Tom Kerkhove Co-authored-by: Rafał Mielowski Co-authored-by: Mahsa Sadi Co-authored-by: Vidisha Shah <102258037+vidishamsft@users.noreply.github.com> Co-authored-by: Yuchao Yan --- .../2023-09-01-preview/apigateway.json | 836 ++ .../2023-09-01-preview/apimallpolicies.json | 85 + .../2023-09-01-preview/apimanagement.json | 948 ++ .../preview/2023-09-01-preview/apimapis.json | 5564 ++++++++++ .../2023-09-01-preview/apimapisByTags.json | 106 + .../apimapiversionsets.json | 376 + .../apimauthorizationproviders.json | 901 ++ .../apimauthorizationservers.json | 427 + .../2023-09-01-preview/apimbackends.json | 430 + .../2023-09-01-preview/apimcaches.json | 372 + .../2023-09-01-preview/apimcertificates.json | 387 + .../apimconnectivitycheck.json | 104 + .../2023-09-01-preview/apimcontenttypes.json | 531 + .../apimdeletedservices.json | 184 + .../2023-09-01-preview/apimdeployment.json | 2172 ++++ .../2023-09-01-preview/apimdiagnostics.json | 376 + .../apimdocumentations.json | 376 + .../apimemailtemplates.json | 363 + .../apimgatewayConfigConnections.json | 337 + .../2023-09-01-preview/apimgateways.json | 1475 +++ .../2023-09-01-preview/apimgroups.json | 590 + .../apimidentityprovider.json | 416 + .../2023-09-01-preview/apimissues.json | 150 + .../2023-09-01-preview/apimloggers.json | 382 + .../2023-09-01-preview/apimnamedvalues.json | 548 + .../2023-09-01-preview/apimnetworkstatus.json | 226 + .../2023-09-01-preview/apimnotifications.json | 564 + .../apimopenidconnectproviders.json | 427 + .../apimoutbounddependency.json | 161 + .../2023-09-01-preview/apimpolicies.json | 307 + .../apimpolicydescriptions.json | 100 + .../apimpolicyfragments.json | 398 + .../apimpolicyrestrictions.json | 362 + .../apimpolicyrestrictionsvalidation.json | 95 + .../2023-09-01-preview/apimportalconfigs.json | 291 + .../apimportalrevisions.json | 341 + .../apimportalsettings.json | 713 ++ .../2023-09-01-preview/apimprivatelink.json | 347 + .../2023-09-01-preview/apimproducts.json | 2202 ++++ .../apimproductsByTags.json | 106 + .../2023-09-01-preview/apimquotas.json | 248 + .../2023-09-01-preview/apimregions.json | 85 + .../2023-09-01-preview/apimreports.json | 562 + .../2023-09-01-preview/apimschema.json | 344 + .../2023-09-01-preview/apimsettings.json | 146 + .../preview/2023-09-01-preview/apimskus.json | 391 + .../2023-09-01-preview/apimsubscriptions.json | 523 + .../2023-09-01-preview/apimtagresources.json | 99 + .../preview/2023-09-01-preview/apimtags.json | 1052 ++ .../2023-09-01-preview/apimtenant.json | 785 ++ .../preview/2023-09-01-preview/apimusers.json | 792 ++ .../apimworkspacebackends.json | 397 + .../apimworkspacecertificates.json | 405 + .../apimworkspacediagnostics.json | 766 ++ .../apimworkspacelinks.json | 129 + .../apimworkspaceloggers.json | 400 + .../2023-09-01-preview/apimworkspaces.json | 8367 +++++++++++++++ .../2023-09-01-preview/definitions.json | 9459 +++++++++++++++++ .../examples/ApiManagementAllPolicies.json | 26 + ...ementApplyNetworkConfigurationUpdates.json | 53 + ...roveOrRejectPrivateEndpointConnection.json | 42 + ...agementAuthorizationServerListSecrets.json | 18 + .../ApiManagementBackendReconnect.json | 17 + .../ApiManagementBackupWithAccessKey.json | 138 + ...gementBackupWithSystemManagedIdentity.json | 97 + ...BackupWithUserAssignedManagedIdentity.json | 98 + .../examples/ApiManagementCreateAILogger.json | 51 + .../examples/ApiManagementCreateApi.json | 115 + .../examples/ApiManagementCreateApiClone.json | 84 + .../ApiManagementCreateApiDiagnostic.json | 160 + .../examples/ApiManagementCreateApiIssue.json | 49 + ...ApiManagementCreateApiIssueAttachment.json | 44 + .../ApiManagementCreateApiIssueComment.json | 44 + ...ntCreateApiNewVersionUsingExistingApi.json | 100 + .../ApiManagementCreateApiOperation.json | 130 + ...ApiManagementCreateApiOperationPolicy.json | 40 + .../ApiManagementCreateApiOperationTag.json | 33 + .../ApiManagementCreateApiPolicy.json | 39 + ...anagementCreateApiPolicyNonXmlEncoded.json | 39 + .../ApiManagementCreateApiRelease.json | 44 + ...ementCreateApiRevisionFromExistingApi.json | 73 + .../ApiManagementCreateApiSchema.json | 56 + .../examples/ApiManagementCreateApiTag.json | 32 + .../ApiManagementCreateApiTagDescription.json | 47 + ...reateApiUsingImportOverrideServiceUrl.json | 73 + ...ApiManagementCreateApiUsingOai3Import.json | 70 + ...anslateRequiredQueryParametersConduct.json | 71 + ...ManagementCreateApiUsingSwaggerImport.json | 72 + ...ApiManagementCreateApiUsingWadlImport.json | 72 + .../ApiManagementCreateApiVersionSet.json | 42 + .../examples/ApiManagementCreateApiWiki.json | 57 + ...ementCreateApiWithMultipleAuthServers.json | 113 + ...ApiWithMultipleOpenIdConnectProviders.json | 123 + ...iManagementCreateApiWithOpenIdConnect.json | 104 + ...agementCreateAuthorizationAADAuthCode.json | 50 + ...ementCreateAuthorizationAADClientCred.json | 52 + ...gementCreateAuthorizationAccessPolicy.json | 50 + ...reateAuthorizationProviderAADAuthCode.json | 74 + ...ateAuthorizationProviderAADClientCred.json | 70 + ...ateAuthorizationProviderGenericOAuth2.json | 76 + ...tCreateAuthorizationProviderOOBGoogle.json | 67 + ...piManagementCreateAuthorizationServer.json | 100 + ...piManagementCreateBackendProxyBackend.json | 126 + ...iManagementCreateBackendServiceFabric.json | 87 + .../examples/ApiManagementCreateCache.json | 45 + .../ApiManagementCreateCertificate.json | 41 + ...nagementCreateCertificateWithKeyVault.json | 59 + .../ApiManagementCreateContentType.json | 177 + ...anagementCreateContentTypeContentItem.json | 55 + .../ApiManagementCreateDiagnostic.json | 159 + .../ApiManagementCreateDocumentation.json | 39 + .../examples/ApiManagementCreateEHLogger.json | 51 + .../examples/ApiManagementCreateGateway.json | 45 + .../ApiManagementCreateGatewayApi.json | 61 + ...mentCreateGatewayCertificateAuthority.json | 37 + ...nagementCreateGatewayConfigConnection.json | 42 + ...entCreateGatewayHostnameConfiguration.json | 52 + .../ApiManagementCreateGlobalSchema1.json | 52 + .../ApiManagementCreateGlobalSchema2.json | 112 + .../ApiManagementCreateGraphQLApi.json | 80 + ...ApiManagementCreateGraphQLApiResolver.json | 43 + ...agementCreateGraphQLApiResolverPolicy.json | 40 + .../examples/ApiManagementCreateGroup.json | 38 + .../ApiManagementCreateGroupExternal.json | 45 + .../ApiManagementCreateGroupUser.json | 44 + .../examples/ApiManagementCreateGrpcApi.json | 77 + .../ApiManagementCreateIdentityProvider.json | 39 + ...eMultiRegionServiceWithCustomHostname.json | 280 + .../ApiManagementCreateNamedValue.json | 64 + ...anagementCreateNamedValueWithKeyVault.json | 81 + .../ApiManagementCreateNotification.json | 32 + ...ementCreateNotificationRecipientEmail.json | 32 + ...gementCreateNotificationRecipientUser.json | 32 + .../examples/ApiManagementCreateODataApi.json | 82 + ...ManagementCreateOpenIdConnectProvider.json | 49 + .../examples/ApiManagementCreatePolicy.json | 37 + .../ApiManagementCreatePolicyFragment.json | 52 + .../ApiManagementCreatePolicyRestriction.json | 40 + .../ApiManagementCreatePortalConfig.json | 85 + .../ApiManagementCreatePortalRevision.json | 37 + .../examples/ApiManagementCreateProduct.json | 42 + .../ApiManagementCreateProductApi.json | 56 + .../ApiManagementCreateProductApiLink.json | 37 + .../ApiManagementCreateProductGroup.json | 38 + .../ApiManagementCreateProductGroupLink.json | 37 + .../ApiManagementCreateProductPolicy.json | 38 + .../ApiManagementCreateProductTag.json | 32 + .../ApiManagementCreateProductWiki.json | 57 + .../examples/ApiManagementCreateService.json | 139 + .../ApiManagementCreateServiceHavingMsi.json | 133 + ...gementCreateServiceInVnetWithPublicIP.json | 165 + .../ApiManagementCreateServiceInZones.json | 152 + ...piManagementCreateServiceSkuv2Service.json | 153 + ...eateServiceWithCustomHostnameKeyVault.json | 306 + ...ementCreateServiceWithDeveloperPortal.json | 142 + ...entCreateServiceWithNatGatewayEnabled.json | 160 + ...ntCreateServiceWithSystemCertificates.json | 169 + ...CreateServiceWithUserAssignedIdentity.json | 152 + ...eServiceWithoutLegacyConfigurationApi.json | 153 + ...eateSoapPassThroughApiUsingWsdlImport.json | 77 + ...entCreateSoapToRestApiUsingWsdlImport.json | 74 + .../ApiManagementCreateStandardGateway.json | 106 + .../ApiManagementCreateSubscription.json | 46 + .../examples/ApiManagementCreateTag.json | 36 + .../ApiManagementCreateTagApiLink.json | 37 + .../ApiManagementCreateTagOperationLink.json | 37 + .../ApiManagementCreateTagProductLink.json | 37 + .../examples/ApiManagementCreateTemplate.json | 96 + .../ApiManagementCreateTenantAccess.json | 27 + .../examples/ApiManagementCreateUser.json | 61 + .../ApiManagementCreateWebsocketApi.json | 80 + .../ApiManagementCreateWorkspace.json | 39 + .../ApiManagementCreateWorkspaceAILogger.json | 52 + .../ApiManagementCreateWorkspaceApi.json | 116 + ...anagementCreateWorkspaceApiDiagnostic.json | 161 + ...ManagementCreateWorkspaceApiOperation.json | 131 + ...mentCreateWorkspaceApiOperationPolicy.json | 41 + ...ApiManagementCreateWorkspaceApiPolicy.json | 40 + ...piManagementCreateWorkspaceApiRelease.json | 45 + ...ApiManagementCreateWorkspaceApiSchema.json | 57 + ...anagementCreateWorkspaceApiVersionSet.json | 43 + ...entCreateWorkspaceBackendProxyBackend.json | 127 + ...ntCreateWorkspaceBackendServiceFabric.json | 88 + ...iManagementCreateWorkspaceCertificate.json | 42 + ...reateWorkspaceCertificateWithKeyVault.json | 60 + ...piManagementCreateWorkspaceDiagnostic.json | 160 + .../ApiManagementCreateWorkspaceEHLogger.json | 52 + .../ApiManagementCreateWorkspaceGroup.json | 39 + ...anagementCreateWorkspaceGroupExternal.json | 46 + ...ApiManagementCreateWorkspaceGroupUser.json | 45 + ...piManagementCreateWorkspaceNamedValue.json | 65 + ...CreateWorkspaceNamedValueWithKeyVault.json | 82 + ...ManagementCreateWorkspaceNotification.json | 33 + ...teWorkspaceNotificationRecipientEmail.json | 33 + ...ateWorkspaceNotificationRecipientUser.json | 33 + .../ApiManagementCreateWorkspacePolicy.json | 39 + ...nagementCreateWorkspacePolicyFragment.json | 53 + ...entCreateWorkspacePolicyNonXmlEncoded.json | 39 + ...nagementCreateWorkspacePremiumGateway.json | 103 + .../ApiManagementCreateWorkspaceProduct.json | 43 + ...nagementCreateWorkspaceProductApiLink.json | 38 + ...gementCreateWorkspaceProductGroupLink.json | 38 + ...anagementCreateWorkspaceProductPolicy.json | 39 + .../ApiManagementCreateWorkspaceSchema.json | 53 + ...ManagementCreateWorkspaceSubscription.json | 47 + .../ApiManagementCreateWorkspaceTag.json | 37 + ...piManagementCreateWorkspaceTagApiLink.json | 38 + ...gementCreateWorkspaceTagOperationLink.json | 38 + ...nagementCreateWorkspaceTagProductLink.json | 38 + .../examples/ApiManagementDeleteApi.json | 19 + .../ApiManagementDeleteApiDiagnostic.json | 15 + .../examples/ApiManagementDeleteApiIssue.json | 15 + ...ApiManagementDeleteApiIssueAttachment.json | 16 + .../ApiManagementDeleteApiIssueComment.json | 16 + .../ApiManagementDeleteApiOperation.json | 15 + ...ApiManagementDeleteApiOperationPolicy.json | 16 + .../ApiManagementDeleteApiOperationTag.json | 16 + .../ApiManagementDeleteApiPolicy.json | 15 + .../ApiManagementDeleteApiRelease.json | 15 + .../ApiManagementDeleteApiSchema.json | 15 + .../examples/ApiManagementDeleteApiTag.json | 15 + .../ApiManagementDeleteApiTagDescription.json | 15 + .../ApiManagementDeleteApiVersionSet.json | 14 + .../examples/ApiManagementDeleteApiWiki.json | 14 + .../ApiManagementDeleteAuthorization.json | 15 + ...gementDeleteAuthorizationAccessPolicy.json | 16 + ...ManagementDeleteAuthorizationProvider.json | 14 + ...piManagementDeleteAuthorizationServer.json | 14 + .../examples/ApiManagementDeleteBackend.json | 14 + .../examples/ApiManagementDeleteCache.json | 14 + .../ApiManagementDeleteCertificate.json | 14 + .../ApiManagementDeleteContentType.json | 14 + ...anagementDeleteContentTypeContentItem.json | 15 + .../ApiManagementDeleteDiagnostic.json | 14 + .../ApiManagementDeleteDocumentation.json | 13 + .../examples/ApiManagementDeleteGateway.json | 14 + .../ApiManagementDeleteGatewayApi.json | 15 + ...mentDeleteGatewayCertificateAuthority.json | 15 + ...nagementDeleteGatewayConfigConnection.json | 19 + ...entDeleteGatewayHostnameConfiguration.json | 15 + .../ApiManagementDeleteGlobalSchema.json | 14 + ...ApiManagementDeleteGraphQLApiResolver.json | 15 + ...agementDeleteGraphQLApiResolverPolicy.json | 16 + .../examples/ApiManagementDeleteGroup.json | 14 + .../ApiManagementDeleteGroupUser.json | 15 + .../ApiManagementDeleteIdentityProvider.json | 14 + .../examples/ApiManagementDeleteLogger.json | 14 + .../ApiManagementDeleteNamedValue.json | 14 + ...ementDeleteNotificationRecipientEmail.json | 14 + ...gementDeleteNotificationRecipientUser.json | 14 + ...ManagementDeleteOpenIdConnectProvider.json | 14 + .../examples/ApiManagementDeletePolicy.json | 14 + .../ApiManagementDeletePolicyFragment.json | 14 + .../ApiManagementDeletePolicyRestriction.json | 14 + ...gementDeletePrivateEndpointConnection.json | 18 + .../examples/ApiManagementDeleteProduct.json | 15 + .../ApiManagementDeleteProductApi.json | 15 + .../ApiManagementDeleteProductApiLink.json | 14 + .../ApiManagementDeleteProductGroup.json | 15 + .../ApiManagementDeleteProductGroupLink.json | 14 + .../ApiManagementDeleteProductPolicy.json | 15 + .../ApiManagementDeleteProductTag.json | 15 + .../ApiManagementDeleteProductWiki.json | 14 + .../ApiManagementDeleteSubscription.json | 14 + .../examples/ApiManagementDeleteTag.json | 14 + .../ApiManagementDeleteTagApiLink.json | 14 + .../ApiManagementDeleteTagOperationLink.json | 14 + .../ApiManagementDeleteTagProductLink.json | 14 + .../examples/ApiManagementDeleteTemplate.json | 14 + .../examples/ApiManagementDeleteUser.json | 19 + .../ApiManagementDeleteWorkspace.json | 14 + .../ApiManagementDeleteWorkspaceApi.json | 15 + ...anagementDeleteWorkspaceApiDiagnostic.json | 16 + ...ManagementDeleteWorkspaceApiOperation.json | 16 + ...mentDeleteWorkspaceApiOperationPolicy.json | 17 + ...ApiManagementDeleteWorkspaceApiPolicy.json | 16 + ...piManagementDeleteWorkspaceApiRelease.json | 16 + ...ApiManagementDeleteWorkspaceApiSchema.json | 16 + ...anagementDeleteWorkspaceApiVersionSet.json | 15 + .../ApiManagementDeleteWorkspaceBackend.json | 15 + ...iManagementDeleteWorkspaceCertificate.json | 15 + ...piManagementDeleteWorkspaceDiagnostic.json | 15 + .../ApiManagementDeleteWorkspaceGroup.json | 15 + ...ApiManagementDeleteWorkspaceGroupUser.json | 16 + .../ApiManagementDeleteWorkspaceLogger.json | 15 + ...piManagementDeleteWorkspaceNamedValue.json | 15 + ...teWorkspaceNotificationRecipientEmail.json | 15 + ...eteWorkspaceNotificationRecipientUser.json | 15 + .../ApiManagementDeleteWorkspacePolicy.json | 15 + ...nagementDeleteWorkspacePolicyFragment.json | 15 + .../ApiManagementDeleteWorkspaceProduct.json | 16 + ...nagementDeleteWorkspaceProductApiLink.json | 15 + ...gementDeleteWorkspaceProductGroupLink.json | 15 + ...anagementDeleteWorkspaceProductPolicy.json | 16 + .../ApiManagementDeleteWorkspaceSchema.json | 15 + ...ManagementDeleteWorkspaceSubscription.json | 15 + .../ApiManagementDeleteWorkspaceTag.json | 15 + ...piManagementDeleteWorkspaceTagApiLink.json | 15 + ...gementDeleteWorkspaceTagOperationLink.json | 15 + ...nagementDeleteWorkspaceTagProductLink.json | 15 + ...mentDeletedServicesListBySubscription.json | 36 + .../ApiManagementDeletedServicesPurge.json | 28 + .../ApiManagementGatewayDeleteGateway.json | 44 + .../ApiManagementGatewayGenerateToken.json | 20 + .../ApiManagementGatewayGetGateway.json | 51 + ...mentGatewayInvalidateDebugCredentials.json | 12 + ...ManagementGatewayListDebugCredentials.json | 23 + .../ApiManagementGatewayListKeys.json | 17 + .../ApiManagementGatewayListTrace.json | 112 + .../ApiManagementGatewayRegenerateKey.json | 15 + .../examples/ApiManagementGetApiContract.json | 50 + .../ApiManagementGetApiDiagnostic.json | 57 + ...iManagementGetApiExportInOpenApi2dot0.json | 22 + ...iManagementGetApiExportInOpenApi3dot0.json | 22 + .../examples/ApiManagementGetApiIssue.json | 27 + .../ApiManagementGetApiIssueAttachment.json | 25 + .../ApiManagementGetApiIssueComment.json | 25 + .../ApiManagementGetApiOperation.json | 51 + .../ApiManagementGetApiOperationPetStore.json | 91 + .../ApiManagementGetApiOperationPolicy.json | 23 + .../ApiManagementGetApiOperationTag.json | 23 + .../examples/ApiManagementGetApiPolicy.json | 22 + .../examples/ApiManagementGetApiRelease.json | 25 + .../examples/ApiManagementGetApiRevision.json | 48 + .../examples/ApiManagementGetApiSchema.json | 25 + .../examples/ApiManagementGetApiTag.json | 22 + .../ApiManagementGetApiTagDescription.json | 26 + .../ApiManagementGetApiVersionSet.json | 23 + .../examples/ApiManagementGetApiWiki.json | 28 + .../ApiManagementGetAuthorization.json | 24 + ...anagementGetAuthorizationAccessPolicy.json | 27 + ...anagementGetAuthorizationLoginRequest.json | 20 + ...ApiManagementGetAuthorizationProvider.json | 34 + .../ApiManagementGetAuthorizationServer.json | 45 + .../examples/ApiManagementGetBackend.json | 38 + .../examples/ApiManagementGetCache.json | 24 + .../examples/ApiManagementGetCertificate.json | 23 + ...iManagementGetCertificateWithKeyVault.json | 31 + .../examples/ApiManagementGetContentType.json | 68 + ...piManagementGetContentTypeContentItem.json | 28 + .../ApiManagementGetDeletedServiceByName.json | 23 + .../examples/ApiManagementGetDiagnostic.json | 56 + .../ApiManagementGetDocumentation.json | 22 + .../examples/ApiManagementGetGateway.json | 24 + ...agementGetGatewayCertificateAuthority.json | 22 + ...iManagementGetGatewayConfigConnection.json | 24 + ...gementGetGatewayHostnameConfiguration.json | 24 + .../ApiManagementGetGlobalSchema1.json | 23 + .../ApiManagementGetGlobalSchema2.json | 43 + .../ApiManagementGetGraphQLApiResolver.json | 24 + ...ManagementGetGraphQLApiResolverPolicy.json | 23 + .../examples/ApiManagementGetGroup.json | 25 + .../ApiManagementGetIdentityProvider.json | 30 + .../examples/ApiManagementGetIssue.json | 26 + .../examples/ApiManagementGetLogger.json | 28 + .../examples/ApiManagementGetNamedValue.json | 27 + ...piManagementGetNamedValueWithKeyVault.json | 34 + .../ApiManagementGetNotification.json | 32 + ...ApiManagementGetOpenIdConnectProvider.json | 26 + .../ApiManagementGetOperationResult.json | 16 + .../ApiManagementGetOperationStatus.json | 15 + .../examples/ApiManagementGetPolicy.json | 21 + .../ApiManagementGetPolicyFormat.json | 23 + .../ApiManagementGetPolicyFragment.json | 23 + .../ApiManagementGetPolicyFragmentFormat.json | 24 + .../ApiManagementGetPolicyRestriction.json | 22 + .../ApiManagementGetPortalRevision.json | 26 + ...anagementGetPrivateEndpointConnection.json | 29 + ...ManagementGetPrivateLinkGroupResource.json | 27 + .../examples/ApiManagementGetProduct.json | 26 + .../ApiManagementGetProductApiLink.json | 22 + .../ApiManagementGetProductGroupLink.json | 22 + .../ApiManagementGetProductPolicy.json | 22 + .../examples/ApiManagementGetProductTag.json | 22 + .../examples/ApiManagementGetProductWiki.json | 28 + .../ApiManagementGetQuotaCounterKeys.json | 28 + ...ementGetQuotaCounterKeysByQuotaPeriod.json | 24 + .../ApiManagementGetReportsByApi.json | 55 + .../ApiManagementGetReportsByGeo.json | 37 + .../ApiManagementGetReportsByOperation.json | 76 + .../ApiManagementGetReportsByProduct.json | 55 + .../ApiManagementGetReportsByRequest.json | 56 + ...ApiManagementGetReportsBySubscription.json | 79 + .../ApiManagementGetReportsByTime.json | 56 + .../ApiManagementGetReportsByUser.json | 73 + .../ApiManagementGetSubscription.json | 25 + .../examples/ApiManagementGetTag.json | 21 + .../examples/ApiManagementGetTagApiLink.json | 22 + .../ApiManagementGetTagOperationLink.json | 22 + .../ApiManagementGetTagProductLink.json | 22 + .../examples/ApiManagementGetTemplate.json | 51 + .../ApiManagementGetTenantAccess.json | 21 + .../ApiManagementGetTenantGitAccess.json | 22 + .../ApiManagementGetTenantSettings.json | 28 + .../examples/ApiManagementGetUser.json | 31 + .../ApiManagementGetUserSubscription.json | 26 + .../examples/ApiManagementGetWorkspace.json | 22 + .../ApiManagementGetWorkspaceApiContract.json | 51 + ...piManagementGetWorkspaceApiDiagnostic.json | 58 + ...ntGetWorkspaceApiExportInOpenApi2dot0.json | 23 + ...ntGetWorkspaceApiExportInOpenApi3dot0.json | 23 + ...ApiManagementGetWorkspaceApiOperation.json | 52 + ...agementGetWorkspaceApiOperationPolicy.json | 24 + .../ApiManagementGetWorkspaceApiPolicy.json | 23 + .../ApiManagementGetWorkspaceApiRelease.json | 26 + .../ApiManagementGetWorkspaceApiRevision.json | 49 + .../ApiManagementGetWorkspaceApiSchema.json | 26 + ...piManagementGetWorkspaceApiVersionSet.json | 24 + .../ApiManagementGetWorkspaceBackend.json | 39 + .../ApiManagementGetWorkspaceCertificate.json | 24 + ...ntGetWorkspaceCertificateWithKeyVault.json | 32 + .../ApiManagementGetWorkspaceDiagnostic.json | 57 + .../ApiManagementGetWorkspaceGroup.json | 26 + .../ApiManagementGetWorkspaceLink.json | 27 + .../ApiManagementGetWorkspaceLogger.json | 29 + .../ApiManagementGetWorkspaceNamedValue.json | 28 + ...entGetWorkspaceNamedValueWithKeyVault.json | 35 + ...ApiManagementGetWorkspaceNotification.json | 33 + .../ApiManagementGetWorkspacePolicy.json | 22 + ...iManagementGetWorkspacePolicyFragment.json | 24 + ...ementGetWorkspacePolicyFragmentFormat.json | 25 + .../ApiManagementGetWorkspaceProduct.json | 27 + ...iManagementGetWorkspaceProductApiLink.json | 23 + ...anagementGetWorkspaceProductGroupLink.json | 23 + ...piManagementGetWorkspaceProductPolicy.json | 23 + .../ApiManagementGetWorkspaceSchema.json | 24 + ...ApiManagementGetWorkspaceSubscription.json | 26 + .../ApiManagementGetWorkspaceTag.json | 22 + .../ApiManagementGetWorkspaceTagApiLink.json | 23 + ...anagementGetWorkspaceTagOperationLink.json | 23 + ...iManagementGetWorkspaceTagProductLink.json | 23 + .../examples/ApiManagementHeadApi.json | 16 + .../ApiManagementHeadApiDiagnostic.json | 17 + .../examples/ApiManagementHeadApiIssue.json | 17 + .../ApiManagementHeadApiIssueAttachment.json | 18 + .../ApiManagementHeadApiIssueComment.json | 18 + .../ApiManagementHeadApiOperation.json | 17 + .../ApiManagementHeadApiOperationPolicy.json | 18 + .../ApiManagementHeadApiOperationTag.json | 18 + .../examples/ApiManagementHeadApiPolicy.json | 17 + .../examples/ApiManagementHeadApiRelease.json | 17 + .../examples/ApiManagementHeadApiSchema.json | 17 + .../examples/ApiManagementHeadApiTag.json | 17 + .../ApiManagementHeadApiTagDescription.json | 17 + .../ApiManagementHeadApiVersionSet.json | 16 + .../examples/ApiManagementHeadApiWiki.json | 16 + .../ApiManagementHeadAuthorizationServer.json | 16 + .../examples/ApiManagementHeadBackend.json | 16 + .../examples/ApiManagementHeadCache.json | 16 + .../ApiManagementHeadCertificate.json | 16 + ...iManagementHeadContentTypeContentItem.json | 17 + .../ApiManagementHeadDelegationSettings.json | 15 + .../examples/ApiManagementHeadDiagnostic.json | 16 + .../ApiManagementHeadDocumentation.json | 16 + .../ApiManagementHeadEmailTemplate.json | 16 + .../examples/ApiManagementHeadGateway.json | 16 + .../examples/ApiManagementHeadGatewayApi.json | 17 + ...gementHeadGatewayCertificateAuthority.json | 17 + ...ementHeadGatewayHostnameConfiguration.json | 17 + .../ApiManagementHeadGlobalSchema.json | 16 + .../ApiManagementHeadGraphQLApiResolver.json | 17 + ...anagementHeadGraphQLApiResolverPolicy.json | 18 + .../examples/ApiManagementHeadGroup.json | 16 + .../examples/ApiManagementHeadGroupUser.json | 14 + .../ApiManagementHeadIdentityProvider.json | 16 + .../examples/ApiManagementHeadLogger.json | 16 + .../examples/ApiManagementHeadNamedValue.json | 16 + ...agementHeadNotificationRecipientEmail.json | 14 + ...nagementHeadNotificationRecipientUser.json | 14 + ...piManagementHeadOpenIdConnectProvider.json | 16 + .../examples/ApiManagementHeadPolicy.json | 16 + .../ApiManagementHeadPolicyFragment.json | 16 + .../ApiManagementHeadPolicyRestriction.json | 16 + .../ApiManagementHeadPortalConfig.json | 16 + .../ApiManagementHeadPortalRevision.json | 16 + .../examples/ApiManagementHeadProduct.json | 16 + .../examples/ApiManagementHeadProductApi.json | 13 + .../ApiManagementHeadProductGroup.json | 13 + .../ApiManagementHeadProductPolicy.json | 17 + .../examples/ApiManagementHeadProductTag.json | 17 + .../ApiManagementHeadProductWiki.json | 16 + .../ApiManagementHeadSignInSettings.json | 15 + .../ApiManagementHeadSignUpSettings.json | 15 + .../ApiManagementHeadSubscription.json | 16 + .../examples/ApiManagementHeadTag.json | 16 + .../ApiManagementHeadTenantAccess.json | 12 + .../examples/ApiManagementHeadUser.json | 16 + .../examples/ApiManagementHeadWorkspace.json | 16 + .../ApiManagementHeadWorkspaceApi.json | 17 + ...iManagementHeadWorkspaceApiDiagnostic.json | 18 + ...piManagementHeadWorkspaceApiOperation.json | 18 + ...gementHeadWorkspaceApiOperationPolicy.json | 19 + .../ApiManagementHeadWorkspaceApiPolicy.json | 18 + .../ApiManagementHeadWorkspaceApiRelease.json | 18 + .../ApiManagementHeadWorkspaceApiSchema.json | 18 + ...iManagementHeadWorkspaceApiVersionSet.json | 17 + .../ApiManagementHeadWorkspaceBackend.json | 17 + ...ApiManagementHeadWorkspaceCertificate.json | 17 + .../ApiManagementHeadWorkspaceDiagnostic.json | 17 + .../ApiManagementHeadWorkspaceGroup.json | 17 + .../ApiManagementHeadWorkspaceGroupUser.json | 15 + .../ApiManagementHeadWorkspaceLogger.json | 17 + .../ApiManagementHeadWorkspaceNamedValue.json | 17 + ...adWorkspaceNotificationRecipientEmail.json | 15 + ...eadWorkspaceNotificationRecipientUser.json | 15 + .../ApiManagementHeadWorkspacePolicy.json | 17 + ...ManagementHeadWorkspacePolicyFragment.json | 17 + .../ApiManagementHeadWorkspaceProduct.json | 17 + ...iManagementHeadWorkspaceProductPolicy.json | 18 + .../ApiManagementHeadWorkspaceSchema.json | 17 + ...piManagementHeadWorkspaceSubscription.json | 17 + .../ApiManagementHeadWorkspaceTag.json | 17 + ...ManagementIdentityProviderListSecrets.json | 16 + .../ApiManagementListApiDiagnostics.json | 61 + .../ApiManagementListApiIssueAttachments.json | 30 + .../ApiManagementListApiIssueComments.json | 30 + .../examples/ApiManagementListApiIssues.json | 32 + ...ApiManagementListApiOperationPolicies.json | 28 + .../ApiManagementListApiOperationTags.json | 28 + .../ApiManagementListApiOperations.json | 70 + .../ApiManagementListApiOperationsByTags.json | 33 + .../ApiManagementListApiPolicies.json | 27 + .../ApiManagementListApiProducts.json | 32 + .../ApiManagementListApiReleases.json | 29 + .../ApiManagementListApiRevisions.json | 27 + .../examples/ApiManagementListApiSchemas.json | 30 + .../ApiManagementListApiTagDescriptions.json | 30 + .../examples/ApiManagementListApiTags.json | 27 + .../ApiManagementListApiVersionSets.json | 38 + .../examples/ApiManagementListApiWikis.json | 33 + .../examples/ApiManagementListApis.json | 82 + .../examples/ApiManagementListApisByTags.json | 31 + ...gementListAuthorizationAccessPolicies.json | 43 + ...iManagementListAuthorizationProviders.json | 97 + ...ApiManagementListAuthorizationServers.json | 78 + ...iManagementListAuthorizationsAuthCode.json | 42 + ...anagementListAuthorizationsClientCred.json | 48 + .../examples/ApiManagementListBackends.json | 81 + .../examples/ApiManagementListCaches.json | 28 + .../ApiManagementListCertificates.json | 46 + ...ManagementListContentTypeContentItems.json | 31 + .../ApiManagementListContentTypes.json | 71 + .../ApiManagementListDiagnostics.json | 74 + .../ApiManagementListDocumentations.json | 44 + .../ApiManagementListGatewayApis.json | 35 + ...mentListGatewayCertificateAuthorities.json | 34 + ...ManagementListGatewayConfigConnection.json | 41 + ...mentListGatewayHostnameConfigurations.json | 38 + .../examples/ApiManagementListGateways.json | 40 + ...iManagementListGatewaysBySubscription.json | 72 + ...atewaysBySubscriptionAndResourceGroup.json | 84 + .../ApiManagementListGlobalSchemas.json | 58 + ...agementListGraphQLApiResolverPolicies.json | 28 + .../ApiManagementListGraphQLApiResolvers.json | 50 + .../examples/ApiManagementListGroupUsers.json | 38 + .../examples/ApiManagementListGroups.json | 63 + .../ApiManagementListIdentityProviders.json | 53 + .../examples/ApiManagementListIssues.json | 31 + .../examples/ApiManagementListLoggers.json | 52 + .../ApiManagementListNamedValues.json | 49 + ...gementListNotificationRecipientEmails.json | 43 + ...agementListNotificationRecipientUsers.json | 27 + .../ApiManagementListNotifications.json | 127 + ...iManagementListOpenIdConnectProviders.json | 31 + .../examples/ApiManagementListOperations.json | 59 + .../examples/ApiManagementListPolicies.json | 26 + .../ApiManagementListPolicyDescriptions.json | 36 + ...anagementListPolicyFragmentReferences.json | 24 + .../ApiManagementListPolicyFragments.json | 28 + .../ApiManagementListPolicyRestrictions.json | 26 + .../ApiManagementListPortalConfig.json | 54 + .../ApiManagementListPortalRevisions.json | 42 + .../ApiManagementListPortalSettings.json | 52 + ...agementListPrivateEndpointConnections.json | 48 + ...nagementListPrivateLinkGroupResources.json | 30 + .../ApiManagementListProductApiLinks.json | 27 + .../ApiManagementListProductApis.json | 35 + .../ApiManagementListProductGroupLinks.json | 27 + .../ApiManagementListProductGroups.json | 52 + .../ApiManagementListProductPolicies.json | 27 + ...ApiManagementListProductSubscriptions.json | 30 + .../ApiManagementListProductTags.json | 27 + .../ApiManagementListProductWikis.json | 33 + .../examples/ApiManagementListProducts.json | 56 + .../ApiManagementListProductsByTags.json | 33 + .../examples/ApiManagementListRegions.json | 23 + .../ApiManagementListSKUs-Consumption.json | 24 + .../ApiManagementListSKUs-Dedicated.json | 77 + .../ApiManagementListSKUs-Gateways.json | 41 + ...istSecretsPortalSettingsValidationKey.json | 15 + .../ApiManagementListSecretsTenantAccess.json | 19 + ...piManagementListServiceBySubscription.json | 377 + ...ServiceBySubscriptionAndResourceGroup.json | 369 + .../examples/ApiManagementListSku.json | 224 + .../ApiManagementListSubscriptions.json | 56 + .../ApiManagementListTagApiLinks.json | 27 + .../ApiManagementListTagOperationLinks.json | 27 + .../ApiManagementListTagProductLinks.json | 27 + .../ApiManagementListTagResources.json | 61 + .../examples/ApiManagementListTags.json | 34 + .../examples/ApiManagementListTemplates.json | 56 + .../ApiManagementListTenantAccess.json | 26 + .../ApiManagementListTenantSettings.json | 32 + .../examples/ApiManagementListUserGroups.json | 30 + .../ApiManagementListUserIdentities.json | 22 + .../ApiManagementListUserSubscriptions.json | 44 + .../examples/ApiManagementListUsers.json | 72 + ...ManagementListWorkspaceApiDiagnostics.json | 62 + ...mentListWorkspaceApiOperationPolicies.json | 29 + ...iManagementListWorkspaceApiOperations.json | 70 + ...ApiManagementListWorkspaceApiPolicies.json | 28 + ...ApiManagementListWorkspaceApiReleases.json | 30 + ...piManagementListWorkspaceApiRevisions.json | 28 + .../ApiManagementListWorkspaceApiSchemas.json | 31 + ...ManagementListWorkspaceApiVersionSets.json | 39 + .../ApiManagementListWorkspaceApis.json | 83 + .../ApiManagementListWorkspaceBackends.json | 82 + ...piManagementListWorkspaceCertificates.json | 47 + ...ApiManagementListWorkspaceDiagnostics.json | 75 + .../ApiManagementListWorkspaceGroupUsers.json | 39 + .../ApiManagementListWorkspaceGroups.json | 31 + .../ApiManagementListWorkspaceLinks.json | 47 + .../ApiManagementListWorkspaceLoggers.json | 53 + ...ApiManagementListWorkspaceNamedValues.json | 50 + ...tWorkspaceNotificationRecipientEmails.json | 44 + ...stWorkspaceNotificationRecipientUsers.json | 28 + ...iManagementListWorkspaceNotifications.json | 55 + .../ApiManagementListWorkspacePolicies.json | 27 + ...ListWorkspacePolicyFragmentReferences.json | 25 + ...anagementListWorkspacePolicyFragments.json | 29 + ...anagementListWorkspaceProductApiLinks.json | 28 + ...agementListWorkspaceProductGroupLinks.json | 28 + ...anagementListWorkspaceProductPolicies.json | 28 + .../ApiManagementListWorkspaceProducts.json | 57 + .../ApiManagementListWorkspaceSchemas.json | 59 + ...iManagementListWorkspaceSubscriptions.json | 57 + ...ApiManagementListWorkspaceTagApiLinks.json | 28 + ...agementListWorkspaceTagOperationLinks.json | 28 + ...anagementListWorkspaceTagProductLinks.json | 28 + .../ApiManagementListWorkspaceTags.json | 35 + .../examples/ApiManagementListWorkspaces.json | 36 + .../ApiManagementNamedValueListValue.json | 16 + ...ementOpenidConnectProviderListSecrets.json | 16 + ...ApiManagementPerformConnectivityCheck.json | 54 + ...ntPerformConnectivityCheckHttpConnect.json | 69 + .../examples/ApiManagementPortalConfig.json | 50 + ...ManagementPortalSettingsGetDelegation.json | 26 + .../ApiManagementPortalSettingsGetSignIn.json | 20 + .../ApiManagementPortalSettingsGetSignUp.json | 25 + ...ManagementPortalSettingsPutDelegation.json | 40 + .../ApiManagementPortalSettingsPutSignIn.json | 27 + .../ApiManagementPortalSettingsPutSignUp.json | 37 + ...agementPortalSettingsUpdateDelegation.json | 25 + ...iManagementPortalSettingsUpdateSignIn.json | 18 + ...iManagementPortalSettingsUpdateSignUp.json | 23 + ...uthorizationConfirmConsentCodeRequest.json | 16 + .../ApiManagementRefreshCertificate.json | 31 + .../ApiManagementRefreshNamedValue.json | 40 + ...ManagementRefreshWorkspaceCertificate.json | 32 + ...iManagementRefreshWorkspaceNamedValue.json | 41 + .../ApiManagementRestoreWithAccessKey.json | 138 + ...anagementServiceCheckNameAvailability.json | 19 + .../ApiManagementServiceDeleteService.json | 60 + ...ntServiceGetDomainOwnershipIdentifier.json | 14 + ...mentServiceGetMultiRegionInternalVnet.json | 100 + .../ApiManagementServiceGetNetworkStatus.json | 177 + ...mentServiceGetNetworkStatusByLocation.json | 146 + ...tOutboundNetworkDependenciesEndpoints.json | 463 + .../ApiManagementServiceGetService.json | 179 + ...iManagementServiceGetServiceHavingMsi.json | 89 + .../ApiManagementServiceGetSsoToken.json | 15 + .../ApiManagementServiceMigrateToStv2.json | 109 + .../ApiManagementSubscriptionListSecrets.json | 17 + ...ementSubscriptionRegeneratePrimaryKey.json | 12 + ...entSubscriptionRegenerateSecondaryKey.json | 12 + ...piManagementTenantAccessRegenerateKey.json | 12 + .../ApiManagementTenantAccessSyncState.json | 28 + ...piManagementTenantConfigurationDeploy.json | 37 + .../ApiManagementTenantConfigurationSave.json | 35 + ...ManagementTenantConfigurationValidate.json | 35 + .../examples/ApiManagementUndelete.json | 109 + .../examples/ApiManagementUpdateApi.json | 41 + .../ApiManagementUpdateApiDiagnostic.json | 104 + .../examples/ApiManagementUpdateApiIssue.json | 33 + .../ApiManagementUpdateApiOperation.json | 88 + .../ApiManagementUpdateApiRelease.json | 32 + .../ApiManagementUpdateApiVersionSet.json | 31 + .../examples/ApiManagementUpdateApiWiki.json | 35 + ...piManagementUpdateAuthorizationServer.json | 54 + .../examples/ApiManagementUpdateBackend.json | 61 + .../examples/ApiManagementUpdateCache.json | 30 + .../ApiManagementUpdateDiagnostic.json | 111 + .../ApiManagementUpdateDocumentation.json | 28 + .../examples/ApiManagementUpdateGateway.json | 33 + ...ApiManagementUpdateGraphQLApiResolver.json | 32 + .../examples/ApiManagementUpdateGroup.json | 31 + .../ApiManagementUpdateIdentityProvider.json | 37 + .../examples/ApiManagementUpdateLogger.json | 33 + .../ApiManagementUpdateNamedValue.json | 44 + ...ManagementUpdateOpenIdConnectProvider.json | 34 + .../ApiManagementUpdatePolicyRestriction.json | 28 + .../ApiManagementUpdatePortalConfig.json | 85 + .../ApiManagementUpdatePortalRevision.json | 39 + .../examples/ApiManagementUpdateProduct.json | 32 + .../ApiManagementUpdateProductWiki.json | 35 + .../ApiManagementUpdateQuotaCounterKey.json | 34 + ...entUpdateQuotaCounterKeyByQuotaPeriod.json | 30 + ...piManagementUpdateServiceDisableTls10.json | 64 + ...nagementUpdateServicePublisherDetails.json | 63 + ...anagementUpdateServiceToNewVnetAndAZs.json | 162 + .../ApiManagementUpdateStandardGateway.json | 67 + .../ApiManagementUpdateSubscription.json | 31 + .../examples/ApiManagementUpdateTag.json | 27 + .../examples/ApiManagementUpdateTemplate.json | 58 + .../ApiManagementUpdateTenantAccess.json | 27 + .../examples/ApiManagementUpdateUser.json | 39 + .../ApiManagementUpdateWorkspace.json | 29 + .../ApiManagementUpdateWorkspaceApi.json | 42 + ...anagementUpdateWorkspaceApiDiagnostic.json | 105 + ...ManagementUpdateWorkspaceApiOperation.json | 89 + ...piManagementUpdateWorkspaceApiRelease.json | 33 + ...anagementUpdateWorkspaceApiVersionSet.json | 32 + .../ApiManagementUpdateWorkspaceBackend.json | 62 + ...piManagementUpdateWorkspaceDiagnostic.json | 112 + .../ApiManagementUpdateWorkspaceGroup.json | 32 + .../ApiManagementUpdateWorkspaceLogger.json | 34 + ...piManagementUpdateWorkspaceNamedValue.json | 45 + .../ApiManagementUpdateWorkspaceProduct.json | 33 + ...ManagementUpdateWorkspaceSubscription.json | 32 + .../ApiManagementUpdateWorkspaceTag.json | 28 + ...anagementUserConfirmationPasswordSend.json | 12 + .../ApiManagementUserGenerateSsoUrl.json | 16 + .../examples/ApiManagementUserToken.json | 22 + .../ApiManagementValidatePolicies.json | 29 + ...anagementWorkspaceNamedValueListValue.json | 17 + ...ementWorkspaceSubscriptionListSecrets.json | 18 + ...spaceSubscriptionRegeneratePrimaryKey.json | 13 + ...aceSubscriptionRegenerateSecondaryKey.json | 13 + .../2023-09-01-preview/operationStatuses.json | 107 + .../apimanagement/resource-manager/readme.md | 98 +- .../resource-manager/sdk-suppressions.yaml | 9 + 741 files changed, 79020 insertions(+), 4 deletions(-) create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apigateway.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimallpolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimanagement.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimapisByTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimapiversionsets.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationproviders.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationservers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimcaches.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimcertificates.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimconnectivitycheck.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimcontenttypes.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdeletedservices.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdeployment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdiagnostics.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdocumentations.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimemailtemplates.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgatewayConfigConnections.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgateways.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgroups.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimidentityprovider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimissues.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimloggers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimnamedvalues.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimnetworkstatus.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimnotifications.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimopenidconnectproviders.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimoutbounddependency.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicydescriptions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyfragments.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyrestrictions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyrestrictionsvalidation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalconfigs.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalrevisions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalsettings.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimprivatelink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimproducts.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimproductsByTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimquotas.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimregions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimreports.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimschema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimsettings.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimskus.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimsubscriptions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimtagresources.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimtags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimtenant.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimusers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacebackends.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacecertificates.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacediagnostics.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacelinks.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspaceloggers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspaces.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/definitions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementAllPolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementApplyNetworkConfigurationUpdates.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementAuthorizationServerListSecrets.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackendReconnect.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackupWithAccessKey.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackupWithSystemManagedIdentity.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAILogger.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiClone.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiIssue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiIssueAttachment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiIssueComment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiNewVersionUsingExistingApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiOperation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiOperationPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiOperationTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiRelease.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiRevisionFromExistingApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiTagDescription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingImportOverrideServiceUrl.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingOai3Import.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingSwaggerImport.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingWadlImport.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiVersionSet.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWiki.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWithMultipleAuthServers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWithOpenIdConnect.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationAADAuthCode.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationAADClientCred.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationAccessPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderAADAuthCode.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderAADClientCred.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderGenericOAuth2.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderOOBGoogle.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationServer.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateBackendProxyBackend.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateBackendServiceFabric.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateCache.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateCertificate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateCertificateWithKeyVault.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateContentType.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateContentTypeContentItem.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateDocumentation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateEHLogger.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGateway.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayCertificateAuthority.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayConfigConnection.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayHostnameConfiguration.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGlobalSchema1.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGlobalSchema2.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGraphQLApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGraphQLApiResolver.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGraphQLApiResolverPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGroupExternal.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGroupUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGrpcApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateIdentityProvider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNamedValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNamedValueWithKeyVault.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNotification.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNotificationRecipientEmail.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNotificationRecipientUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateODataApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePolicyFragment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePolicyRestriction.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePortalConfig.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePortalRevision.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductApiLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductGroupLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductWiki.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateService.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceHavingMsi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceInVnetWithPublicIP.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceInZones.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceSkuv2Service.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithCustomHostnameKeyVault.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithDeveloperPortal.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithNatGatewayEnabled.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithSystemCertificates.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithUserAssignedIdentity.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateStandardGateway.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateSubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTagApiLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTagOperationLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTagProductLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTemplate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTenantAccess.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWebsocketApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspace.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceAILogger.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiOperation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiOperationPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiRelease.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiVersionSet.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceBackendProxyBackend.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceBackendServiceFabric.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceCertificate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceCertificateWithKeyVault.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceEHLogger.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceGroupExternal.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceGroupUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNamedValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNotification.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientEmail.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePolicyFragment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePremiumGateway.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProductApiLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProductGroupLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProductPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceSubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTagApiLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTagOperationLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTagProductLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiIssue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiIssueAttachment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiIssueComment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiOperation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiOperationPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiOperationTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiRelease.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiTagDescription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiVersionSet.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiWiki.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorization.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorizationAccessPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorizationProvider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorizationServer.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteBackend.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteCache.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteCertificate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteContentType.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteContentTypeContentItem.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteDocumentation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGateway.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayCertificateAuthority.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayConfigConnection.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayHostnameConfiguration.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGlobalSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGraphQLApiResolver.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGraphQLApiResolverPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGroupUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteIdentityProvider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteLogger.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteNamedValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteNotificationRecipientEmail.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteNotificationRecipientUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteOpenIdConnectProvider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePolicyFragment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePolicyRestriction.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePrivateEndpointConnection.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductApiLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductGroupLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductWiki.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteSubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTagApiLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTagOperationLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTagProductLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTemplate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspace.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiOperation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiOperationPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiRelease.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiVersionSet.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceBackend.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceCertificate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceGroupUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceLogger.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceNamedValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspacePolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspacePolicyFragment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProductApiLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProductGroupLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProductPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceSubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTagApiLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTagOperationLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTagProductLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletedServicesListBySubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletedServicesPurge.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayDeleteGateway.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayGenerateToken.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayGetGateway.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayInvalidateDebugCredentials.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayListDebugCredentials.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayListKeys.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayListTrace.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayRegenerateKey.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiContract.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiExportInOpenApi2dot0.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiExportInOpenApi3dot0.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiIssue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiIssueAttachment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiIssueComment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationPetStore.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRelease.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRevision.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTagDescription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiVersionSet.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiWiki.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorization.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationAccessPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationLoginRequest.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationProvider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationServer.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetBackend.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCache.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificateWithKeyVault.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentType.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentTypeContentItem.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDeletedServiceByName.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDocumentation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGateway.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayCertificateAuthority.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayConfigConnection.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayHostnameConfiguration.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema1.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema2.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolver.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolverPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIdentityProvider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIssue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetLogger.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValueWithKeyVault.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNotification.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationResult.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationStatus.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFormat.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragmentFormat.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyRestriction.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPortalRevision.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateEndpointConnection.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateLinkGroupResource.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductApiLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductGroupLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductWiki.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeys.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByGeo.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByOperation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByProduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByRequest.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsBySubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByTime.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetSubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagApiLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagOperationLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagProductLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTemplate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTenantAccess.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTenantGitAccess.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTenantSettings.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetUserSubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspace.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiContract.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiOperation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiOperationPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiRelease.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiRevision.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiVersionSet.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceBackend.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceCertificate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceCertificateWithKeyVault.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceLogger.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceNamedValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceNamedValueWithKeyVault.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceNotification.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspacePolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspacePolicyFragment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspacePolicyFragmentFormat.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProductApiLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProductGroupLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProductPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceSubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTagApiLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTagOperationLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTagProductLink.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiIssue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiIssueAttachment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiIssueComment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiOperation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiOperationPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiOperationTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiRelease.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiTagDescription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiVersionSet.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiWiki.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadAuthorizationServer.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadBackend.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadCache.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadCertificate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadContentTypeContentItem.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadDelegationSettings.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadDocumentation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadEmailTemplate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGateway.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGatewayApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGatewayCertificateAuthority.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGatewayHostnameConfiguration.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGlobalSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGraphQLApiResolver.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGraphQLApiResolverPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGroupUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadIdentityProvider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadLogger.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadNamedValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadNotificationRecipientEmail.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadNotificationRecipientUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadOpenIdConnectProvider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPolicyFragment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPolicyRestriction.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPortalConfig.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPortalRevision.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductWiki.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadSignInSettings.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadSignUpSettings.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadSubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadTenantAccess.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspace.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiOperation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiOperationPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiRelease.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiVersionSet.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceBackend.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceCertificate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceGroupUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceLogger.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceNamedValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientEmail.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspacePolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspacePolicyFragment.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceProduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceProductPolicy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceSchema.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceSubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementIdentityProviderListSecrets.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiDiagnostics.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiIssueAttachments.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiIssueComments.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiIssues.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperationPolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperationTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperations.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperationsByTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiPolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiProducts.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiReleases.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiRevisions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiSchemas.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiTagDescriptions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiVersionSets.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiWikis.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApis.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApisByTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationAccessPolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationProviders.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationServers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationsAuthCode.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationsClientCred.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListBackends.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListCaches.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListCertificates.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListContentTypeContentItems.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListContentTypes.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListDiagnostics.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListDocumentations.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayApis.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayCertificateAuthorities.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayConfigConnection.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayHostnameConfigurations.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGateways.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewaysBySubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGlobalSchemas.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGraphQLApiResolverPolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGraphQLApiResolvers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGroupUsers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGroups.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListIdentityProviders.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListIssues.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListLoggers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNamedValues.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNotificationRecipientEmails.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNotificationRecipientUsers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNotifications.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListOpenIdConnectProviders.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListOperations.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyDescriptions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyFragmentReferences.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyFragments.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyRestrictions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPortalConfig.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPortalRevisions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPortalSettings.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPrivateEndpointConnections.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPrivateLinkGroupResources.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductApiLinks.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductApis.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductGroupLinks.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductGroups.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductPolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductSubscriptions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductWikis.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProducts.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductsByTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListRegions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSKUs-Consumption.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSKUs-Dedicated.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSKUs-Gateways.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSecretsPortalSettingsValidationKey.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSecretsTenantAccess.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListServiceBySubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSku.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSubscriptions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagApiLinks.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagOperationLinks.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagProductLinks.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagResources.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTemplates.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTenantAccess.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTenantSettings.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUserGroups.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUserIdentities.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUserSubscriptions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUsers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiDiagnostics.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiOperationPolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiOperations.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiPolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiReleases.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiRevisions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiSchemas.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiVersionSets.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApis.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceBackends.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceCertificates.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceDiagnostics.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceGroupUsers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceGroups.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceLinks.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceLoggers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNamedValues.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientEmails.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientUsers.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNotifications.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspacePolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspacePolicyFragmentReferences.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspacePolicyFragments.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProductApiLinks.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProductGroupLinks.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProductPolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProducts.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceSchemas.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceSubscriptions.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTagApiLinks.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTagOperationLinks.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTagProductLinks.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaces.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementNamedValueListValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementOpenidConnectProviderListSecrets.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPerformConnectivityCheck.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPerformConnectivityCheckHttpConnect.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalConfig.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsGetDelegation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsGetSignIn.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsGetSignUp.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsPutDelegation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsPutSignIn.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsPutSignUp.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsUpdateDelegation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsUpdateSignIn.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsUpdateSignUp.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshCertificate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshNamedValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshWorkspaceCertificate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshWorkspaceNamedValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRestoreWithAccessKey.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceCheckNameAvailability.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceDeleteService.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetDomainOwnershipIdentifier.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetMultiRegionInternalVnet.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetNetworkStatus.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetNetworkStatusByLocation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetService.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetServiceHavingMsi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetSsoToken.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceMigrateToStv2.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementSubscriptionListSecrets.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementSubscriptionRegeneratePrimaryKey.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementSubscriptionRegenerateSecondaryKey.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantAccessRegenerateKey.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantAccessSyncState.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantConfigurationDeploy.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantConfigurationSave.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantConfigurationValidate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUndelete.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiIssue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiOperation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiRelease.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiVersionSet.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiWiki.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateAuthorizationServer.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateBackend.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateCache.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateDocumentation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateGateway.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateGraphQLApiResolver.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateIdentityProvider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateLogger.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateNamedValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdatePolicyRestriction.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdatePortalConfig.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdatePortalRevision.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateProduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateProductWiki.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateQuotaCounterKey.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateServiceDisableTls10.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateServicePublisherDetails.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateStandardGateway.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateSubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateTemplate.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateTenantAccess.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateUser.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspace.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiOperation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiRelease.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiVersionSet.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceBackend.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceDiagnostic.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceGroup.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceLogger.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceNamedValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceProduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceSubscription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUserConfirmationPasswordSend.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUserGenerateSsoUrl.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUserToken.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementValidatePolicies.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceNamedValueListValue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceSubscriptionListSecrets.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/operationStatuses.json create mode 100644 specification/apimanagement/resource-manager/sdk-suppressions.yaml diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apigateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apigateway.json new file mode 100644 index 000000000000..15818e301be0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apigateway.json @@ -0,0 +1,836 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs to manage Azure API Management gateway deployments.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}": { + "put": { + "tags": [ + "ApiGateway" + ], + "operationId": "ApiGateway_CreateOrUpdate", + "description": "Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementCreateStandardGateway": { + "$ref": "./examples/ApiManagementCreateStandardGateway.json" + }, + "ApiManagementCreateWorkspacePremiumGateway": { + "$ref": "./examples/ApiManagementCreateWorkspacePremiumGateway.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementGatewayResource" + }, + "description": "Parameters supplied to the CreateOrUpdate API Management gateway operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The gateway was successfully set up.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayResource" + } + }, + "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 + }, + "patch": { + "tags": [ + "ApiGateway" + ], + "operationId": "ApiGateway_Update", + "description": "Updates an existing API Management gateway.", + "x-ms-examples": { + "ApiManagementUpdateStandardGateway": { + "$ref": "./examples/ApiManagementUpdateStandardGateway.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementGatewayUpdateParameters" + }, + "description": "Parameters supplied to the CreateOrUpdate API Management gateway operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The gateway was successfully updated.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayResource" + } + }, + "202": { + "description": "The gateway update request was Accepted.", + "headers": { + "location": { + "description": "Location header", + "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 + }, + "get": { + "tags": [ + "ApiGateway" + ], + "operationId": "ApiGateway_Get", + "description": "Gets an API Management gateway resource description.", + "x-ms-examples": { + "ApiManagementGatewayGetGateway": { + "$ref": "./examples/ApiManagementGatewayGetGateway.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully got the API Management gateway Resource.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiGateway" + ], + "operationId": "ApiGateway_Delete", + "description": "Deletes an existing API Management gateway.", + "x-ms-examples": { + "ApiManagementGatewayDeleteGateway": { + "$ref": "./examples/ApiManagementGatewayDeleteGateway.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "The gateway delete request was accepted.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayResource" + }, + "headers": { + "location": { + "description": "Location header", + "type": "string" + } + } + }, + "204": { + "description": "The gateway 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 + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways": { + "get": { + "tags": [ + "ApiGateway" + ], + "operationId": "ApiGateway_ListByResourceGroup", + "description": "List all API Management gateways within a resource group.", + "x-ms-examples": { + "ApiManagementListGatewaysBySubscriptionAndResourceGroup": { + "$ref": "./examples/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The API Management gateways list.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayListResult" + } + }, + "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.ApiManagement/gateways": { + "get": { + "tags": [ + "ApiGateway" + ], + "operationId": "ApiGateway_List", + "description": "List all API Management gateways within a subscription.", + "x-ms-examples": { + "ApiManagementListGatewaysBySubscription": { + "$ref": "./examples/ApiManagementListGatewaysBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The API Management gateways list.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayListResult" + } + }, + "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.ApiManagement/gateways/{gatewayName}/skus": { + "get": { + "tags": [ + "ApiManagementGatewaySkus" + ], + "summary": "Gets available SKUs for API Management gateway", + "description": "Gets all available SKU for a given API Management gateway", + "operationId": "ApiManagementGatewaySkus_ListAvailableSkus", + "x-ms-examples": { + "ApiManagementListSKUs-Gateways": { + "$ref": "./examples/ApiManagementListSKUs-Gateways.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SKUs.", + "schema": { + "$ref": "#/definitions/GatewayResourceSkuResults" + } + }, + "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": { + "GatewaySku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Sku.", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" + }, + "enum": [ + "Standard", + "WorkspaceGatewayStandard", + "WorkspaceGatewayPremium" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard SKU of the API gateway." + }, + { + "value": "WorkspaceGatewayStandard", + "description": "Standard SKU of the API gateway to be used in Workspaces." + }, + { + "value": "WorkspaceGatewayPremium", + "description": "Premium SKU of the API gateway to be used in Workspaces." + } + ] + } + } + }, + "description": "Describes an available API Management SKU for gateways." + }, + "GatewayConfigurationApi": { + "type": "object", + "properties": { + "hostname": { + "readOnly": true, + "type": "string", + "description": "Hostname to which the agent connects to propagate configuration to the cloud." + } + }, + "description": "Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU." + }, + "FrontendConfiguration": { + "type": "object", + "properties": { + "defaultHostname": { + "readOnly": true, + "type": "string", + "description": "The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU." + } + }, + "description": "Information regarding how the gateway should be exposed." + }, + "BackendConfiguration": { + "type": "object", + "properties": { + "subnet": { + "$ref": "#/definitions/BackendSubnetConfiguration", + "description": "The default hostname of the data-plane gateway to which requests can be sent." + } + }, + "description": "Information regarding how the gateway should integrate with backend systems." + }, + "BackendSubnetConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM ID of the subnet in which the backend systems are hosted." + } + }, + "description": "Information regarding how the subnet to which the gateway should be injected." + }, + "ApiManagementGatewayProperties": { + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "#/definitions/ApiManagementGatewayBaseProperties" + } + ], + "description": "Properties of an API Management gateway resource description." + }, + "ApiManagementGatewayUpdateProperties": { + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "#/definitions/ApiManagementGatewayBaseProperties" + } + ], + "description": "Properties of an API Management gateway resource description." + }, + "ApiManagementGatewayBaseProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.", + "readOnly": true + }, + "targetProvisioningState": { + "type": "string", + "description": "The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.", + "readOnly": true + }, + "createdAtUtc": { + "type": "string", + "format": "date-time", + "description": "Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.", + "readOnly": true + }, + "frontend": { + "$ref": "#/definitions/FrontendConfiguration", + "description": "Information regarding how the gateway should be exposed." + }, + "backend": { + "$ref": "#/definitions/BackendConfiguration", + "description": "Information regarding how the gateway should integrate with backend systems." + }, + "configurationApi": { + "$ref": "#/definitions/GatewayConfigurationApi", + "description": "Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU." + }, + "virtualNetworkType": { + "type": "string", + "description": "The type of VPN in which API Management gateway needs to be configured in. ", + "enum": [ + "None", + "External", + "Internal" + ], + "x-ms-enum": { + "name": "VirtualNetworkType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "The API Management gateway is not part of any Virtual Network." + }, + { + "value": "External", + "description": "The API Management gateway is part of Virtual Network and it is accessible from Internet." + }, + { + "value": "Internal", + "description": "The API Management gateway is part of Virtual Network and it is only accessible from within the virtual network." + } + ] + } + } + }, + "description": "Base Properties of an API Management gateway resource description." + }, + "ApiManagementGatewayListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiManagementGatewayResource" + }, + "description": "Result of the List API Management gateway operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." + } + }, + "required": [ + "value" + ], + "description": "The response of the List API Management gateway operation." + }, + "ApiManagementGatewaySkuProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Sku.", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" + }, + "enum": [ + "Standard", + "WorkspaceGatewayStandard", + "WorkspaceGatewayPremium" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard SKU of the API gateway." + }, + { + "value": "WorkspaceGatewayStandard", + "description": "Standard SKU of the API gateway to be used in Workspaces." + }, + { + "value": "WorkspaceGatewayPremium", + "description": "Premium SKU of the API gateway to be used in Workspaces." + } + ] + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity of the SKU (number of deployed units of the SKU)" + } + }, + "required": [ + "name" + ], + "description": "API Management gateway resource SKU properties." + }, + "ApiManagementGatewaySkuPropertiesForPatch": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Sku.", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" + }, + "enum": [ + "Standard", + "WorkspaceGatewayStandard", + "WorkspaceGatewayPremium" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard SKU of the API gateway." + }, + { + "value": "WorkspaceGatewayStandard", + "description": "Standard SKU of the API gateway to be used in Workspaces." + }, + { + "value": "WorkspaceGatewayPremium", + "description": "Premium SKU of the API gateway to be used in Workspaces." + } + ] + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity of the SKU (number of deployed units of the SKU)" + } + }, + "description": "API Management gateway resource SKU properties for PATCH operations given nothing should be required." + }, + "ApiManagementGatewayResource": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiManagementGatewayProperties", + "description": "Properties of the API Management gateway." + }, + "sku": { + "$ref": "#/definitions/ApiManagementGatewaySkuProperties", + "description": "SKU properties of the API Management gateway." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Resource location.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "etag": { + "type": "string", + "description": "ETag of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApimResource" + } + ], + "required": [ + "location", + "sku", + "properties" + ], + "description": "A single API Management gateway resource in List or Get response." + }, + "ApimResource": { + "type": "object", + "description": "The Resource definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "type": "string", + "description": "Resource name.", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type for API Management resource is set to Microsoft.ApiManagement." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ApiManagementGatewayUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiManagementGatewayUpdateProperties", + "description": "Properties of the API Management gateway." + }, + "sku": { + "$ref": "#/definitions/ApiManagementGatewaySkuPropertiesForPatch", + "description": "SKU properties of the API Management gateway." + }, + "etag": { + "type": "string", + "description": "ETag of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApimResource" + } + ], + "description": "Parameter supplied to Update API Management gateway." + }, + "GatewayResourceSkuResults": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayResourceSkuResult" + }, + "x-ms-identifiers": [ + "resourceType", + "sku/name" + ], + "description": "The list of skus available for the gateway." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of API Management gateway Skus." + } + }, + "required": [ + "value" + ], + "description": "The API Management gateway SKUs operation response." + }, + "GatewayResourceSkuResult": { + "type": "object", + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "sku": { + "$ref": "#/definitions/GatewaySku", + "readOnly": true, + "description": "Specifies API Management gateway SKU." + }, + "capacity": { + "$ref": "#/definitions/GatewaySkuCapacity", + "readOnly": true, + "description": "Specifies the number of API Management gateway units." + } + }, + "description": "Describes an available API Management gateway SKU." + }, + "GatewaySkuCapacity": { + "type": "object", + "properties": { + "minimum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The maximum capacity that can be set." + }, + "default": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The default capacity." + }, + "scaleType": { + "type": "string", + "readOnly": true, + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "x-ms-enum": { + "name": "GatewaySkuCapacityScaleType", + "modelAsString": true, + "values": [ + { + "value": "Automatic", + "description": "Supported scale type automatic." + }, + { + "value": "Manual", + "description": "Supported scale type manual." + }, + { + "value": "None", + "description": "Scaling not supported." + } + ] + } + } + }, + "description": "Describes scaling information of a SKU." + } + }, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimallpolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimallpolicies.json new file mode 100644 index 000000000000..54b1a32320cf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimallpolicies.json @@ -0,0 +1,85 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "REST API for getting policy status in an Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/allPolicies": { + "get": { + "tags": [ + "AllPolicies" + ], + "operationId": "AllPolicies_ListByService", + "description": "Status of all policies of API Management services.", + "x-ms-examples": { + "ApiManagementListPolicyRestrictions": { + "$ref": "./examples/ApiManagementAllPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns an array of Policy Status.", + "schema": { + "$ref": "./definitions.json#/definitions/AllPoliciesCollection" + } + }, + "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": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimanagement.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimanagement.json new file mode 100644 index 000000000000..dbc441eea6ff --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimanagement.json @@ -0,0 +1,948 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ErrorFieldContract": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Property level error code." + }, + "message": { + "type": "string", + "description": "Human-readable representation of property-level error." + }, + "target": { + "type": "string", + "description": "Property name." + } + }, + "description": "Error Field contract." + }, + "ErrorResponseBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response." + }, + "message": { + "type": "string", + "description": "Human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorFieldContract" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "The list of invalid fields send in request, in case of validation error." + } + }, + "description": "Error Body contract." + }, + "RegionContract": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Region name.", + "readOnly": true + }, + "isMasterRegion": { + "description": "whether Region is the master region.", + "type": "boolean" + }, + "isDeleted": { + "description": "whether Region is deleted.", + "type": "boolean" + } + }, + "description": "Region profile." + }, + "RegionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RegionContract" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Lists of Regions." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Lists Regions operation response details." + } + }, + "parameters": { + "AccessParameter": { + "name": "accessName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "access", + "gitAccess" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AccessIdName" + }, + "description": "The identifier of the Access configuration.", + "x-ms-parameter-location": "method" + }, + "SettingsParameter": { + "name": "settingsType", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "public" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "settingsTypeName" + }, + "description": "The identifier of the settings.", + "x-ms-parameter-location": "method" + }, + "ApiIdParameter": { + "name": "apiId", + "in": "path", + "required": true, + "type": "string", + "description": "API identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "ApiIdRevParameter": { + "name": "apiId", + "in": "path", + "required": true, + "type": "string", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "ApiVersionSetIdParameter": { + "name": "versionSetId", + "in": "path", + "required": true, + "type": "string", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "AppTypeParameter": { + "name": "appType", + "in": "query", + "required": false, + "type": "string", + "description": "Determines the type of application which send the create user request. Default is legacy publisher portal.", + "enum": [ + "portal", + "developerPortal" + ], + "x-ms-enum": { + "name": "AppType", + "modelAsString": true, + "values": [ + { + "value": "portal", + "description": "User create request was sent by legacy developer portal." + }, + { + "value": "developerPortal", + "description": "User create request was sent by new developer portal." + } + ] + }, + "default": "portal", + "x-ms-parameter-location": "method" + }, + "AttachmentIdParameter": { + "name": "attachmentId", + "in": "path", + "required": true, + "type": "string", + "description": "Attachment identifier within an Issue. Must be unique in the current Issue.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "AuthorizationProviderIdParameter": { + "name": "authorizationProviderId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the authorization provider.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "AuthorizationIdParameter": { + "name": "authorizationId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the authorization.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "AuthorizationAccessPolicyIdParameter": { + "name": "authorizationAccessPolicyId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the authorization access policy.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "AuthenticationServerIdParameter": { + "name": "authsid", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the authorization server.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "BackendIdParameter": { + "name": "backendId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "CacheIdParameter": { + "name": "cacheId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "CertificateIdParameter": { + "name": "certificateId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "CommentIdParameter": { + "name": "commentId", + "in": "path", + "required": true, + "type": "string", + "description": "Comment identifier within an Issue. Must be unique in the current Issue.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "ConfigurationParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "configuration" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "configurationIdName" + }, + "description": "The identifier of the Git Configuration Operation.", + "x-ms-parameter-location": "method" + }, + "DiagnosticIdParameter": { + "name": "diagnosticId", + "in": "path", + "required": true, + "type": "string", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "EmailParameter": { + "name": "email", + "in": "path", + "required": true, + "type": "string", + "description": "Email identifier.", + "x-ms-parameter-location": "method" + }, + "GatewayNameParameter": { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the API Management gateway.", + "minLength": 1, + "maxLength": 45, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$", + "x-ms-parameter-location": "method" + }, + "ConfigConnectionNameParameter": { + "name": "configConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the API Management gateway config connection.", + "minLength": 1, + "maxLength": 30, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$", + "x-ms-parameter-location": "method" + }, + "GroupIdParameter": { + "name": "groupId", + "in": "path", + "required": true, + "type": "string", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 256, + "x-ms-parameter-location": "method" + }, + "IdentityProviderNameParameter": { + "name": "identityProviderName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ], + "x-ms-enum": { + "name": "IdentityProviderType", + "modelAsString": true, + "values": [ + { + "value": "facebook", + "description": "Facebook as Identity provider." + }, + { + "value": "google", + "description": "Google as Identity provider." + }, + { + "value": "microsoft", + "description": "Microsoft Live as Identity provider." + }, + { + "value": "twitter", + "description": "Twitter as Identity provider." + }, + { + "value": "aad", + "description": "Azure Active Directory as Identity provider." + }, + { + "value": "aadB2C", + "description": "Azure Active Directory B2C as Identity provider." + } + ] + }, + "description": "Identity Provider Type identifier.", + "x-ms-parameter-location": "method" + }, + "IfMatchOptionalParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "IfMatchRequiredParameter": { + "name": "If-Match", + "in": "header", + "required": true, + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "IssueIdParameter": { + "name": "issueId", + "in": "path", + "required": true, + "type": "string", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "LocationNameParameter": { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "Location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US.", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "LoggerIdParameter": { + "name": "loggerId", + "in": "path", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "x-ms-parameter-location": "method" + }, + "NotificationNameParameter": { + "name": "notificationName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + }, + "description": "Notification Name Identifier.", + "x-ms-parameter-location": "method" + }, + "NotifySubscriptionStateChangeParameter": { + "name": "notify", + "in": "query", + "required": false, + "type": "boolean", + "description": "Notify change in Subscription State. \n - If false, do not send any email notification for change of state of subscription \n - If true, send email notification of change of state of subscription ", + "x-ms-parameter-location": "method" + }, + "OpenIdConnectIdParameter": { + "name": "opid", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the OpenID Connect Provider.", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "ResolverIdParameter": { + "name": "resolverId", + "in": "path", + "required": true, + "type": "string", + "description": "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "PolicyExportFormat": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "description": "Policy Export Format.", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "modelAsString": true, + "values": [ + { + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + }, + "default": "xml", + "x-ms-parameter-location": "method" + }, + "PolicyIdParameter": { + "name": "policyId", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "description": "The identifier of the Policy.", + "x-ms-enum": { + "modelAsString": true, + "name": "PolicyIdName" + }, + "x-ms-parameter-location": "method" + }, + "IdParameter": { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "A resource identifier.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + }, + "PolicyFragmentContentFormat": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "description": "Policy fragment content format.", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyFragmentContentFormat", + "modelAsString": true, + "values": [ + { + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + }, + "default": "xml", + "x-ms-parameter-location": "method" + }, + "PolicyRestrictionIdParameter": { + "name": "policyRestrictionId", + "in": "path", + "required": true, + "type": "string", + "description": "Policy restrictions after an entity level", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "PortalRevisionIdParameter": { + "name": "portalRevisionId", + "in": "path", + "required": true, + "type": "string", + "description": "Portal revision identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 256, + "x-ms-parameter-location": "method" + }, + "ProductIdParameter": { + "name": "productId", + "in": "path", + "required": true, + "type": "string", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 256, + "x-ms-parameter-location": "method" + }, + "NamedValueIdParameter": { + "name": "namedValueId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the NamedValue.", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "QuotaCounterKeyParameter": { + "name": "quotaCounterKey", + "in": "path", + "required": true, + "type": "string", + "description": "Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key=\"boo\" in the policy, then it’s accessible by \"boo\" counter key. But if it’s defined as counter-key=\"@(\"b\"+\"a\")\" then it will be accessible by \"ba\" key", + "x-ms-parameter-location": "method" + }, + "QuotaPeriodKeyParameter": { + "name": "quotaPeriodKey", + "in": "path", + "required": true, + "type": "string", + "description": "Quota period key identifier.", + "x-ms-parameter-location": "method" + }, + "ReleaseIdParameter": { + "name": "releaseId", + "in": "path", + "required": true, + "type": "string", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "ServiceNameParameter": { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the API Management service.", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$", + "x-ms-parameter-location": "method" + }, + "SkipQueryParameter": { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of records to skip.", + "minimum": 0, + "x-ms-parameter-location": "method" + }, + "SubscriptionEntityIdParameter": { + "name": "sid", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "TagIdParameter": { + "name": "tagId", + "in": "path", + "required": true, + "type": "string", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "TagDescriptionIdParameter": { + "name": "tagDescriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "TemplateNameParameter": { + "name": "templateName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "applicationApprovedNotificationMessage", + "accountClosedDeveloper", + "quotaLimitApproachingDeveloperNotificationMessage", + "newDeveloperNotificationMessage", + "emailChangeIdentityDefault", + "inviteUserNotificationMessage", + "newCommentNotificationMessage", + "confirmSignUpIdentityDefault", + "newIssueNotificationMessage", + "purchaseDeveloperNotificationMessage", + "passwordResetIdentityDefault", + "passwordResetByAdminNotificationMessage", + "rejectDeveloperNotificationMessage", + "requestDeveloperNotificationMessage" + ], + "x-ms-enum": { + "name": "TemplateName", + "modelAsString": true + }, + "description": "Email Template Name Identifier.", + "x-ms-parameter-location": "method" + }, + "TopQueryParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of records to return.", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "UserIdParameter": { + "name": "userId", + "in": "path", + "required": true, + "type": "string", + "description": "User identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "GatewayIdParameter": { + "name": "gatewayId", + "in": "path", + "required": true, + "type": "string", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "GatewayHostnameConfigurationIdParameter": { + "name": "hcId", + "in": "path", + "required": true, + "type": "string", + "description": "Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "ContentTypeIdParameter": { + "name": "contentTypeId", + "in": "path", + "required": true, + "type": "string", + "description": "Content type identifier.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "ContentItemIdParameter": { + "name": "contentItemId", + "in": "path", + "required": true, + "type": "string", + "description": "Content item identifier.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "SchemaIdParameter": { + "name": "schemaId", + "in": "path", + "required": true, + "type": "string", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "PortalConfigIdParameter": { + "name": "portalConfigId", + "in": "path", + "required": true, + "type": "string", + "description": "Portal configuration identifier.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "DocumentationIdParameter": { + "name": "documentationId", + "in": "path", + "required": true, + "type": "string", + "description": "Documentation identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "WorkspaceIdParameter": { + "name": "workspaceId", + "in": "path", + "required": true, + "type": "string", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "ProductApiLinkIdParameter": { + "name": "apiLinkId", + "in": "path", + "required": true, + "type": "string", + "description": "Product-API link identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "ProductGroupLinkIdParameter": { + "name": "groupLinkId", + "in": "path", + "required": true, + "type": "string", + "description": "Product-Group link identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "TagApiLinkIdParameter": { + "name": "apiLinkId", + "in": "path", + "required": true, + "type": "string", + "description": "Tag-API link identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "TagOperationLinkIdParameter": { + "name": "operationLinkId", + "in": "path", + "required": true, + "type": "string", + "description": "Tag-operation link identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "TagProductLinkIdParameter": { + "name": "productLinkId", + "in": "path", + "required": true, + "type": "string", + "description": "Tag-product link identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json new file mode 100644 index 000000000000..04f36eac34df --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json @@ -0,0 +1,5564 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on API entity and their Operations associated with your Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis": { + "get": { + "tags": [ + "Api" + ], + "operationId": "Api_ListByService", + "description": "Lists all APIs of the API Management service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis" + }, + "x-ms-examples": { + "ApiManagementListApis": { + "$ref": "./examples/ApiManagementListApis.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "tags", + "in": "query", + "required": false, + "type": "string", + "description": "Include tags in the response." + }, + { + "name": "expandApiVersionSet", + "in": "query", + "required": false, + "type": "boolean", + "description": "Include full ApiVersionSet resource in response" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result response of Apis.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ApiContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}": { + "head": { + "tags": [ + "Api" + ], + "operationId": "Api_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApi": { + "$ref": "./examples/ApiManagementHeadApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Api" + ], + "operationId": "Api_Get", + "description": "Gets the details of the API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiContract": { + "$ref": "./examples/ApiManagementGetApiContract.json" + }, + "ApiManagementGetApiRevisionContract": { + "$ref": "./examples/ApiManagementGetApiRevision.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified API entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Api" + ], + "operationId": "Api_CreateOrUpdate", + "description": "Creates new or updates existing specified API of the API Management service instance.", + "x-ms-examples": { + "ApiManagementCreateApiUsingOai3Import": { + "$ref": "./examples/ApiManagementCreateApiUsingOai3Import.json" + }, + "ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct": { + "$ref": "./examples/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json" + }, + "ApiManagementCreateApiUsingSwaggerImport": { + "$ref": "./examples/ApiManagementCreateApiUsingSwaggerImport.json" + }, + "ApiManagementCreateApiUsingWadlImport": { + "$ref": "./examples/ApiManagementCreateApiUsingWadlImport.json" + }, + "ApiManagementCreateSoapToRestApiUsingWsdlImport": { + "$ref": "./examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json" + }, + "ApiManagementCreateSoapPassThroughApiUsingWsdlImport": { + "$ref": "./examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json" + }, + "ApiManagementCreateApi": { + "$ref": "./examples/ApiManagementCreateApi.json" + }, + "ApiManagementCreateApiWithMultipleAuthServers": { + "$ref": "./examples/ApiManagementCreateApiWithMultipleAuthServers.json" + }, + "ApiManagementCreateApiWithMultipleOpenIdConnectProviders": { + "$ref": "./examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json" + }, + "ApiManagementCreateWebSocketApi": { + "$ref": "./examples/ApiManagementCreateWebsocketApi.json" + }, + "ApiManagementCreateApiRevisionFromExistingApi": { + "$ref": "./examples/ApiManagementCreateApiRevisionFromExistingApi.json" + }, + "ApiManagementCreateApiNewVersionUsingExistingApi": { + "$ref": "./examples/ApiManagementCreateApiNewVersionUsingExistingApi.json" + }, + "ApiManagementCreateApiClone": { + "$ref": "./examples/ApiManagementCreateApiClone.json" + }, + "ApiManagementCreateApiWithOpenIdConnect": { + "$ref": "./examples/ApiManagementCreateApiWithOpenIdConnect.json" + }, + "ApiManagementCreateApiUsingImportOverrideServiceUrl": { + "$ref": "./examples/ApiManagementCreateApiUsingImportOverrideServiceUrl.json" + }, + "ApiManagementCreateGraphQLApi": { + "$ref": "./examples/ApiManagementCreateGraphQLApi.json" + }, + "ApiManagementCreateODataApi": { + "$ref": "./examples/ApiManagementCreateODataApi.json" + }, + "ApiManagementCreateGrpcApi": { + "$ref": "./examples/ApiManagementCreateGrpcApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiCreateOrUpdateParameter" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "API was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "200": { + "description": "API was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "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" + } + }, + "patch": { + "tags": [ + "Api" + ], + "operationId": "Api_Update", + "description": "Updates the specified API of the API Management service instance.", + "x-ms-examples": { + "ApiManagementUpdateApi": { + "$ref": "./examples/ApiManagementUpdateApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiUpdateContract" + }, + "description": "API Update Contract parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Api" + ], + "operationId": "Api_Delete", + "description": "Deletes the specified API of the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteApi": { + "$ref": "./examples/ApiManagementDeleteApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "deleteRevisions", + "in": "query", + "required": false, + "type": "boolean", + "description": "Delete all revisions of the Api." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "The API was scheduled for deletion.", + "headers": { + "location": { + "description": "Location header", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "204": { + "description": "The API was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/revisions": { + "get": { + "tags": [ + "ApiRevision" + ], + "operationId": "ApiRevision_ListByService", + "description": "Lists all revisions of an API.", + "x-ms-examples": { + "ApiManagementListApiRevisions": { + "$ref": "./examples/ApiManagementListApiRevisions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a list of revision details.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiRevisionCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ApiRevisionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases": { + "get": { + "tags": [ + "ApiRelease" + ], + "operationId": "ApiRelease_ListByService", + "description": "Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.", + "x-ms-examples": { + "ApiManagementListApiReleases": { + "$ref": "./examples/ApiManagementListApiReleases.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| notes | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a list of API Releases.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ApiReleaseContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}": { + "head": { + "tags": [ + "ApiRelease" + ], + "operationId": "ApiRelease_GetEntityTag", + "description": "Returns the etag of an API release.", + "x-ms-examples": { + "ApiManagementHeadApiRelease": { + "$ref": "./examples/ApiManagementHeadApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the entity state (Etag) version of the api release as specified by its identifier.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiRelease" + ], + "operationId": "ApiRelease_Get", + "description": "Returns the details of an API release.", + "x-ms-examples": { + "ApiManagementGetApiRelease": { + "$ref": "./examples/ApiManagementGetApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns the details of an API Release.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiRelease" + ], + "operationId": "ApiRelease_CreateOrUpdate", + "description": "Creates a new Release for the API.", + "x-ms-examples": { + "ApiManagementCreateApiRelease": { + "$ref": "./examples/ApiManagementCreateApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Release was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Release was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiRelease" + ], + "operationId": "ApiRelease_Update", + "description": "Updates the details of the release of the API specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateApiRelease": { + "$ref": "./examples/ApiManagementUpdateApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "description": "API Release Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Release was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiRelease" + ], + "operationId": "ApiRelease_Delete", + "description": "Deletes the specified release in the API.", + "x-ms-examples": { + "ApiManagementDeleteApiRelease": { + "$ref": "./examples/ApiManagementDeleteApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API release successfully removed" + }, + "204": { + "description": "API release successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/operations": { + "get": { + "tags": [ + "ApiOperation" + ], + "operationId": "ApiOperation_ListByApi", + "description": "Lists a collection of the operations for the specified API.", + "x-ms-examples": { + "ApiManagementListApiOperations": { + "$ref": "./examples/ApiManagementListApiOperations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "tags", + "in": "query", + "required": false, + "type": "string", + "description": "Include tags in the response." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A collection of operation summary entities at the API level.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationCollection" + } + }, + "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-odata": "./definitions.json#/definitions/OperationContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}": { + "head": { + "tags": [ + "ApiOperation" + ], + "operationId": "ApiOperation_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API operation specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiOperation": { + "$ref": "./examples/ApiManagementHeadApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API operation entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiOperation" + ], + "operationId": "ApiOperation_Get", + "description": "Gets the details of the API Operation specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiOperation": { + "$ref": "./examples/ApiManagementGetApiOperation.json" + }, + "ApiManagementGetApiOperationPetStore": { + "$ref": "./examples/ApiManagementGetApiOperationPetStore.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Operation entity.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiOperation" + ], + "operationId": "ApiOperation_CreateOrUpdate", + "description": "Creates a new operation in the API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateApiOperation": { + "$ref": "./examples/ApiManagementCreateApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Operation was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Operation was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiOperation" + ], + "operationId": "ApiOperation_Update", + "description": "Updates the details of the operation in the API specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateApiOperation": { + "$ref": "./examples/ApiManagementUpdateApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/OperationUpdateContract" + }, + "description": "API Operation Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiOperation" + ], + "operationId": "ApiOperation_Delete", + "description": "Deletes the specified operation in the API.", + "x-ms-examples": { + "ApiManagementDeleteApiOperation": { + "$ref": "./examples/ApiManagementDeleteApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API operation successfully removed" + }, + "204": { + "description": "API operation successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies": { + "get": { + "tags": [ + "ApiOperationPolicy" + ], + "operationId": "ApiOperationPolicy_ListByOperation", + "description": "Get the list of policy configuration at the API Operation level.", + "x-ms-examples": { + "ApiManagementListApiOperationPolicies": { + "$ref": "./examples/ApiManagementListApiOperationPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Operations Policy Collection.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyCollection" + } + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}": { + "head": { + "tags": [ + "ApiOperationPolicy" + ], + "operationId": "ApiOperationPolicy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API operation policy specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiOperationPolicy": { + "$ref": "./examples/ApiManagementHeadApiOperationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API operation policy entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiOperationPolicy" + ], + "operationId": "ApiOperationPolicy_Get", + "description": "Get the policy configuration at the API Operation level.", + "x-ms-examples": { + "ApiManagementGetApiOperationPolicy": { + "$ref": "./examples/ApiManagementGetApiOperationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Operation Policy information.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiOperationPolicy" + ], + "operationId": "ApiOperationPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the API Operation level.", + "x-ms-examples": { + "ApiManagementCreateApiOperationPolicy": { + "$ref": "./examples/ApiManagementCreateApiOperationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "description": "The policy contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api Operation policy configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Api Operation policy configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiOperationPolicy" + ], + "operationId": "ApiOperationPolicy_Delete", + "description": "Deletes the policy configuration at the Api Operation.", + "x-ms-examples": { + "ApiManagementDeleteApiOperationPolicy": { + "$ref": "./examples/ApiManagementDeleteApiOperationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Policy successfully removed" + }, + "204": { + "description": "Policy successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags": { + "get": { + "tags": [ + "ApiOperationTag" + ], + "operationId": "Tag_ListByOperation", + "description": "Lists all Tags associated with the Operation.", + "x-ms-examples": { + "ApiManagementListApiOperationTags": { + "$ref": "./examples/ApiManagementListApiOperationTags.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tags associated with the Operation entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}": { + "head": { + "tags": [ + "ApiOperationTag" + ], + "operationId": "Tag_GetEntityStateByOperation", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiOperationTag": { + "$ref": "./examples/ApiManagementHeadApiOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiOperationTag" + ], + "operationId": "Tag_GetByOperation", + "description": "Get tag associated with the Operation.", + "x-ms-examples": { + "ApiManagementGetApiOperationTag": { + "$ref": "./examples/ApiManagementGetApiOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiOperationTag" + ], + "operationId": "Tag_AssignToOperation", + "description": "Assign tag to the Operation.", + "x-ms-examples": { + "ApiManagementCreateApiOperationTag": { + "$ref": "./examples/ApiManagementCreateApiOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was assigned to the Operation.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, + "200": { + "description": "Tag is already assigned to the Operation.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiOperationTag" + ], + "operationId": "Tag_DetachFromOperation", + "description": "Detach the tag from the Operation.", + "x-ms-examples": { + "ApiManagementDeleteApiOperationTag": { + "$ref": "./examples/ApiManagementDeleteApiOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Tag was successfully removed from Operation" + }, + "204": { + "description": "Tag successfully removed by previous request or does not exist in Operation" + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers": { + "get": { + "tags": [ + "GraphQLApiResolver" + ], + "operationId": "GraphQLApiResolver_ListByApi", + "description": "Lists a collection of the resolvers for the specified GraphQL API.", + "x-ms-examples": { + "ApiManagementListGraphQLApiResolvers": { + "$ref": "./examples/ApiManagementListGraphQLApiResolvers.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A collection of resolvers summary entities at the GraphQL API level.", + "schema": { + "$ref": "./definitions.json#/definitions/ResolverCollection" + } + }, + "default": { + "description": "Error response describing why the resolver failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/ResolverContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}": { + "head": { + "tags": [ + "GraphQLApiResolver" + ], + "operationId": "GraphQLApiResolver_GetEntityTag", + "description": "Gets the entity state (Etag) version of the GraphQL API resolver specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadGraphQLApiResolver": { + "$ref": "./examples/ApiManagementHeadGraphQLApiResolver.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified GraphQL API resolver entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the resolver failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "GraphQLApiResolver" + ], + "operationId": "GraphQLApiResolver_Get", + "description": "Gets the details of the GraphQL API Resolver specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetGraphQLApiResolver": { + "$ref": "./examples/ApiManagementGetGraphQLApiResolver.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Resolver entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ResolverContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the resolver failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "GraphQLApiResolver" + ], + "operationId": "GraphQLApiResolver_CreateOrUpdate", + "description": "Creates a new resolver in the GraphQL API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateGraphQLApiResolver": { + "$ref": "./examples/ApiManagementCreateGraphQLApiResolver.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ResolverContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Resolver was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/ResolverContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Resolver was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ResolverContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the resolver failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "GraphQLApiResolver" + ], + "operationId": "GraphQLApiResolver_Update", + "description": "Updates the details of the resolver in the GraphQL API specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateGraphQLApiResolver": { + "$ref": "./examples/ApiManagementUpdateGraphQLApiResolver.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ResolverUpdateContract" + }, + "description": "GraphQL API Resolver Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Resolver was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ResolverContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the resolver failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GraphQLApiResolver" + ], + "operationId": "GraphQLApiResolver_Delete", + "description": "Deletes the specified resolver in the GraphQL API.", + "x-ms-examples": { + "ApiManagementDeleteGraphQLApiResolver": { + "$ref": "./examples/ApiManagementDeleteGraphQLApiResolver.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "GraphQL API resolver successfully removed" + }, + "204": { + "description": "GraphQL API resolver successfully removed by previous request or does not exist" + }, + "default": { + "description": "Error response describing why the resolver failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}/policies": { + "get": { + "tags": [ + "GraphQLApiResolverPolicy" + ], + "operationId": "GraphQLApiResolverPolicy_ListByResolver", + "description": "Get the list of policy configuration at the GraphQL API Resolver level.", + "x-ms-examples": { + "ApiManagementListGraphQLApiResolverPolicies": { + "$ref": "./examples/ApiManagementListGraphQLApiResolverPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "GraphQL Api Resolvers Policy Collection.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyCollection" + } + }, + "default": { + "description": "Error response describing why the resolver failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}/policies/{policyId}": { + "head": { + "tags": [ + "GraphQLApiResolverPolicy" + ], + "operationId": "GraphQLApiResolverPolicy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the GraphQL API resolver policy specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadGraphQLApiResolverPolicy": { + "$ref": "./examples/ApiManagementHeadGraphQLApiResolverPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified GraphQL API resolver policy entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the resolver failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "GraphQLApiResolverPolicy" + ], + "operationId": "GraphQLApiResolverPolicy_Get", + "description": "Get the policy configuration at the GraphQL API Resolver level.", + "x-ms-examples": { + "ApiManagementGetGraphQLApiResolverPolicy": { + "$ref": "./examples/ApiManagementGetGraphQLApiResolverPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "GraphQL Api Resolver Policy information.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the resolver failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "GraphQLApiResolverPolicy" + ], + "operationId": "GraphQLApiResolverPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the GraphQL API Resolver level.", + "x-ms-examples": { + "ApiManagementCreateGraphQLApiResolverPolicy": { + "$ref": "./examples/ApiManagementCreateGraphQLApiResolverPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "description": "The policy contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "GraphQL Api Resolver policy configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "GraphQL Api Resolver policy configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the resolver failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GraphQLApiResolverPolicy" + ], + "operationId": "GraphQLApiResolverPolicy_Delete", + "description": "Deletes the policy configuration at the GraphQL Api Resolver.", + "x-ms-examples": { + "ApiManagementDeleteGraphQLApiResolverPolicy": { + "$ref": "./examples/ApiManagementDeleteGraphQLApiResolverPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Policy successfully removed" + }, + "204": { + "description": "Policy successfully removed by previous request or does not exist" + }, + "default": { + "description": "Error response describing why the resolver failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products": { + "get": { + "tags": [ + "ApiProduct" + ], + "operationId": "ApiProduct_ListByApis", + "description": "Lists all Products, which the API is part of.", + "x-ms-examples": { + "ApiManagementListApiProducts": { + "$ref": "./examples/ApiManagementListApiProducts.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of products which have the Api entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ProductContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies": { + "get": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_ListByApi", + "description": "Get the policy configuration at the API level.", + "x-ms-examples": { + "ApiManagementListApiPolicies": { + "$ref": "./examples/ApiManagementListApiPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Apis Policy Collection.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyCollection" + } + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}": { + "head": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API policy specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiPolicy": { + "$ref": "./examples/ApiManagementHeadApiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API Policy entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_Get", + "description": "Get the policy configuration at the API level.", + "x-ms-examples": { + "ApiManagementGetApiPolicy": { + "$ref": "./examples/ApiManagementGetApiPolicy.json" + } + }, + "produces": [ + "application/json", + "application/vnd.ms-azure-apim.policy+xml", + "application/vnd.ms-azure-apim.policy.raw+xml" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Policy information.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the API.", + "x-ms-examples": { + "ApiManagementCreateApiPolicy": { + "$ref": "./examples/ApiManagementCreateApiPolicy.json" + }, + "ApiManagementCreateApiPolicyNonXmlEncoded": { + "$ref": "./examples/ApiManagementCreateApiPolicyNonXmlEncoded.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "description": "The policy contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api policy configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Api policy configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_Delete", + "description": "Deletes the policy configuration at the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiPolicy": { + "$ref": "./examples/ApiManagementDeleteApiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the policy configuration at the API level." + }, + "204": { + "description": "Successfully deleted the policy configuration at the API level." + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/schemas": { + "get": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_ListByApi", + "description": "Get the schema configuration at the API level.", + "x-ms-examples": { + "ApiManagementListApiSchemas": { + "$ref": "./examples/ApiManagementListApiSchemas.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Apis Schema Collection.", + "schema": { + "$ref": "./definitions.json#/definitions/SchemaCollection" + } + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}": { + "head": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_GetEntityTag", + "description": "Gets the entity state (Etag) version of the schema specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiSchema": { + "$ref": "./examples/ApiManagementHeadApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified schema entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_Get", + "description": "Get the schema configuration at the API level.", + "x-ms-examples": { + "ApiManagementGetApiSchema": { + "$ref": "./examples/ApiManagementGetApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Schema information.", + "schema": { + "$ref": "./definitions.json#/definitions/SchemaContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_CreateOrUpdate", + "description": "Creates or updates schema configuration for the API.", + "x-ms-examples": { + "ApiManagementCreateApiSchema": { + "$ref": "./examples/ApiManagementCreateApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/SchemaContract" + }, + "description": "The schema contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api schema configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/SchemaContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "200": { + "description": "Api schema configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/SchemaContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "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" + } + }, + "delete": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_Delete", + "description": "Deletes the schema configuration at the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiSchema": { + "$ref": "./examples/ApiManagementDeleteApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "If true removes all references to the schema before deleting it." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the schema configuration at the API level." + }, + "204": { + "description": "Successfully deleted the schema configuration at the API level." + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics": { + "get": { + "tags": [ + "ApiDiagnostic" + ], + "operationId": "ApiDiagnostic_ListByService", + "description": "Lists all diagnostics of an API.", + "x-ms-examples": { + "ApiManagementListApiDiagnostics": { + "$ref": "./examples/ApiManagementListApiDiagnostics.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result response of diagnostics for an API.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticCollection" + } + }, + "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-odata": "./definitions.json#/definitions/DiagnosticContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}": { + "head": { + "tags": [ + "ApiDiagnostic" + ], + "operationId": "ApiDiagnostic_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiDiagnostic": { + "$ref": "./examples/ApiManagementHeadApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiDiagnostic" + ], + "operationId": "ApiDiagnostic_Get", + "description": "Gets the details of the Diagnostic for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiDiagnostic": { + "$ref": "./examples/ApiManagementGetApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Diagnostic entity.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiDiagnostic" + ], + "operationId": "ApiDiagnostic_CreateOrUpdate", + "description": "Creates a new Diagnostic for an API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateApiDiagnostic": { + "$ref": "./examples/ApiManagementCreateApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Diagnostic was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Diagnostic was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiDiagnostic" + ], + "operationId": "ApiDiagnostic_Update", + "description": "Updates the details of the Diagnostic for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateApiDiagnostic": { + "$ref": "./examples/ApiManagementUpdateApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "description": "Diagnostic Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Diagnostic was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiDiagnostic" + ], + "operationId": "ApiDiagnostic_Delete", + "description": "Deletes the specified Diagnostic from an API.", + "x-ms-examples": { + "ApiManagementDeleteApiDiagnostic": { + "$ref": "./examples/ApiManagementDeleteApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Diagnostic successfully removed" + }, + "204": { + "description": "Diagnostic successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/issues": { + "get": { + "tags": [ + "ApiIssue" + ], + "operationId": "ApiIssue_ListByService", + "description": "Lists all issues associated with the specified API.", + "x-ms-examples": { + "ApiManagementListApiIssues": { + "$ref": "./examples/ApiManagementListApiIssues.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
" + }, + { + "name": "expandCommentsAttachments", + "in": "query", + "required": false, + "type": "boolean", + "description": "Expand the comment attachments. " + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result response of issues for the API.", + "schema": { + "$ref": "./definitions.json#/definitions/IssueCollection" + } + }, + "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-odata": "./definitions.json#/definitions/IssueContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}": { + "head": { + "tags": [ + "ApiIssue" + ], + "operationId": "ApiIssue_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Issue for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiIssue": { + "$ref": "./examples/ApiManagementHeadApiIssue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiIssue" + ], + "operationId": "ApiIssue_Get", + "description": "Gets the details of the Issue for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiIssue": { + "$ref": "./examples/ApiManagementGetApiIssue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "name": "expandCommentsAttachments", + "in": "query", + "required": false, + "type": "boolean", + "description": "Expand the comment attachments. " + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Issue entity.", + "schema": { + "$ref": "./definitions.json#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiIssue" + ], + "operationId": "ApiIssue_CreateOrUpdate", + "description": "Creates a new Issue for an API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateApiIssue": { + "$ref": "./examples/ApiManagementCreateApiIssue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/IssueContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "New api issue successfully added", + "schema": { + "$ref": "./definitions.json#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Api issue successfully updated", + "schema": { + "$ref": "./definitions.json#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiIssue" + ], + "operationId": "ApiIssue_Update", + "description": "Updates an existing issue for an API.", + "x-ms-examples": { + "ApiManagementUpdateApiIssue": { + "$ref": "./examples/ApiManagementUpdateApiIssue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/IssueUpdateContract" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api issue updated successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiIssue" + ], + "operationId": "ApiIssue_Delete", + "description": "Deletes the specified Issue from an API.", + "x-ms-examples": { + "ApiManagementDeleteApiIssue": { + "$ref": "./examples/ApiManagementDeleteApiIssue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Issue successfully removed" + }, + "204": { + "description": "Issue successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments": { + "get": { + "tags": [ + "ApiIssueComment" + ], + "operationId": "ApiIssueComment_ListByService", + "description": "Lists all comments for the Issue associated with the specified API.", + "x-ms-examples": { + "ApiManagementListApiIssueComments": { + "$ref": "./examples/ApiManagementListApiIssueComments.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result response of issue comments for the API.", + "schema": { + "$ref": "./definitions.json#/definitions/IssueCommentCollection" + } + }, + "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-odata": "./definitions.json#/definitions/IssueCommentContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}": { + "head": { + "tags": [ + "ApiIssueComment" + ], + "operationId": "ApiIssueComment_GetEntityTag", + "description": "Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiIssueComment": { + "$ref": "./examples/ApiManagementHeadApiIssueComment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CommentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiIssueComment" + ], + "operationId": "ApiIssueComment_Get", + "description": "Gets the details of the issue Comment for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiIssueComment": { + "$ref": "./examples/ApiManagementGetApiIssueComment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CommentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified issue Comment entity.", + "schema": { + "$ref": "./definitions.json#/definitions/IssueCommentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiIssueComment" + ], + "operationId": "ApiIssueComment_CreateOrUpdate", + "description": "Creates a new Comment for the Issue in an API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateApiIssueComment": { + "$ref": "./examples/ApiManagementCreateApiIssueComment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CommentIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/IssueCommentContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "New api issue comment successfully added", + "schema": { + "$ref": "./definitions.json#/definitions/IssueCommentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Api issue comment successfully updated", + "schema": { + "$ref": "./definitions.json#/definitions/IssueCommentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiIssueComment" + ], + "operationId": "ApiIssueComment_Delete", + "description": "Deletes the specified comment from an Issue.", + "x-ms-examples": { + "ApiManagementDeleteApiIssueComment": { + "$ref": "./examples/ApiManagementDeleteApiIssueComment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CommentIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Comment successfully removed" + }, + "204": { + "description": "Comment successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments": { + "get": { + "tags": [ + "ApiIssueAttachment" + ], + "operationId": "ApiIssueAttachment_ListByService", + "description": "Lists all attachments for the Issue associated with the specified API.", + "x-ms-examples": { + "ApiManagementListApiIssueAttachments": { + "$ref": "./examples/ApiManagementListApiIssueAttachments.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result response of issue attachments for the API.", + "schema": { + "$ref": "./definitions.json#/definitions/IssueAttachmentCollection" + } + }, + "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-odata": "./definitions.json#/definitions/IssueAttachmentContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}": { + "head": { + "tags": [ + "ApiIssueAttachment" + ], + "operationId": "ApiIssueAttachment_GetEntityTag", + "description": "Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiIssueAttachment": { + "$ref": "./examples/ApiManagementHeadApiIssueAttachment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AttachmentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiIssueAttachment" + ], + "operationId": "ApiIssueAttachment_Get", + "description": "Gets the details of the issue Attachment for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiIssueAttachment": { + "$ref": "./examples/ApiManagementGetApiIssueAttachment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AttachmentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified issue Attachment entity.", + "schema": { + "$ref": "./definitions.json#/definitions/IssueAttachmentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiIssueAttachment" + ], + "operationId": "ApiIssueAttachment_CreateOrUpdate", + "description": "Creates a new Attachment for the Issue in an API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateApiIssueAttachment": { + "$ref": "./examples/ApiManagementCreateApiIssueAttachment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AttachmentIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/IssueAttachmentContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "New api issue attachment successfully added", + "schema": { + "$ref": "./definitions.json#/definitions/IssueAttachmentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Api issue attachment successfully updated", + "schema": { + "$ref": "./definitions.json#/definitions/IssueAttachmentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiIssueAttachment" + ], + "operationId": "ApiIssueAttachment_Delete", + "description": "Deletes the specified comment from an Issue.", + "x-ms-examples": { + "ApiManagementDeleteApiIssueAttachment": { + "$ref": "./examples/ApiManagementDeleteApiIssueAttachment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AttachmentIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Attachment successfully removed" + }, + "204": { + "description": "Attachment successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions": { + "get": { + "tags": [ + "ApiTagDescription" + ], + "operationId": "ApiTagDescription_ListByService", + "description": "Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations", + "x-ms-examples": { + "ApiManagementListApiTagDescriptions": { + "$ref": "./examples/ApiManagementListApiTagDescriptions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tagDescriptions associated with the Api entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagDescriptionCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagDescriptionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}": { + "head": { + "tags": [ + "ApiTagDescription" + ], + "operationId": "ApiTagDescription_GetEntityTag", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiTagDescription": { + "$ref": "./examples/ApiManagementHeadApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiTagDescription" + ], + "operationId": "ApiTagDescription_Get", + "description": "Get Tag description in scope of API", + "x-ms-examples": { + "ApiManagementGetApiTagDescription": { + "$ref": "./examples/ApiManagementGetApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the description of the tag specified by its identifier in scope if the Api.", + "schema": { + "$ref": "./definitions.json#/definitions/TagDescriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiTagDescription" + ], + "operationId": "ApiTagDescription_CreateOrUpdate", + "description": "Create/Update tag description in scope of the Api.", + "x-ms-examples": { + "ApiManagementCreateApiTagDescription": { + "$ref": "./examples/ApiManagementCreateApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/TagDescriptionCreateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag Description was created for the Api.", + "schema": { + "$ref": "./definitions.json#/definitions/TagDescriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Tag Description was updated for the Api.", + "schema": { + "$ref": "./definitions.json#/definitions/TagDescriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiTagDescription" + ], + "operationId": "ApiTagDescription_Delete", + "description": "Delete tag description for the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiTagDescription": { + "$ref": "./examples/ApiManagementDeleteApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Tag description successfully removed" + }, + "204": { + "description": "Tag description successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/tags": { + "get": { + "tags": [ + "ApiTag" + ], + "operationId": "Tag_ListByApi", + "description": "Lists all Tags associated with the API.", + "x-ms-examples": { + "ApiManagementListApiTags": { + "$ref": "./examples/ApiManagementListApiTags.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tags associated with the Api entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}": { + "head": { + "tags": [ + "ApiTag" + ], + "operationId": "Tag_GetEntityStateByApi", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiTag": { + "$ref": "./examples/ApiManagementHeadApiTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiTag" + ], + "operationId": "Tag_GetByApi", + "description": "Get tag associated with the API.", + "x-ms-examples": { + "ApiManagementGetApiTag": { + "$ref": "./examples/ApiManagementGetApiTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiTag" + ], + "operationId": "Tag_AssignToApi", + "description": "Assign tag to the Api.", + "x-ms-examples": { + "ApiManagementCreateApiTag": { + "$ref": "./examples/ApiManagementCreateApiTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was assigned to the Api.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Tag is already assigned to the Api.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiTag" + ], + "operationId": "Tag_DetachFromApi", + "description": "Detach the tag from the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiTag": { + "$ref": "./examples/ApiManagementDeleteApiTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API/Tag association successfully removed" + }, + "204": { + "description": "API/Tag association successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags": { + "get": { + "tags": [ + "ApiOperationsByTag" + ], + "operationId": "Operation_ListByTags", + "description": "Lists a collection of operations associated with tags.", + "x-ms-examples": { + "ApiManagementListApiOperationsByTags": { + "$ref": "./examples/ApiManagementListApiOperationsByTags.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "includeNotTaggedOperations", + "in": "query", + "required": false, + "type": "boolean", + "description": "Include not tagged Operations." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "./definitions.json#/definitions/TagResourceCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagResourceContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default": { + "head": { + "tags": [ + "ApiWiki" + ], + "operationId": "ApiWiki_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Wiki for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiWiki": { + "$ref": "./examples/ApiManagementHeadApiWiki.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiWiki" + ], + "operationId": "ApiWiki_Get", + "description": "Gets the details of the Wiki for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiWiki": { + "$ref": "./examples/ApiManagementGetApiWiki.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Wiki entity.", + "schema": { + "$ref": "./definitions.json#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiWiki" + ], + "operationId": "ApiWiki_CreateOrUpdate", + "description": "Creates a new Wiki for an API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateApiWiki": { + "$ref": "./examples/ApiManagementCreateApiWiki.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/WikiContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Wiki was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Wiki was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiWiki" + ], + "operationId": "ApiWiki_Update", + "description": "Updates the details of the Wiki for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateApiWiki": { + "$ref": "./examples/ApiManagementUpdateApiWiki.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/WikiUpdateContract" + }, + "description": "Wiki Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Wiki was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiWiki" + ], + "operationId": "ApiWiki_Delete", + "description": "Deletes the specified Wiki from an API.", + "x-ms-examples": { + "ApiManagementDeleteApiWiki": { + "$ref": "./examples/ApiManagementDeleteApiWiki.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Wiki successfully removed" + }, + "204": { + "description": "Wiki successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/apis/{apiId}/wikis": { + "get": { + "tags": [ + "ApiWiki" + ], + "operationId": "ApiWikis_List", + "description": "Gets the wikis for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementListApiWikis": { + "$ref": "./examples/ApiManagementListApiWikis.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Wiki entity.", + "schema": { + "$ref": "./definitions.json#/definitions/WikiCollection" + } + }, + "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-odata": "./definitions.json#/definitions/WikiContract" + } + } + }, + "x-ms-paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?export=true": { + "get": { + "tags": [ + "Apis" + ], + "operationId": "ApiExport_Get", + "description": "Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.", + "x-ms-examples": { + "ApiManagementGetApiExportInOpenApi2dot0": { + "$ref": "./examples/ApiManagementGetApiExportInOpenApi2dot0.json" + }, + "ApiManagementGetApiExportInOpenApi3dot0": { + "$ref": "./examples/ApiManagementGetApiExportInOpenApi3dot0.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "format", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "swagger-link", + "wadl-link", + "wsdl-link", + "openapi-link", + "openapi+json-link" + ], + "x-ms-enum": { + "name": "ExportFormat", + "modelAsString": true, + "values": [ + { + "value": "swagger-link", + "description": "Export the Api Definition in OpenAPI 2.0 Specification as JSON document to the Storage Blob.", + "name": "Swagger" + }, + { + "value": "wsdl-link", + "description": "Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`", + "name": "Wsdl" + }, + { + "value": "wadl-link", + "description": "Export the Api Definition in WADL Schema to Storage Blob.", + "name": "Wadl" + }, + { + "value": "openapi-link", + "description": "Export the Api Definition in OpenAPI 3.0 Specification as YAML document to Storage Blob.", + "name": "Openapi" + }, + { + "value": "openapi+json-link", + "description": "Export the Api Definition in OpenAPI 3.0 Specification as JSON document to Storage Blob.", + "name": "OpenapiJson" + } + ] + }, + "description": "Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes. New formats can be added in the future." + }, + { + "name": "export", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "true" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ExportApi" + }, + "description": "Query parameter required to export the API details." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response contains a stream with a full set of API metadata and includes API entity with an embedded array of operation entities.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiExportResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimapisByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimapisByTags.json new file mode 100644 index 000000000000..75af6ee5013f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimapisByTags.json @@ -0,0 +1,106 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing retrieve a collection of Apis associated with a tag in Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags": { + "get": { + "tags": [ + "ApisByTag" + ], + "operationId": "Api_ListByTags", + "description": "Lists a collection of apis associated with tags.", + "x-ms-examples": { + "ApiManagementListApisByTags": { + "$ref": "./examples/ApiManagementListApisByTags.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "includeNotTaggedApis", + "in": "query", + "required": false, + "type": "boolean", + "description": "Include not tagged APIs." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "./definitions.json#/definitions/TagResourceCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagResourceContract" + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimapiversionsets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimapiversionsets.json new file mode 100644 index 000000000000..96096423b140 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimapiversionsets.json @@ -0,0 +1,376 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on the ApiVersionSet entity associated with your Azure API Management deployment. Using this entity you create and manage API Version Sets that are used to group APIs for consistent versioning.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets": { + "get": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "ApiVersionSet_ListByService", + "description": "Lists a collection of API Version Sets in the specified service instance.", + "x-ms-examples": { + "ApiManagementListApiVersionSets": { + "$ref": "./examples/ApiManagementListApiVersionSets.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Api Version Set entities.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ApiVersionSetContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}": { + "head": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "ApiVersionSet_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Api Version Set specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiVersionSet": { + "$ref": "./examples/ApiManagementHeadApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Api Version Set entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "ApiVersionSet_Get", + "description": "Gets the details of the Api Version Set specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiVersionSet": { + "$ref": "./examples/ApiManagementGetApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the specified Api Version Set entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "ApiVersionSet_CreateOrUpdate", + "description": "Creates or Updates a Api Version Set.", + "x-ms-examples": { + "ApiManagementCreateApiVersionSet": { + "$ref": "./examples/ApiManagementCreateApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api Version Set was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Api Version Set was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "ApiVersionSet_Update", + "description": "Updates the details of the Api VersionSet specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateApiVersionSet": { + "$ref": "./examples/ApiManagementUpdateApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Version Set was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiVersionSets" + ], + "operationId": "ApiVersionSet_Delete", + "description": "Deletes specific Api Version Set.", + "x-ms-examples": { + "ApiManagementDeleteApiVersionSet": { + "$ref": "./examples/ApiManagementDeleteApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The ApiVersion Set details were successfully deleted." + }, + "204": { + "description": "The ApiVersion Set details were successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationproviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationproviders.json new file mode 100644 index 000000000000..610f4b32ad44 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationproviders.json @@ -0,0 +1,901 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for managing Authorization Providers in your Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders": { + "get": { + "tags": [ + "AuthorizationProvider" + ], + "operationId": "AuthorizationProvider_ListByService", + "description": "Lists a collection of authorization providers defined within a service instance.", + "x-ms-examples": { + "ApiManagementListAuthorizationProviders": { + "$ref": "./examples/ApiManagementListAuthorizationProviders.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Authorization Provider entities for the specified API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationProviderCollection" + } + }, + "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-odata": "./definitions.json#/definitions/AuthorizationProviderContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}": { + "get": { + "tags": [ + "AuthorizationProvider" + ], + "operationId": "AuthorizationProvider_Get", + "description": "Gets the details of the authorization provider specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetAuthorizationProvider": { + "$ref": "./examples/ApiManagementGetAuthorizationProvider.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified authorization provider entity. No secrets included", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationProviderContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AuthorizationProvider" + ], + "operationId": "AuthorizationProvider_CreateOrUpdate", + "description": "Creates or updates authorization provider.", + "x-ms-examples": { + "ApiManagementCreateAuthorizationProviderAADAuthCode": { + "$ref": "./examples/ApiManagementCreateAuthorizationProviderAADAuthCode.json" + }, + "ApiManagementCreateAuthorizationProviderAADClientCred": { + "$ref": "./examples/ApiManagementCreateAuthorizationProviderAADClientCred.json" + }, + "ApiManagementCreateAuthorizationProviderGenericOAuth2": { + "$ref": "./examples/ApiManagementCreateAuthorizationProviderGenericOAuth2.json" + }, + "ApiManagementCreateAuthorizationProviderOOBGoogle": { + "$ref": "./examples/ApiManagementCreateAuthorizationProviderOOBGoogle.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationProviderContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Authorization provider was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationProviderContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "The existing Authorization provider was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationProviderContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AuthorizationProvider" + ], + "operationId": "AuthorizationProvider_Delete", + "description": "Deletes specific authorization provider from the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteAuthorizationProvider": { + "$ref": "./examples/ApiManagementDeleteAuthorizationProvider.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization provider was successfully deleted." + }, + "204": { + "description": "The authorization server settings were successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations": { + "get": { + "tags": [ + "Authorizations" + ], + "operationId": "Authorization_ListByAuthorizationProvider", + "description": "Lists a collection of authorization providers defined within a authorization provider.", + "x-ms-examples": { + "ApiManagementListAuthorizationsAuthCode": { + "$ref": "./examples/ApiManagementListAuthorizationsAuthCode.json" + }, + "ApiManagementListAuthorizationsClientCred": { + "$ref": "./examples/ApiManagementListAuthorizationsClientCred.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Authorization entities for the specified Authorization provider.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationCollection" + } + }, + "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-odata": "./definitions.json#/definitions/AuthorizationContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}": { + "get": { + "tags": [ + "Authorization" + ], + "operationId": "Authorization_Get", + "description": "Gets the details of the authorization specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetAuthorization": { + "$ref": "./examples/ApiManagementGetAuthorization.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified authorization entity. No secrets included", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Authorization" + ], + "operationId": "Authorization_CreateOrUpdate", + "description": "Creates or updates authorization.", + "x-ms-examples": { + "ApiManagementCreateAuthorizationAADAuthCode": { + "$ref": "./examples/ApiManagementCreateAuthorizationAADAuthCode.json" + }, + "ApiManagementCreateAuthorizationAADClientCred": { + "$ref": "./examples/ApiManagementCreateAuthorizationAADClientCred.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Authorization was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "The existing Authorization was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Authorization" + ], + "operationId": "Authorization_Delete", + "description": "Deletes specific Authorization from the Authorization provider.", + "x-ms-examples": { + "ApiManagementDeleteAuthorization": { + "$ref": "./examples/ApiManagementDeleteAuthorization.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization was successfully deleted." + }, + "204": { + "description": "The authorization resource was not found." + }, + "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.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/getLoginLinks": { + "post": { + "tags": [ + "AuthorizationLoginLinks" + ], + "operationId": "AuthorizationLoginLinks_Post", + "description": "Gets authorization login links.", + "x-ms-examples": { + "ApiManagementGetAuthorizationLoginRequest": { + "$ref": "./examples/ApiManagementGetAuthorizationLoginRequest.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationLoginRequestContract" + }, + "description": "Create parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified authorization login link.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationLoginResponseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "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.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/confirmConsentCode": { + "post": { + "tags": [ + "AuthorizationConfirmConsentCode" + ], + "operationId": "Authorization_ConfirmConsentCode", + "description": "Confirm valid consent code to suppress Authorizations anti-phishing page.", + "x-ms-examples": { + "ApiManagementPostAuthorizationConfirmConsentCodeRequest": { + "$ref": "./examples/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationConfirmConsentCodeRequestContract" + }, + "description": "Create parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body is empty.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "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.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/accessPolicies": { + "get": { + "tags": [ + "AuthorizationAccessPolicy" + ], + "operationId": "AuthorizationAccessPolicy_ListByAuthorization", + "description": "Lists a collection of authorization access policy defined within a authorization.", + "x-ms-examples": { + "ApiManagementListAuthorizationAccessPolicies": { + "$ref": "./examples/ApiManagementListAuthorizationAccessPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Authorization Access Policy entities for the specified Authorization provider.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationAccessPolicyCollection" + } + }, + "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-odata": "./definitions.json#/definitions/AuthorizationAccessPolicyContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/accessPolicies/{authorizationAccessPolicyId}": { + "get": { + "tags": [ + "AuthorizationAccessPolicy" + ], + "operationId": "AuthorizationAccessPolicy_Get", + "description": "Gets the details of the authorization access policy specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetAuthorizationAccessPolicy": { + "$ref": "./examples/ApiManagementGetAuthorizationAccessPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationAccessPolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified authorization access policy entity.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationAccessPolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AuthorizationAccessPolicy" + ], + "operationId": "AuthorizationAccessPolicy_CreateOrUpdate", + "description": "Creates or updates Authorization Access Policy.", + "x-ms-examples": { + "ApiManagementCreateAuthorizationAccessPolicy": { + "$ref": "./examples/ApiManagementCreateAuthorizationAccessPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationAccessPolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationAccessPolicyContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Authorization access policy was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationAccessPolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "The existing Authorization access policy was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationAccessPolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AuthorizationAccessPolicy" + ], + "operationId": "AuthorizationAccessPolicy_Delete", + "description": "Deletes specific access policy from the Authorization.", + "x-ms-examples": { + "ApiManagementDeleteAuthorizationAccessPolicy": { + "$ref": "./examples/ApiManagementDeleteAuthorizationAccessPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthorizationAccessPolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization access policy was successfully deleted." + }, + "204": { + "description": "The authorization server settings were successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationservers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationservers.json new file mode 100644 index 000000000000..b2dbaa170a1e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationservers.json @@ -0,0 +1,427 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for managing OAuth2 servers configuration in your Azure API Management deployment. OAuth 2.0 can be used to authorize developer accounts for Azure API Management. For more information refer to [How to OAuth2](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-oauth2).", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers": { + "get": { + "tags": [ + "AuthorizationServer" + ], + "operationId": "AuthorizationServer_ListByService", + "description": "Lists a collection of authorization servers defined within a service instance.", + "x-ms-examples": { + "ApiManagementListAuthorizationServers": { + "$ref": "./examples/ApiManagementListAuthorizationServers.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Authorization Server entities for the specified API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationServerCollection" + } + }, + "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-odata": "./definitions.json#/definitions/AuthorizationServerContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}": { + "head": { + "tags": [ + "AuthorizationServer" + ], + "operationId": "AuthorizationServer_GetEntityTag", + "description": "Gets the entity state (Etag) version of the authorizationServer specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadAuthorizationServer": { + "$ref": "./examples/ApiManagementHeadAuthorizationServer.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified authorization server entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "AuthorizationServer" + ], + "operationId": "AuthorizationServer_Get", + "description": "Gets the details of the authorization server specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetAuthorizationServer": { + "$ref": "./examples/ApiManagementGetAuthorizationServer.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the specified authorization server. No secrets included.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationServerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AuthorizationServer" + ], + "operationId": "AuthorizationServer_CreateOrUpdate", + "description": "Creates new authorization server or updates an existing authorization server.", + "x-ms-examples": { + "ApiManagementCreateAuthorizationServer": { + "$ref": "./examples/ApiManagementCreateAuthorizationServer.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationServerContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Authorization server was successfully registered.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationServerContract" + } + }, + "200": { + "description": "Authorization server is already registered.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationServerContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "AuthorizationServer" + ], + "operationId": "AuthorizationServer_Update", + "description": "Updates the details of the authorization server specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateAuthorizationServer": { + "$ref": "./examples/ApiManagementUpdateAuthorizationServer.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationServerUpdateContract" + }, + "description": "OAuth2 Server settings Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The authorization server settings were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationServerContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AuthorizationServer" + ], + "operationId": "AuthorizationServer_Delete", + "description": "Deletes specific authorization server instance.", + "x-ms-examples": { + "ApiManagementDeleteAuthorizationServer": { + "$ref": "./examples/ApiManagementDeleteAuthorizationServer.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The authorization server settings were successfully deleted." + }, + "204": { + "description": "The authorization server settings were successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/authorizationServers/{authsid}/listSecrets": { + "post": { + "tags": [ + "AuthorizationServer" + ], + "operationId": "AuthorizationServer_ListSecrets", + "description": "Gets the client secret details of the authorization server.", + "x-ms-examples": { + "ApiManagementAuthorizationServerListSecrets": { + "$ref": "./examples/ApiManagementAuthorizationServerListSecrets.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the secrets of the specified authorization server.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationServerSecretsContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json new file mode 100644 index 000000000000..5a875a63dc29 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json @@ -0,0 +1,430 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Backend entity in Azure API Management deployment. The Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends": { + "get": { + "tags": [ + "Backend" + ], + "operationId": "Backend_ListByService", + "description": "Lists a collection of backends in the specified service instance.", + "x-ms-examples": { + "ApiManagementListBackends": { + "$ref": "./examples/ApiManagementListBackends.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Backend entities.", + "schema": { + "$ref": "./definitions.json#/definitions/BackendCollection" + } + }, + "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-odata": "./definitions.json#/definitions/BackendContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}": { + "head": { + "tags": [ + "Backend" + ], + "operationId": "Backend_GetEntityTag", + "description": "Gets the entity state (Etag) version of the backend specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadBackend": { + "$ref": "./examples/ApiManagementHeadBackend.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified backend entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Backend" + ], + "operationId": "Backend_Get", + "description": "Gets the details of the backend specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetBackend": { + "$ref": "./examples/ApiManagementGetBackend.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Backend entity.", + "schema": { + "$ref": "./definitions.json#/definitions/BackendContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Backend" + ], + "operationId": "Backend_CreateOrUpdate", + "description": "Creates or Updates a backend.", + "x-ms-examples": { + "ApiManagementCreateBackendServiceFabric": { + "$ref": "./examples/ApiManagementCreateBackendServiceFabric.json" + }, + "ApiManagementCreateBackendProxyBackend": { + "$ref": "./examples/ApiManagementCreateBackendProxyBackend.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/BackendContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Backend was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/BackendContract" + } + }, + "200": { + "description": "The existing backend was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/BackendContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Backend" + ], + "operationId": "Backend_Update", + "description": "Updates an existing backend.", + "x-ms-examples": { + "ApiManagementUpdateBackend": { + "$ref": "./examples/ApiManagementUpdateBackend.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/BackendUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing backend was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/BackendContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Backend" + ], + "operationId": "Backend_Delete", + "description": "Deletes the specified backend.", + "x-ms-examples": { + "ApiManagementDeleteBackend": { + "$ref": "./examples/ApiManagementDeleteBackend.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The backend was successfully deleted." + }, + "204": { + "description": "The backend was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/backends/{backendId}/reconnect": { + "post": { + "tags": [ + "BackendReconnect" + ], + "operationId": "Backend_Reconnect", + "description": "Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.", + "x-ms-examples": { + "ApiManagementBackendReconnect": { + "$ref": "./examples/ApiManagementBackendReconnect.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "./definitions.json#/definitions/BackendReconnectContract" + }, + "description": "Reconnect request parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Reconnect request accepted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimcaches.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimcaches.json new file mode 100644 index 000000000000..c36ecf8d9f73 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimcaches.json @@ -0,0 +1,372 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Cache entity in your Azure API Management deployment. Azure API Management also allows for caching responses in an external Azure Cache for Redis. For more information refer to [External Redis Cache in ApiManagement](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-cache-external).", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches": { + "get": { + "tags": [ + "Cache" + ], + "operationId": "Cache_ListByService", + "description": "Lists a collection of all external Caches in the specified service instance.", + "x-ms-examples": { + "ApiManagementListCaches": { + "$ref": "./examples/ApiManagementListCaches.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns a collection of Cache entity.", + "schema": { + "$ref": "./definitions.json#/definitions/CacheCollection" + } + }, + "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.ApiManagement/service/{serviceName}/caches/{cacheId}": { + "head": { + "tags": [ + "Cache" + ], + "operationId": "Cache_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Cache specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadCache": { + "$ref": "./examples/ApiManagementHeadCache.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CacheIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Cache entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Cache" + ], + "operationId": "Cache_Get", + "description": "Gets the details of the Cache specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetCache": { + "$ref": "./examples/ApiManagementGetCache.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CacheIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Cache entity.", + "schema": { + "$ref": "./definitions.json#/definitions/CacheContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Cache" + ], + "operationId": "Cache_CreateOrUpdate", + "description": "Creates or updates an External Cache to be used in Api Management instance.", + "externalDocs": { + "description": "Use an external cache in Azure API Management", + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-cache-external" + }, + "x-ms-examples": { + "ApiManagementCreateCache": { + "$ref": "./examples/ApiManagementCreateCache.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CacheIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/CacheContract" + }, + "description": "Create or Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new Cache was successfully added.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CacheContract" + } + }, + "200": { + "description": "The Cache details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CacheContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Cache" + ], + "operationId": "Cache_Update", + "description": "Updates the details of the cache specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateCache": { + "$ref": "./examples/ApiManagementUpdateCache.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CacheIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/CacheUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Cache details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CacheContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Cache" + ], + "operationId": "Cache_Delete", + "description": "Deletes specific Cache.", + "x-ms-examples": { + "ApiManagementDeleteCache": { + "$ref": "./examples/ApiManagementDeleteCache.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CacheIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Cache was successfully deleted." + }, + "204": { + "description": "The Cache was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimcertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimcertificates.json new file mode 100644 index 000000000000..c23cdf7b10a0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimcertificates.json @@ -0,0 +1,387 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Certificate entity in your Azure API Management deployment. Certificates can be used to setup mutual authentication with your Backend in API Management. For more information refer to [How to secure backend using Mutual Auth Certificate](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-mutual-certificates).", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates": { + "get": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_ListByService", + "description": "Lists a collection of all certificates in the specified service instance.", + "x-ms-examples": { + "ApiManagementListCertificates": { + "$ref": "./examples/ApiManagementListCertificates.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "isKeyVaultRefreshFailed", + "in": "query", + "required": false, + "type": "boolean", + "description": "When set to true, the response contains only certificates entities which failed refresh." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns a collection of Certificate entity.", + "schema": { + "$ref": "./definitions.json#/definitions/CertificateCollection" + } + }, + "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-odata": "./definitions.json#/definitions/CertificateContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}": { + "head": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_GetEntityTag", + "description": "Gets the entity state (Etag) version of the certificate specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadCertificate": { + "$ref": "./examples/ApiManagementHeadCertificate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified certificate entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_Get", + "description": "Gets the details of the certificate specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetCertificate": { + "$ref": "./examples/ApiManagementGetCertificate.json" + }, + "ApiManagementGetCertificateWithKeyVault": { + "$ref": "./examples/ApiManagementGetCertificateWithKeyVault.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Certificate entity.", + "schema": { + "$ref": "./definitions.json#/definitions/CertificateContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_CreateOrUpdate", + "description": "Creates or updates the certificate being used for authentication with the backend.", + "externalDocs": { + "description": "How to secure back-end services using client certificate authentication in Azure API Management", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" + }, + "x-ms-examples": { + "ApiManagementCreateCertificate": { + "$ref": "./examples/ApiManagementCreateCertificate.json" + }, + "ApiManagementCreateCertificateWithKeyVault": { + "$ref": "./examples/ApiManagementCreateCertificateWithKeyVault.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/CertificateCreateOrUpdateParameters" + }, + "description": "Create or Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new certificate was successfully added.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CertificateContract" + } + }, + "200": { + "description": "The certificate details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CertificateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_Delete", + "description": "Deletes specific certificate.", + "x-ms-examples": { + "ApiManagementDeleteCertificate": { + "$ref": "./examples/ApiManagementDeleteCertificate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The certificate was successfully deleted." + }, + "204": { + "description": "The certificate was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/certificates/{certificateId}/refreshSecret": { + "post": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_RefreshSecret", + "description": "From KeyVault, Refresh the certificate being used for authentication with the backend.", + "externalDocs": { + "description": "How to secure back-end services using client certificate authentication in Azure API Management", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" + }, + "x-ms-examples": { + "ApiManagementRefreshCertificate": { + "$ref": "./examples/ApiManagementRefreshCertificate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The certificate details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CertificateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimconnectivitycheck.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimconnectivitycheck.json new file mode 100644 index 000000000000..67f298267b77 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimconnectivitycheck.json @@ -0,0 +1,104 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use this REST APIs to perform connectivity troubleshoot operations in API Management deployments.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/connectivityCheck": { + "post": { + "tags": [ + "PerformConnectivityCheck" + ], + "operationId": "PerformConnectivityCheckAsync", + "description": "Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.", + "x-ms-examples": { + "TCP Connectivity Check": { + "$ref": "./examples/ApiManagementPerformConnectivityCheck.json" + }, + "HTTP Connectivity Check": { + "$ref": "./examples/ApiManagementPerformConnectivityCheckHttpConnect.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "connectivityCheckRequestParams", + "description": "Connectivity Check request parameters.", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ConnectivityCheckRequest" + } + } + ], + "responses": { + "202": { + "description": "Request was accepted and is currently running. Location header contains the URL where the status of the long running operation can be checked and the result eventually retrieved.", + "headers": { + "location": { + "type": "string" + } + } + }, + "200": { + "description": "Connectivity Check Request was completed.", + "schema": { + "$ref": "./definitions.json#/definitions/ConnectivityCheckResponse" + } + }, + "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" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimcontenttypes.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimcontenttypes.json new file mode 100644 index 000000000000..3c41c394ab4a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimcontenttypes.json @@ -0,0 +1,531 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations in Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes": { + "get": { + "tags": [ + "ContentType" + ], + "operationId": "ContentType_ListByService", + "description": "Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.", + "x-ms-examples": { + "ApiManagementListContentTypes": { + "$ref": "./examples/ApiManagementListContentTypes.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns a collection of the Content Type entities.", + "schema": { + "$ref": "./definitions.json#/definitions/ContentTypeCollection" + } + }, + "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.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}": { + "get": { + "tags": [ + "ContentType" + ], + "operationId": "ContentType_Get", + "description": "Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.", + "x-ms-examples": { + "ApiManagementGetContentType": { + "$ref": "./examples/ApiManagementGetContentType.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns the details of the specified content type.", + "schema": { + "$ref": "./definitions.json#/definitions/ContentTypeContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ContentType" + ], + "operationId": "ContentType_CreateOrUpdate", + "description": "Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the `c-` prefix. Built-in content types can't be modified.", + "x-ms-examples": { + "ApiManagementCreateContentType": { + "$ref": "./examples/ApiManagementCreateContentType.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ContentTypeContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The content type was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/ContentTypeContract" + } + }, + "200": { + "description": "The existing content type was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/ContentTypeContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ContentType" + ], + "operationId": "ContentType_Delete", + "description": "Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the `c-` prefix) can't be removed.", + "x-ms-examples": { + "ApiManagementDeleteContentType": { + "$ref": "./examples/ApiManagementDeleteContentType.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The content type was successfully deleted." + }, + "204": { + "description": "The content type was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems": { + "get": { + "tags": [ + "ContentTypeContentItem" + ], + "operationId": "ContentItem_ListByService", + "description": "Lists developer portal's content items specified by the provided content type.", + "x-ms-examples": { + "ApiManagementListContentTypeContentItems": { + "$ref": "./examples/ApiManagementListContentTypeContentItems.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns a collection of Content Type entities.", + "schema": { + "$ref": "./definitions.json#/definitions/ContentItemCollection" + } + }, + "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.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}": { + "head": { + "tags": [ + "ContentTypeContentItem" + ], + "operationId": "ContentItem_GetEntityTag", + "description": "Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadContentTypeContentItem": { + "$ref": "./examples/ApiManagementHeadContentTypeContentItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentItemIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified content item entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ContentTypeContentItem" + ], + "operationId": "ContentItem_Get", + "description": "Returns the developer portal's content item specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetContentTypeContentItem": { + "$ref": "./examples/ApiManagementGetContentTypeContentItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentItemIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns the content item.", + "schema": { + "$ref": "./definitions.json#/definitions/ContentItemContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ContentTypeContentItem" + ], + "operationId": "ContentItem_CreateOrUpdate", + "description": "Creates a new developer portal's content item specified by the provided content type.", + "x-ms-examples": { + "ApiManagementCreateContentTypeContentItem": { + "$ref": "./examples/ApiManagementCreateContentTypeContentItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentItemIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ContentItemContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The content item was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/ContentItemContract" + } + }, + "200": { + "description": "The existing content item was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/ContentItemContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ContentTypeContentItem" + ], + "operationId": "ContentItem_Delete", + "description": "Removes the specified developer portal's content item.", + "x-ms-examples": { + "ApiManagementDeleteContentTypeContentItem": { + "$ref": "./examples/ApiManagementDeleteContentTypeContentItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentItemIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The content item was successfully deleted." + }, + "204": { + "description": "The content item was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdeletedservices.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdeletedservices.json new file mode 100644 index 000000000000..f8e89a3abb8f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdeletedservices.json @@ -0,0 +1,184 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations in Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/deletedservices": { + "get": { + "tags": [ + "DeletedService" + ], + "operationId": "DeletedServices_ListBySubscription", + "description": "Lists all soft-deleted services available for undelete for the given subscription.", + "x-ms-examples": { + "ApiManagementDeletedServicesListBySubscription": { + "$ref": "./examples/ApiManagementDeletedServicesListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of all soft-deleted services available for undelete for the given subscription.", + "schema": { + "$ref": "./definitions.json#/definitions/DeletedServicesCollection" + } + }, + "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.ApiManagement/locations/{location}/deletedservices/{serviceName}": { + "get": { + "tags": [ + "DeletedService" + ], + "operationId": "DeletedServices_GetByName", + "description": "Get soft-deleted Api Management Service by name.", + "x-ms-examples": { + "ApiManagementGetDeletedServiceByName": { + "$ref": "./examples/ApiManagementGetDeletedServiceByName.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the deleted API Management service." + } + ], + "responses": { + "200": { + "description": "Soft-deleted Api Management Service.", + "schema": { + "$ref": "./definitions.json#/definitions/DeletedServiceContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DeletedService" + ], + "operationId": "DeletedServices_Purge", + "description": "Purges Api Management Service (deletes it with no option to undelete).", + "x-ms-examples": { + "ApiManagementDeletedServicesPurge": { + "$ref": "./examples/ApiManagementDeletedServicesPurge.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the deleted API Management service." + } + ], + "responses": { + "200": { + "description": "Api Service was successfully purged." + }, + "202": { + "description": "Api Service purge started.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/DeletedServiceContract" + } + }, + "204": { + "description": "The service 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": "location" + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdeployment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdeployment.json new file mode 100644 index 000000000000..c9a52ff95937 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdeployment.json @@ -0,0 +1,2172 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs to manage Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ApiManagement/operations": { + "get": { + "tags": [ + "ApiManagementOperations" + ], + "description": "Lists all of the available REST API operations of the Microsoft.ApiManagement provider.", + "operationId": "ApiManagementOperations_List", + "x-ms-examples": { + "ApiManagementListOperations": { + "$ref": "./examples/ApiManagementListOperations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "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.ApiManagement/service/{serviceName}/skus": { + "get": { + "tags": [ + "ApiManagementServiceSkus" + ], + "summary": "Gets available SKUs for API Management service", + "description": "Gets all available SKU for a given API Management service", + "operationId": "ApiManagementServiceSkus_ListAvailableServiceSkus", + "x-ms-examples": { + "ApiManagementListSKUs-Dedicated": { + "$ref": "./examples/ApiManagementListSKUs-Dedicated.json" + }, + "ApiManagementListSKUs-Consumption": { + "$ref": "./examples/ApiManagementListSKUs-Consumption.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SKUs.", + "schema": { + "$ref": "#/definitions/ResourceSkuResults" + } + }, + "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.ApiManagement/service/{serviceName}/restore": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_Restore", + "description": "Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementRestoreService": { + "$ref": "./examples/ApiManagementRestoreWithAccessKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceBackupRestoreParameters" + }, + "description": "Parameters supplied to the Restore API Management service from backup operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully restored the backup onto the API Management service.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked.", + "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.ApiManagement/service/{serviceName}/backup": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_Backup", + "description": "Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementBackupWithAccessKey": { + "$ref": "./examples/ApiManagementBackupWithAccessKey.json" + }, + "ApiManagementBackupWithSystemManagedIdentity": { + "$ref": "./examples/ApiManagementBackupWithSystemManagedIdentity.json" + }, + "ApiManagementBackupWithUserAssignedManagedIdentity": { + "$ref": "./examples/ApiManagementBackupWithUserAssignedManagedIdentity.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceBackupRestoreParameters" + }, + "description": "Parameters supplied to the ApiManagementService_Backup operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully backed up the API Management service to the storage account.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked.", + "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.ApiManagement/service/{serviceName}": { + "put": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_CreateOrUpdate", + "description": "Creates or updates an API Management service. This is long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementCreateService": { + "$ref": "./examples/ApiManagementCreateService.json" + }, + "ApiManagementCreateServiceWithDeveloperPortal": { + "$ref": "./examples/ApiManagementCreateServiceWithDeveloperPortal.json" + }, + "ApiManagementCreateServiceInVnetWithPublicIP": { + "$ref": "./examples/ApiManagementCreateServiceInVnetWithPublicIP.json" + }, + "ApiManagementCreateMultiRegionServiceWithCustomHostname": { + "$ref": "./examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json" + }, + "ApiManagementCreateServiceHavingMsi": { + "$ref": "./examples/ApiManagementCreateServiceHavingMsi.json" + }, + "ApiManagementCreateServiceWithSystemCertificates": { + "$ref": "./examples/ApiManagementCreateServiceWithSystemCertificates.json" + }, + "ApiManagementCreateServiceWithUserAssignedIdentity": { + "$ref": "./examples/ApiManagementCreateServiceWithUserAssignedIdentity.json" + }, + "ApiManagementCreateServiceInZones": { + "$ref": "./examples/ApiManagementCreateServiceInZones.json" + }, + "ApiManagementCreateServiceSkuv2Service": { + "$ref": "./examples/ApiManagementCreateServiceSkuv2Service.json" + }, + "ApiManagementUndelete": { + "$ref": "./examples/ApiManagementUndelete.json" + }, + "ApiManagementCreateServiceWithCustomHostnameKeyVault": { + "$ref": "./examples/ApiManagementCreateServiceWithCustomHostnameKeyVault.json" + }, + "ApiManagementCreateServiceWithNatGatewayEnabled": { + "$ref": "./examples/ApiManagementCreateServiceWithNatGatewayEnabled.json" + }, + "ApiManagementCreateServiceWithoutLegacyConfigurationApi": { + "$ref": "./examples/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + }, + "description": "Parameters supplied to the CreateOrUpdate API Management service operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The service was successfully set up.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "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 + }, + "patch": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_Update", + "description": "Updates an existing API Management service.", + "x-ms-examples": { + "ApiManagementUpdateServiceDisableTls10": { + "$ref": "./examples/ApiManagementUpdateServiceDisableTls10.json" + }, + "ApiManagementUpdateServicePublisherDetails": { + "$ref": "./examples/ApiManagementUpdateServicePublisherDetails.json" + }, + "ApiManagementUpdateServiceToNewVnetAndAvailabilityZones": { + "$ref": "./examples/ApiManagementUpdateServiceToNewVnetAndAZs.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceUpdateParameters" + }, + "description": "Parameters supplied to the CreateOrUpdate API Management service operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The service was successfully updated.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "The service update request was Accepted.", + "headers": { + "location": { + "description": "Location header", + "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 + }, + "get": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_Get", + "description": "Gets an API Management service resource description.", + "x-ms-examples": { + "ApiManagementServiceGetService": { + "$ref": "./examples/ApiManagementServiceGetService.json" + }, + "ApiManagementServiceGetServiceHavingMsi": { + "$ref": "./examples/ApiManagementServiceGetServiceHavingMsi.json" + }, + "ApiManagementServiceGetMultiRegionInternalVnet": { + "$ref": "./examples/ApiManagementServiceGetMultiRegionInternalVnet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully got the API Management Service Resource.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_Delete", + "description": "Deletes an existing API Management service.", + "x-ms-examples": { + "ApiManagementServiceDeleteService": { + "$ref": "./examples/ApiManagementServiceDeleteService.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Service was successfully deleted." + }, + "202": { + "description": "The service delete request was Accepted.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + }, + "headers": { + "location": { + "description": "Location header", + "type": "string" + } + } + }, + "204": { + "description": "The service 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 + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_MigrateToStv2", + "description": "Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementMigrateService": { + "$ref": "./examples/ApiManagementServiceMigrateToStv2.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/MigrateToStv2Contract" + }, + "description": "Optional parameters supplied to migrate service." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The service was successfully migrated.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Migration request submitted.", + "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.ApiManagement/service": { + "get": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_ListByResourceGroup", + "description": "List all API Management services within a resource group.", + "x-ms-examples": { + "ApiManagementListServiceBySubscriptionAndResourceGroup": { + "$ref": "./examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The API Management service list.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceListResult" + } + }, + "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.ApiManagement/service": { + "get": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_List", + "description": "Lists all API Management services within an Azure subscription.", + "x-ms-examples": { + "ApiManagementListServiceBySubscription": { + "$ref": "./examples/ApiManagementListServiceBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The API Management service list.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceListResult" + } + }, + "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.ApiManagement/service/{serviceName}/getssotoken": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_GetSsoToken", + "description": "Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.", + "x-ms-examples": { + "ApiManagementServiceGetSsoToken": { + "$ref": "./examples/ApiManagementServiceGetSsoToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK if successful with the SSO Redirect URI.", + "schema": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiManagementServiceGetSsoTokenResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_CheckNameAvailability", + "description": "Checks availability and correctness of a name for an API Management service.", + "x-ms-examples": { + "ApiManagementServiceCheckNameAvailability": { + "$ref": "./examples/ApiManagementServiceCheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceCheckNameAvailabilityParameters" + }, + "description": "Parameters supplied to the CheckNameAvailability operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The result of check name availability.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/getDomainOwnershipIdentifier": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_GetDomainOwnershipIdentifier", + "description": "Get the custom domain ownership identifier for an API Management service.", + "x-ms-examples": { + "ApiManagementServiceGetDomainOwnershipIdentifier": { + "$ref": "./examples/ApiManagementServiceGetDomainOwnershipIdentifier.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The result of getting domain ownership identifier.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceGetDomainOwnershipIdentifierResult" + } + }, + "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.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_ApplyNetworkConfigurationUpdates", + "description": "Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.", + "x-ms-examples": { + "ApiManagementApplyNetworkConfigurationUpdates": { + "$ref": "./examples/ApiManagementApplyNetworkConfigurationUpdates.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApiManagementServiceApplyNetworkConfigurationParameters" + }, + "description": "Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Network configuration updates were successfully applied on the Api Management service.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked.", + "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": { + "ResourceSkuResults": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuResult" + }, + "x-ms-identifiers": [ + "resourceType", + "sku/name" + ], + "description": "The list of skus available for the service." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of API Management service Skus." + } + }, + "required": [ + "value" + ], + "description": "The API Management service SKUs operation response." + }, + "ResourceSkuResult": { + "type": "object", + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "readOnly": true, + "description": "Specifies API Management SKU." + }, + "capacity": { + "$ref": "#/definitions/ResourceSkuCapacity", + "readOnly": true, + "description": "Specifies the number of API Management units." + } + }, + "description": "Describes an available API Management service SKU." + }, + "ResourceSkuCapacity": { + "type": "object", + "properties": { + "minimum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The maximum capacity that can be set." + }, + "default": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The default capacity." + }, + "scaleType": { + "type": "string", + "readOnly": true, + "description": "The scale type applicable to the sku.", + "enum": [ + "automatic", + "manual", + "none" + ], + "x-ms-enum": { + "name": "ResourceSkuCapacityScaleType", + "modelAsString": true, + "values": [ + { + "value": "automatic", + "description": "Supported scale type automatic." + }, + { + "value": "manual", + "description": "Supported scale type manual." + }, + { + "value": "none", + "description": "Scaling not supported." + } + ] + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "MigrateToStv2Contract": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "description": "Mode of Migration to stv2. Default is PreserveIp.", + "externalDocs": { + "url": "https://aka.ms/apim-migrate-stv2" + }, + "enum": [ + "PreserveIp", + "NewIP" + ], + "x-ms-enum": { + "name": "MigrateToStv2Mode", + "modelAsString": true, + "values": [ + { + "value": "PreserveIp", + "description": "Migrate API Management service to stv2 from stv1, by reserving the IP Address of the service. This will have a downtime of upto 15 minutes, while the IP address is getting migrate to new infrastructure." + }, + { + "value": "NewIP", + "description": "Migrate API Management service to stv2 from stv1. This will have no downtime as the service configuration will be migrated to new infrastructure, but the IP address will changed." + } + ] + } + } + }, + "description": "Describes an available API Management SKU." + }, + "ResourceSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Sku.", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" + }, + "enum": [ + "Developer", + "Standard", + "Premium", + "Basic", + "Consumption", + "Isolated", + "BasicV2", + "StandardV2" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": true, + "values": [ + { + "value": "Developer", + "description": "Developer SKU of Api Management." + }, + { + "value": "Standard", + "description": "Standard SKU of Api Management." + }, + { + "value": "Premium", + "description": "Premium SKU of Api Management." + }, + { + "value": "Basic", + "description": "Basic SKU of Api Management." + }, + { + "value": "Consumption", + "description": "Consumption SKU of Api Management." + }, + { + "value": "Isolated", + "description": "Isolated SKU of Api Management." + }, + { + "value": "BasicV2", + "description": "BasicV2 SKU of Api Management." + }, + { + "value": "StandardV2", + "description": "StandardV2 SKU of Api Management." + } + ] + } + } + }, + "description": "Describes an available API Management SKU." + }, + "CertificateInformation": { + "type": "object", + "properties": { + "expiry": { + "type": "string", + "format": "date-time", + "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "subject": { + "type": "string", + "description": "Subject of the certificate." + } + }, + "required": [ + "expiry", + "thumbprint", + "subject" + ], + "description": "SSL certificate information." + }, + "CertificateConfiguration": { + "type": "object", + "properties": { + "encodedCertificate": { + "type": "string", + "description": "Base64 Encoded certificate." + }, + "certificatePassword": { + "type": "string", + "description": "Certificate Password." + }, + "storeName": { + "description": "The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.", + "type": "string", + "enum": [ + "CertificateAuthority", + "Root" + ] + }, + "certificate": { + "$ref": "#/definitions/CertificateInformation", + "description": "Certificate information." + } + }, + "required": [ + "storeName" + ], + "description": "Certificate configuration which consist of non-trusted intermediates and root certificates." + }, + "HostnameConfiguration": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Hostname type.", + "enum": [ + "Proxy", + "Portal", + "Management", + "Scm", + "DeveloperPortal", + "ConfigurationApi" + ], + "x-ms-enum": { + "name": "HostnameType", + "modelAsString": true + } + }, + "hostName": { + "type": "string", + "description": "Hostname to configure on the Api Management service." + }, + "keyVaultId": { + "type": "string", + "description": "Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type *application/x-pkcs12*" + }, + "identityClientId": { + "type": "string", + "description": "System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate." + }, + "encodedCertificate": { + "type": "string", + "description": "Base64 Encoded certificate." + }, + "certificatePassword": { + "type": "string", + "description": "Certificate Password." + }, + "defaultSslBinding": { + "type": "boolean", + "description": "Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.", + "default": false + }, + "negotiateClientCertificate": { + "type": "boolean", + "description": "Specify true to always negotiate client certificate on the hostname. Default Value is false.", + "default": false + }, + "certificate": { + "$ref": "#/definitions/CertificateInformation", + "description": "Certificate information." + }, + "certificateSource": { + "type": "string", + "description": "Certificate Source.", + "enum": [ + "Managed", + "KeyVault", + "Custom", + "BuiltIn" + ], + "x-ms-enum": { + "name": "CertificateSource", + "modelAsString": true + } + }, + "certificateStatus": { + "type": "string", + "description": "Certificate Status.", + "enum": [ + "Completed", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "CertificateStatus", + "modelAsString": true + } + } + }, + "required": [ + "type", + "hostName" + ], + "description": "Custom hostname configuration." + }, + "ConfigurationApi": { + "type": "object", + "properties": { + "legacyApi": { + "type": "string", + "default": "Enabled", + "description": "Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LegacyApiState", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Legacy Configuration API (v1) is enabled for the service and self-hosted gateways can connect to it." + }, + { + "value": "Disabled", + "description": "Legacy Configuration API (v1) is disabled for the service and self-hosted gateways can not connect to it." + } + ] + } + } + }, + "description": "Information regarding the Configuration API of the API Management service." + }, + "VirtualNetworkConfiguration": { + "type": "object", + "properties": { + "vnetid": { + "readOnly": true, + "type": "string", + "description": "The virtual network ID. This is typically a GUID. Expect a null GUID by default." + }, + "subnetname": { + "readOnly": true, + "type": "string", + "description": "The name of the subnet." + }, + "subnetResourceId": { + "type": "string", + "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$", + "description": "The full resource ID of a subnet in a virtual network to deploy the API Management service in." + } + }, + "description": "Configuration of a virtual network to which API Management service is deployed." + }, + "AdditionalLocation": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The location name of the additional region among Azure Data center regions." + }, + "sku": { + "$ref": "#/definitions/ApiManagementServiceSkuProperties", + "description": "SKU properties of the API Management service." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "publicIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU." + }, + "privateIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU." + }, + "publicIpAddressId": { + "type": "string", + "description": "Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network." + }, + "virtualNetworkConfiguration": { + "$ref": "#/definitions/VirtualNetworkConfiguration", + "description": "Virtual network configuration for the location." + }, + "gatewayRegionalUrl": { + "type": "string", + "description": "Gateway URL of the API Management service in the Region.", + "readOnly": true + }, + "natGatewayState": { + "type": "string", + "description": "Property can be used to enable NAT Gateway for this API Management service.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "NatGatewayState", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Nat Gateway is enabled for the service." + }, + { + "value": "Disabled", + "description": "Nat Gateway is disabled for the service." + } + ] + } + }, + "outboundPublicIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform." + }, + "disableGateway": { + "type": "boolean", + "description": "Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.", + "default": false + }, + "platformVersion": { + "type": "string", + "description": "Compute Platform Version running the service.", + "readOnly": true, + "enum": [ + "undetermined", + "stv1", + "stv2", + "mtv1", + "stv2.1" + ], + "x-ms-enum": { + "name": "PlatformVersion", + "modelAsString": true, + "values": [ + { + "value": "undetermined", + "description": "Platform version cannot be determined, as compute platform is not deployed." + }, + { + "value": "stv1", + "description": "Platform running the service on Single Tenant V1 platform." + }, + { + "value": "stv2", + "description": "Platform running the service on Single Tenant V2 platform." + }, + { + "value": "mtv1", + "description": "Platform running the service on Multi Tenant V1 platform." + }, + { + "value": "stv2.1", + "description": "Platform running the service on Single Tenant V2 platform on newer Hardware." + } + ] + } + } + }, + "required": [ + "location", + "sku" + ], + "description": "Description of an additional API Management resource location." + }, + "ApiManagementServiceBackupRestoreParameters": { + "type": "object", + "properties": { + "storageAccount": { + "type": "string", + "description": "The name of the Azure storage account (used to place/retrieve the backup)." + }, + "containerName": { + "type": "string", + "description": "The name of the blob container (used to place/retrieve the backup)." + }, + "backupName": { + "type": "string", + "description": "The name of the backup file to create/retrieve." + }, + "accessType": { + "type": "string", + "description": "The type of access to be used for the storage account.", + "default": "AccessKey", + "enum": [ + "AccessKey", + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity" + ], + "x-ms-enum": { + "name": "AccessType", + "modelAsString": true, + "values": [ + { + "value": "AccessKey", + "description": "Use access key." + }, + { + "value": "SystemAssignedManagedIdentity", + "description": "Use system assigned managed identity." + }, + { + "value": "UserAssignedManagedIdentity", + "description": "Use user assigned managed identity." + } + ] + } + }, + "accessKey": { + "type": "string", + "description": "Storage account access key. Required only if `accessType` is set to `AccessKey`." + }, + "clientId": { + "type": "string", + "description": "The Client ID of user assigned managed identity. Required only if `accessType` is set to `UserAssignedManagedIdentity`." + } + }, + "required": [ + "storageAccount", + "containerName", + "backupName" + ], + "description": "Parameters supplied to the Backup/Restore of an API Management service operation." + }, + "ApiManagementServiceProperties": { + "type": "object", + "properties": { + "publisherEmail": { + "type": "string", + "description": "Publisher email.", + "maxLength": 100 + }, + "publisherName": { + "type": "string", + "description": "Publisher name.", + "maxLength": 100 + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiManagementServiceBaseProperties" + } + ], + "required": [ + "publisherEmail", + "publisherName" + ], + "description": "Properties of an API Management service resource description." + }, + "ApiManagementServiceUpdateProperties": { + "type": "object", + "properties": { + "publisherEmail": { + "type": "string", + "description": "Publisher email.", + "maxLength": 100 + }, + "publisherName": { + "type": "string", + "description": "Publisher name.", + "maxLength": 100 + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiManagementServiceBaseProperties" + } + ], + "description": "Properties of an API Management service resource description." + }, + "ApiManagementServiceBaseProperties": { + "type": "object", + "properties": { + "notificationSenderEmail": { + "type": "string", + "description": "Email address from which the notification will be sent.", + "maxLength": 100 + }, + "provisioningState": { + "type": "string", + "description": "The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.", + "readOnly": true + }, + "targetProvisioningState": { + "type": "string", + "description": "The provisioning state of the API Management service, which is targeted by the long running operation started on the service.", + "readOnly": true + }, + "createdAtUtc": { + "type": "string", + "format": "date-time", + "description": "Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.", + "readOnly": true + }, + "gatewayUrl": { + "type": "string", + "description": "Gateway URL of the API Management service.", + "readOnly": true + }, + "gatewayRegionalUrl": { + "type": "string", + "description": "Gateway URL of the API Management service in the Default Region.", + "readOnly": true + }, + "portalUrl": { + "type": "string", + "description": "Publisher portal endpoint Url of the API Management service.", + "readOnly": true + }, + "managementApiUrl": { + "type": "string", + "description": "Management API endpoint URL of the API Management service.", + "readOnly": true + }, + "scmUrl": { + "type": "string", + "description": "SCM endpoint URL of the API Management service.", + "readOnly": true + }, + "developerPortalUrl": { + "type": "string", + "description": "DEveloper Portal endpoint URL of the API Management service.", + "readOnly": true + }, + "hostnameConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/HostnameConfiguration" + }, + "x-ms-identifiers": [ + "hostName", + "type" + ], + "description": "Custom hostname configuration of the API Management service." + }, + "publicIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU." + }, + "privateIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU." + }, + "publicIpAddressId": { + "type": "string", + "description": "Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network." + }, + "publicNetworkAccess": { + "description": "Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "configurationApi": { + "$ref": "#/definitions/ConfigurationApi", + "description": "Configuration API configuration of the API Management service." + }, + "virtualNetworkConfiguration": { + "$ref": "#/definitions/VirtualNetworkConfiguration", + "description": "Virtual network configuration of the API Management service." + }, + "additionalLocations": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalLocation" + }, + "x-ms-identifiers": [ + "location", + "sku" + ], + "description": "Additional datacenter locations of the API Management service." + }, + "customProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Custom properties of the API Management service.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service.
Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is `True` if the service was created on or before April 1, 2018 and `False` otherwise. Http2 setting's default value is `False`.

You can disable any of the following ciphers by using settings `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. The default value is `true` for them.
Note: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + }, + "certificates": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateConfiguration" + }, + "x-ms-identifiers": [ + "certificate/thumbprint" + ], + "description": "List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10." + }, + "enableClientCertificate": { + "type": "boolean", + "description": "Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.", + "default": false + }, + "natGatewayState": { + "type": "string", + "description": "Property can be used to enable NAT Gateway for this API Management service.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "NatGatewayState", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Nat Gateway is enabled for the service." + }, + { + "value": "Disabled", + "description": "Nat Gateway is disabled for the service." + } + ] + } + }, + "outboundPublicIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform." + }, + "disableGateway": { + "type": "boolean", + "description": "Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.", + "default": false + }, + "virtualNetworkType": { + "type": "string", + "description": "The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", + "default": "None", + "enum": [ + "None", + "External", + "Internal" + ], + "x-ms-enum": { + "name": "VirtualNetworkType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "The service is not part of any Virtual Network." + }, + { + "value": "External", + "description": "The service is part of Virtual Network and it is accessible from Internet." + }, + { + "value": "Internal", + "description": "The service is part of Virtual Network and it is only accessible from within the virtual network." + } + ] + } + }, + "apiVersionConstraint": { + "$ref": "#/definitions/ApiVersionConstraint", + "description": "Control Plane Apis version constraint for the API Management service." + }, + "restore": { + "type": "boolean", + "description": "Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.", + "default": false + }, + "privateEndpointConnections": { + "type": "array", + "items": { + "$ref": "./definitions.json#/definitions/RemotePrivateEndpointConnectionWrapper" + }, + "description": "List of Private Endpoint Connections of this service." + }, + "platformVersion": { + "type": "string", + "description": "Compute Platform Version running the service in this location.", + "readOnly": true, + "enum": [ + "undetermined", + "stv1", + "stv2", + "mtv1", + "stv2.1" + ], + "x-ms-enum": { + "name": "PlatformVersion", + "modelAsString": true, + "values": [ + { + "value": "undetermined", + "description": "Platform version cannot be determined, as compute platform is not deployed." + }, + { + "value": "stv1", + "description": "Platform running the service on Single Tenant V1 platform." + }, + { + "value": "stv2", + "description": "Platform running the service on Single Tenant V2 platform." + }, + { + "value": "mtv1", + "description": "Platform running the service on Multi Tenant V1 platform." + }, + { + "value": "stv2.1", + "description": "Platform running the service on Single Tenant V2 platform on newer Hardware." + } + ] + } + }, + "legacyPortalStatus": { + "description": "Status of legacy portal in the API Management service.", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "type": "string", + "x-ms-enum": { + "name": "LegacyPortalStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Legacy Portal is enabled for the service." + }, + { + "value": "Disabled", + "description": "Legacy Portal is disabled for the service." + } + ] + } + }, + "developerPortalStatus": { + "description": "Status of developer portal in this API Management service.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "default": "Enabled", + "x-ms-enum": { + "name": "developerPortalStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Developer Portal is enabled for the service." + }, + { + "value": "Disabled", + "description": "Developer Portal is disabled for the service." + } + ] + } + } + }, + "description": "Base Properties of an API Management service resource description." + }, + "ApiVersionConstraint": { + "type": "object", + "properties": { + "minApiVersion": { + "type": "string", + "description": "Limit control plane API calls to API Management service with version equal to or newer than this value.", + "example": "2019-01-01" + } + }, + "description": "Control Plane Apis version constraint for the API Management service." + }, + "ApiManagementServiceSkuProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Sku.", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" + }, + "enum": [ + "Developer", + "Standard", + "Premium", + "Basic", + "Consumption", + "Isolated", + "BasicV2", + "StandardV2" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": true, + "values": [ + { + "value": "Developer", + "description": "Developer SKU of Api Management." + }, + { + "value": "Standard", + "description": "Standard SKU of Api Management." + }, + { + "value": "Premium", + "description": "Premium SKU of Api Management." + }, + { + "value": "Basic", + "description": "Basic SKU of Api Management." + }, + { + "value": "Consumption", + "description": "Consumption SKU of Api Management." + }, + { + "value": "Isolated", + "description": "Isolated SKU of Api Management." + }, + { + "value": "BasicV2", + "description": "BasicV2 SKU of Api Management." + }, + { + "value": "StandardV2", + "description": "StandardV2 SKU of Api Management." + } + ] + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0." + } + }, + "required": [ + "name", + "capacity" + ], + "description": "API Management service resource SKU properties." + }, + "ApiManagementServiceResource": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiManagementServiceProperties", + "description": "Properties of the API Management service." + }, + "sku": { + "$ref": "#/definitions/ApiManagementServiceSkuProperties", + "description": "SKU properties of the API Management service." + }, + "identity": { + "$ref": "#/definitions/ApiManagementServiceIdentity", + "description": "Managed service identity of the Api Management service." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Resource location.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "etag": { + "type": "string", + "description": "ETag of the resource.", + "readOnly": true + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApimResource" + } + ], + "required": [ + "location", + "sku", + "properties" + ], + "description": "A single API Management service resource in List or Get response." + }, + "ApimResource": { + "type": "object", + "description": "The Resource definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "type": "string", + "description": "Resource name.", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type for API Management resource is set to Microsoft.ApiManagement." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ApiManagementServiceUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiManagementServiceUpdateProperties", + "description": "Properties of the API Management service." + }, + "sku": { + "$ref": "#/definitions/ApiManagementServiceSkuProperties", + "description": "SKU properties of the API Management service." + }, + "identity": { + "$ref": "#/definitions/ApiManagementServiceIdentity", + "description": "Managed service identity of the Api Management service." + }, + "etag": { + "type": "string", + "description": "ETag of the resource.", + "readOnly": true + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApimResource" + } + ], + "description": "Parameter supplied to Update Api Management Service." + }, + "ApiManagementServiceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiManagementServiceResource" + }, + "description": "Result of the List API Management services operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." + } + }, + "required": [ + "value" + ], + "description": "The response of the List API Management services operation." + }, + "ApiManagementServiceGetSsoTokenResult": { + "type": "object", + "properties": { + "redirectUri": { + "type": "string", + "description": "Redirect URL to the Publisher Portal containing the SSO token." + } + }, + "description": "The response of the GetSsoToken operation." + }, + "ApiManagementServiceCheckNameAvailabilityParameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name to check for availability." + } + }, + "required": [ + "name" + ], + "description": "Parameters supplied to the CheckNameAvailability operation." + }, + "ApiManagementServiceNameAvailabilityResult": { + "type": "object", + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "True if the name is available and can be used to create a new API Management service; otherwise false.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name.", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Valid", + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameAvailabilityReason", + "modelAsString": false + } + } + }, + "description": "Response of the CheckNameAvailability operation." + }, + "ApiManagementServiceGetDomainOwnershipIdentifierResult": { + "type": "object", + "properties": { + "domainOwnershipIdentifier": { + "type": "string", + "description": "The domain ownership identifier value.", + "readOnly": true + } + }, + "description": "Response of the GetDomainOwnershipIdentifier operation." + }, + "ApiManagementServiceApplyNetworkConfigurationParameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required." + } + }, + "description": "Parameter supplied to the Apply Network configuration operation." + }, + "ApiManagementServiceIdentity": { + "type": "object", + "description": "Identity properties of the Api Management service resource.", + "properties": { + "type": { + "type": "string", + "description": "The type of identity used for the resource. 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 service.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ApimIdentityType", + "modelAsString": true + } + }, + "principalId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "The principal id of the identity." + }, + "tenantId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "The client tenant id of the identity." + }, + "userAssignedIdentities": { + "description": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentityProperties" + } + } + }, + "required": [ + "type" + ] + }, + "UserIdentityProperties": { + "type": "object", + "properties": { + "principalId": { + "description": "The principal id of user assigned identity.", + "type": "string" + }, + "clientId": { + "description": "The client id of user assigned identity.", + "type": "string" + } + } + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that describes the operation.", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "operation": { + "description": "Operation type: read, write, delete, listKeys/action, etc.", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "description": "Friendly name of the operation", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The operation origin." + }, + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The operation properties." + } + } + }, + "OperationListResult": { + "type": "object", + "description": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of operations supported by the resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + } + }, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdiagnostics.json new file mode 100644 index 000000000000..ab78c1252f78 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdiagnostics.json @@ -0,0 +1,376 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Diagnostic entity associated with your Azure API Management deployment. Diagnostics are used to log requests/responses in the API Management proxy.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics": { + "get": { + "tags": [ + "Diagnostic" + ], + "operationId": "Diagnostic_ListByService", + "description": "Lists all diagnostics of the API Management service instance.", + "x-ms-examples": { + "ApiManagementListDiagnostics": { + "$ref": "./examples/ApiManagementListDiagnostics.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result response of diagnostics.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticCollection" + } + }, + "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-odata": "./definitions.json#/definitions/DiagnosticContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}": { + "head": { + "tags": [ + "Diagnostic" + ], + "operationId": "Diagnostic_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Diagnostic specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadDiagnostic": { + "$ref": "./examples/ApiManagementHeadDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the entity tag of the diagnostic", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Diagnostic" + ], + "operationId": "Diagnostic_Get", + "description": "Gets the details of the Diagnostic specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetDiagnostic": { + "$ref": "./examples/ApiManagementGetDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Diagnostic entity.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Diagnostic" + ], + "operationId": "Diagnostic_CreateOrUpdate", + "description": "Creates a new Diagnostic or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateDiagnostic": { + "$ref": "./examples/ApiManagementCreateDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Diagnostic was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + } + }, + "200": { + "description": "Diagnostic successfully updated", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Diagnostic" + ], + "operationId": "Diagnostic_Update", + "description": "Updates the details of the Diagnostic specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateDiagnostic": { + "$ref": "./examples/ApiManagementUpdateDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "description": "Diagnostic Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Diagnostic successfully updated", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Diagnostic" + ], + "operationId": "Diagnostic_Delete", + "description": "Deletes the specified Diagnostic.", + "x-ms-examples": { + "ApiManagementDeleteDiagnostic": { + "$ref": "./examples/ApiManagementDeleteDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Diagnostic was successfully deleted." + }, + "204": { + "description": "The Diagnostic was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdocumentations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdocumentations.json new file mode 100644 index 000000000000..431e8dd9c6cc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimdocumentations.json @@ -0,0 +1,376 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Documentation entity.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations": { + "get": { + "tags": [ + "Documentation" + ], + "operationId": "Documentation_ListByService", + "description": "Lists all Documentations of the API Management service instance.", + "x-ms-examples": { + "ApiManagementListApis": { + "$ref": "./examples/ApiManagementListDocumentations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result response of Documentations.", + "schema": { + "$ref": "./definitions.json#/definitions/DocumentationCollection" + } + }, + "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-odata": "./definitions.json#/definitions/DocumentationContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}": { + "head": { + "tags": [ + "Documentation" + ], + "operationId": "Documentation_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Documentation by its identifier.", + "x-ms-examples": { + "ApiManagementHeadDocumentation": { + "$ref": "./examples/ApiManagementHeadDocumentation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DocumentationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Documentation" + ], + "operationId": "Documentation_Get", + "description": "Gets the details of the Documentation specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetDocumentation": { + "$ref": "./examples/ApiManagementGetDocumentation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DocumentationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Documentation entity.", + "schema": { + "$ref": "./definitions.json#/definitions/DocumentationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Documentation" + ], + "operationId": "Documentation_CreateOrUpdate", + "description": "Creates a new Documentation or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateDocumentation": { + "$ref": "./examples/ApiManagementCreateDocumentation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DocumentationIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DocumentationContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Documentation was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/DocumentationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Documentation was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/DocumentationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Documentation" + ], + "operationId": "Documentation_Update", + "description": "Updates the details of the Documentation for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateDocumentation": { + "$ref": "./examples/ApiManagementUpdateDocumentation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DocumentationIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DocumentationUpdateContract" + }, + "description": "Documentation Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Documentation was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/DocumentationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Documentation" + ], + "operationId": "Documentation_Delete", + "description": "Deletes the specified Documentation from an API.", + "x-ms-examples": { + "ApiManagementDeleteDocumentation": { + "$ref": "./examples/ApiManagementDeleteDocumentation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DocumentationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Documentation successfully removed" + }, + "204": { + "description": "Documentation successfully removed by previous request or does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimemailtemplates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimemailtemplates.json new file mode 100644 index 000000000000..5fd3505d50b3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimemailtemplates.json @@ -0,0 +1,363 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Email Templates associated with your Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates": { + "get": { + "tags": [ + "EmailTemplate" + ], + "operationId": "EmailTemplate_ListByService", + "description": "Gets all email templates", + "x-ms-examples": { + "ApiManagementListTemplates": { + "$ref": "./examples/ApiManagementListTemplates.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Email Template for the specified API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateCollection" + } + }, + "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.ApiManagement/service/{serviceName}/templates/{templateName}": { + "head": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_GetEntityTag", + "description": "Gets the entity state (Etag) version of the email template specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadEmailTemplate": { + "$ref": "./examples/ApiManagementHeadEmailTemplate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified email template entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_Get", + "description": "Gets the details of the email template specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetTemplate": { + "$ref": "./examples/ApiManagementGetTemplate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Email template.", + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_CreateOrUpdate", + "description": "Updates an Email Template.", + "x-ms-examples": { + "ApiManagementCreateTemplate": { + "$ref": "./examples/ApiManagementCreateTemplate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateUpdateParameters" + }, + "description": "Email Template update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Email Template was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateContract" + } + }, + "200": { + "description": "Email Template was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_Update", + "description": "Updates API Management email template", + "x-ms-examples": { + "ApiManagementUpdateTemplate": { + "$ref": "./examples/ApiManagementUpdateTemplate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "email template successfully updated", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_Delete", + "description": "Reset the Email Template to default template provided by the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteTemplate": { + "$ref": "./examples/ApiManagementDeleteTemplate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Email Template was successfully reset to default." + }, + "204": { + "description": "Email Template was successfully reset to default." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgatewayConfigConnections.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgatewayConfigConnections.json new file mode 100644 index 000000000000..052e96a8d148 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgatewayConfigConnections.json @@ -0,0 +1,337 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs to manage Azure API Management gateway config connections deployments.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections": { + "get": { + "tags": [ + "ApiGatewayConfigConnection" + ], + "operationId": "ApiGatewayConfigConnection_ListByGateway", + "description": "List all API Management gateway config connections within a gateway.", + "x-ms-examples": { + "ApiManagementListGatewayConfigConnection": { + "$ref": "./examples/ApiManagementListGatewayConfigConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "The API Management gateway config connection list.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayConfigConnectionListResult" + } + }, + "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.ApiManagement/gateways/{gatewayName}/configConnections/{configConnectionName}": { + "get": { + "tags": [ + "ApiGatewayConfigConnection" + ], + "operationId": "ApiGatewayConfigConnection_Get", + "description": "Gets an API Management gateway config connection resource description.", + "x-ms-examples": { + "ApiManagementGetGatewayConfigConnection": { + "$ref": "./examples/ApiManagementGetGatewayConfigConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ConfigConnectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully got the API Management gateway config connection resource.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiGatewayConfigConnection" + ], + "operationId": "ApiGatewayConfigConnection_CreateOrUpdate", + "description": "Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementCreateGatewayConfigConnection": { + "$ref": "./examples/ApiManagementCreateGatewayConfigConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ConfigConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" + }, + "description": "Parameters supplied to the CreateOrUpdate API Management gateway config connection operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The gateway config connection was successfully updated.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" + } + }, + "201": { + "description": "The gateway config connection was successfully created.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" + } + }, + "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" + } + }, + "delete": { + "tags": [ + "ApiGatewayConfigConnection" + ], + "operationId": "ApiGatewayConfigConnection_Delete", + "description": "Deletes an existing API Management gateway config connection.", + "x-ms-examples": { + "ApiManagementGatewayDeleteGateway": { + "$ref": "./examples/ApiManagementDeleteGatewayConfigConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ConfigConnectionNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "The gateway config connection delete request was accepted.", + "headers": { + "location": { + "description": "Location header", + "type": "string" + } + } + }, + "204": { + "description": "The gateway config 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 + } + } + }, + "definitions": { + "GatewayConfigConnectionBaseProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state of the API Management gateway config connection ", + "enum": [ + "Activating", + "Canceled", + "Failed", + "Succeeded", + "Terminating", + "Upgrading", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "sourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ApiManagement/service/workspaces" + } + ] + }, + "description": "The link to the API Management service workspace." + }, + "defaultHostname": { + "readOnly": true, + "type": "string", + "description": "The default hostname of the data-plane gateway." + }, + "hostnames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The hostnames of the data-plane gateway to which requests can be sent." + } + } + }, + "ApiManagementGatewayConfigConnectionResource": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GatewayConfigConnectionBaseProperties", + "description": "Properties of the API Management gateway config connection." + }, + "etag": { + "type": "string", + "description": "ETag of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "description": "A single API Management gateway resource in List or Get response." + }, + "ApiManagementGatewayConfigConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" + }, + "description": "Result of the List API Management gateway config connection operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." + } + }, + "required": [ + "value" + ], + "description": "The response of the List API Management gateway operation." + } + }, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgateways.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgateways.json new file mode 100644 index 000000000000..50a7b6209a10 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgateways.json @@ -0,0 +1,1475 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Gateway entity in Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways": { + "get": { + "tags": [ + "Gateway" + ], + "operationId": "Gateway_ListByService", + "description": "Lists a collection of gateways registered with service instance.", + "x-ms-examples": { + "ApiManagementListGateways": { + "$ref": "./examples/ApiManagementListGateways.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Gateway entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayCollection" + } + }, + "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-odata": "./definitions.json#/definitions/GatewayContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}": { + "head": { + "tags": [ + "Gateway" + ], + "operationId": "Gateway_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Gateway specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadGateway": { + "$ref": "./examples/ApiManagementHeadGateway.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Gateway entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Gateway" + ], + "operationId": "Gateway_Get", + "description": "Gets the details of the Gateway specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetGateway": { + "$ref": "./examples/ApiManagementGetGateway.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Gateway entity.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Gateway" + ], + "operationId": "Gateway_CreateOrUpdate", + "description": "Creates or updates a Gateway to be used in Api Management instance.", + "x-ms-examples": { + "ApiManagementCreateGateway": { + "$ref": "./examples/ApiManagementCreateGateway.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayContract" + } + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new Gateway was successfully added.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayContract" + } + }, + "200": { + "description": "The Gateway details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Gateway" + ], + "operationId": "Gateway_Update", + "description": "Updates the details of the gateway specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateGateway": { + "$ref": "./examples/ApiManagementUpdateGateway.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayContract" + } + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Gateway details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Gateway" + ], + "operationId": "Gateway_Delete", + "description": "Deletes specific Gateway.", + "x-ms-examples": { + "ApiManagementDeleteGateway": { + "$ref": "./examples/ApiManagementDeleteGateway.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Gateway was successfully deleted." + }, + "204": { + "description": "The Gateway was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys": { + "post": { + "tags": [ + "GatewayListKeys" + ], + "operationId": "Gateway_ListKeys", + "description": "Retrieves gateway keys.", + "x-ms-examples": { + "ApiManagementGatewayListKeys": { + "$ref": "./examples/ApiManagementGatewayListKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Gateway keys.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayKeysContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey": { + "post": { + "tags": [ + "GatewayRegenerateKey" + ], + "operationId": "Gateway_RegenerateKey", + "description": "Regenerates specified gateway key invalidating any tokens created with it.", + "x-ms-examples": { + "ApiManagementGatewayRegenerateKey": { + "$ref": "./examples/ApiManagementGatewayRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayKeyRegenerationRequestContract" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Key successfully regenerated" + }, + "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken": { + "post": { + "tags": [ + "GatewayGenerateToken" + ], + "operationId": "Gateway_GenerateToken", + "description": "Gets the Shared Access Authorization Token for the gateway.", + "x-ms-examples": { + "ApiManagementGatewayGenerateToken": { + "$ref": "./examples/ApiManagementGatewayGenerateToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayTokenRequestContract" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the authorization token for the gateway.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayTokenContract" + } + }, + "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations": { + "get": { + "tags": [ + "GatewayHostnameConfiguration" + ], + "operationId": "GatewayHostnameConfiguration_ListByService", + "description": "Lists the collection of hostname configurations for the specified gateway.", + "x-ms-examples": { + "ApiManagementListGatewayHostnameConfigurations": { + "$ref": "./examples/ApiManagementListGatewayHostnameConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| hostname | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Collection of hostname configuration entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationCollection" + } + }, + "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-odata": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}": { + "head": { + "tags": [ + "GatewayHostnameConfiguration" + ], + "operationId": "GatewayHostnameConfiguration_GetEntityTag", + "description": "Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.", + "x-ms-examples": { + "ApiManagementHeadGatewayHostnameConfiguration": { + "$ref": "./examples/ApiManagementHeadGatewayHostnameConfiguration.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayHostnameConfigurationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Gateway entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "GatewayHostnameConfiguration" + ], + "operationId": "GatewayHostnameConfiguration_Get", + "description": "Get details of a hostname configuration", + "x-ms-examples": { + "ApiManagementGetGatewayHostnameConfiguration": { + "$ref": "./examples/ApiManagementGetGatewayHostnameConfiguration.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayHostnameConfigurationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Gateway entity.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "GatewayHostnameConfiguration" + ], + "operationId": "GatewayHostnameConfiguration_CreateOrUpdate", + "description": "Creates of updates hostname configuration for a Gateway.", + "x-ms-examples": { + "ApiManagementCreateGatewayHostnameConfiguration": { + "$ref": "./examples/ApiManagementCreateGatewayHostnameConfiguration.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayHostnameConfigurationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new Gateway hostname configuration was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" + } + }, + "200": { + "description": "The Gateway hostname configuration details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GatewayHostnameConfiguration" + ], + "operationId": "GatewayHostnameConfiguration_Delete", + "description": "Deletes the specified hostname configuration from the specified Gateway.", + "x-ms-examples": { + "ApiManagementDeleteGatewayHostnameConfiguration": { + "$ref": "./examples/ApiManagementDeleteGatewayHostnameConfiguration.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayHostnameConfigurationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Hostname configuration was successfully removed from Gateway." + }, + "204": { + "description": "Hostname configuration successfully removed by previous request or does not exist in Gateway." + }, + "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis": { + "get": { + "tags": [ + "GatewayApi" + ], + "operationId": "GatewayApi_ListByService", + "description": "Lists a collection of the APIs associated with a gateway.", + "x-ms-examples": { + "ApiManagementListGatewayApis": { + "$ref": "./examples/ApiManagementListGatewayApis.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of Api entities in the gateway.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ApiContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}": { + "head": { + "tags": [ + "GatewayApi" + ], + "operationId": "GatewayApi_GetEntityTag", + "description": "Checks that API entity specified by identifier is associated with the Gateway entity.", + "x-ms-examples": { + "ApiManagementHeadGatewayApi": { + "$ref": "./examples/ApiManagementHeadGatewayApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Gateway entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "GatewayApi" + ], + "operationId": "GatewayApi_CreateOrUpdate", + "description": "Adds an API to the specified Gateway.", + "x-ms-examples": { + "ApiManagementCreateGatewayApi": { + "$ref": "./examples/ApiManagementCreateGatewayApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "./definitions.json#/definitions/AssociationContract" + } + } + ], + "responses": { + "201": { + "description": "The API was successfully added to the Gateway.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + } + }, + "200": { + "description": "The specified API is already added to the Gateway.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GatewayApi" + ], + "operationId": "GatewayApi_Delete", + "description": "Deletes the specified API from the specified Gateway.", + "x-ms-examples": { + "ApiManagementDeleteGatewayApi": { + "$ref": "./examples/ApiManagementDeleteGatewayApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API was successfully removed from Gateway" + }, + "204": { + "description": "API successfully removed by previous request or does not exist in Gateway" + }, + "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities": { + "get": { + "tags": [ + "GatewayCertificateAuthority" + ], + "operationId": "GatewayCertificateAuthority_ListByService", + "description": "Lists the collection of Certificate Authorities for the specified Gateway entity.", + "x-ms-examples": { + "ApiManagementListGatewaycertificateAuthorities": { + "$ref": "./examples/ApiManagementListGatewayCertificateAuthorities.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq, ne | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Collection of Gateway Certificate Authority entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityCollection" + } + }, + "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-odata": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}": { + "head": { + "tags": [ + "GatewayCertificateAuthority" + ], + "operationId": "GatewayCertificateAuthority_GetEntityTag", + "description": "Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.", + "x-ms-examples": { + "ApiManagementHeadGatewayCertificateAuthority": { + "$ref": "./examples/ApiManagementHeadGatewayCertificateAuthority.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Gateway Certificate Authority entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "GatewayCertificateAuthority" + ], + "operationId": "GatewayCertificateAuthority_Get", + "description": "Get assigned Gateway Certificate Authority details.", + "x-ms-examples": { + "ApiManagementGetGatewayCertificateAuthority": { + "$ref": "./examples/ApiManagementGetGatewayCertificateAuthority.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Gateway Certificate Authority entity.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "GatewayCertificateAuthority" + ], + "operationId": "GatewayCertificateAuthority_CreateOrUpdate", + "description": "Assign Certificate entity to Gateway entity as Certificate Authority.", + "x-ms-examples": { + "ApiManagementCreateGatewayCertificateAuthority": { + "$ref": "./examples/ApiManagementCreateGatewayCertificateAuthority.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Certificate entity was successfully assigned to Gateway entity as Certificate Authority.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" + } + }, + "200": { + "description": "Gateway Certificate Authority details were successfully updated", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GatewayCertificateAuthority" + ], + "operationId": "GatewayCertificateAuthority_Delete", + "description": "Remove relationship between Certificate Authority and Gateway entity.", + "x-ms-examples": { + "ApiManagementDeleteGatewayCertificateAuthority": { + "$ref": "./examples/ApiManagementDeleteGatewayCertificateAuthority.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Certificate entity was successfully removed from Gateway entity as Certificate Authority." + }, + "204": { + "description": "Certificate was successfully removed from Gateway entity as Certificate Authority by one of the previous requests or never assigned." + }, + "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/invalidateDebugCredentials": { + "post": { + "tags": [ + "GatewayInvalidateDebugCredentials" + ], + "operationId": "Gateway_InvalidateDebugCredentials", + "description": "Action is invalidating all debug credentials issued for gateway.", + "x-ms-examples": { + "ApiManagementGatewayInvalidateDebugCredentials": { + "$ref": "./examples/ApiManagementGatewayInvalidateDebugCredentials.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "All debug credentials for gateway are now invalidated." + }, + "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listDebugCredentials": { + "post": { + "tags": [ + "GatewayListDebugCredentials" + ], + "operationId": "Gateway_ListDebugCredentials", + "description": "Create new debug credentials for gateway.", + "x-ms-examples": { + "ApiManagementGatewayListDebugCredentials": { + "$ref": "./examples/ApiManagementGatewayListDebugCredentials.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "List debug credentials properties.", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayListDebugCredentialsContract" + } + } + ], + "responses": { + "200": { + "description": "The response body contains debug credentials to use in gateway.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayDebugCredentialsContract" + } + }, + "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listTrace": { + "post": { + "tags": [ + "GatewayListTrace" + ], + "operationId": "Gateway_ListTrace", + "description": "Fetches trace collected by gateway.", + "x-ms-examples": { + "ApiManagementGatewayListTrace": { + "$ref": "./examples/ApiManagementGatewayListTrace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "List trace properties.", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayListTraceContract" + } + } + ], + "responses": { + "200": { + "description": "The response body contains trace collected by gateway.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayTraceContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgroups.json new file mode 100644 index 000000000000..bc1a1657ec05 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgroups.json @@ -0,0 +1,590 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Group entity in your Azure API Management deployment. Groups are used to manage the visibility of products to developers. Each API Management service instance comes with the following immutable system groups whose membership is automatically managed by API Management. - **Administrators** - Azure subscription administrators are members of this group. - **Developers** - Authenticated developer portal users fall into this group. - **Guests** - Unauthenticated developer portal users are placed into this group. In addition to these system groups, administrators can create custom groups or [leverage external groups in associated Azure Active Directory tenants](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-aad#how-to-add-an-external-azure-active-directory-group). Custom and external groups can be used alongside system groups in giving developers visibility and access to API products. For example, you could create one custom group for developers affiliated with a specific partner organization and allow them access to the APIs from a product containing relevant APIs only. A user can be a member of more than one group.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups": { + "get": { + "tags": [ + "Group" + ], + "operationId": "Group_ListByService", + "description": "Lists a collection of groups defined within a service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-groups" + }, + "x-ms-examples": { + "ApiManagementListGroups": { + "$ref": "./examples/ApiManagementListGroups.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| externalId | filter | eq | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Group entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupCollection" + } + }, + "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-odata": "./definitions.json#/definitions/GroupContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}": { + "head": { + "tags": [ + "Group" + ], + "operationId": "Group_GetEntityTag", + "description": "Gets the entity state (Etag) version of the group specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadGroup": { + "$ref": "./examples/ApiManagementHeadGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified group entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Group" + ], + "operationId": "Group_Get", + "description": "Gets the details of the group specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetGroup": { + "$ref": "./examples/ApiManagementGetGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Group entity.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Group" + ], + "operationId": "Group_CreateOrUpdate", + "description": "Creates or Updates a group.", + "x-ms-examples": { + "ApiManagementCreateGroup": { + "$ref": "./examples/ApiManagementCreateGroup.json" + }, + "ApiManagementCreateGroupExternal": { + "$ref": "./examples/ApiManagementCreateGroupExternal.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GroupCreateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Group was created successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Group already exists.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Group" + ], + "operationId": "Group_Update", + "description": "Updates the details of the group specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateGroup": { + "$ref": "./examples/ApiManagementUpdateGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GroupUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The group details were successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Group" + ], + "operationId": "Group_Delete", + "description": "Deletes specific group of the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteGroup": { + "$ref": "./examples/ApiManagementDeleteGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The group was successfully deleted." + }, + "204": { + "description": "The group was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/groups/{groupId}/users": { + "get": { + "tags": [ + "GroupUser" + ], + "operationId": "GroupUser_List", + "description": "Lists a collection of user entities associated with the group.", + "x-ms-examples": { + "ApiManagementListGroupUsers": { + "$ref": "./examples/ApiManagementListGroupUsers.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of user entities associated with the group.", + "schema": { + "$ref": "./definitions.json#/definitions/UserCollection" + } + }, + "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-odata": "./definitions.json#/definitions/UserContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}": { + "head": { + "tags": [ + "GroupUser" + ], + "operationId": "GroupUser_CheckEntityExists", + "description": "Checks that user entity specified by identifier is associated with the group entity.", + "x-ms-examples": { + "ApiManagementHeadGroupUser": { + "$ref": "./examples/ApiManagementHeadGroupUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Entity exists" + }, + "404": { + "description": "Entity does not exists." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "GroupUser" + ], + "operationId": "GroupUser_Create", + "description": "Add existing user to existing group", + "x-ms-examples": { + "ApiManagementCreateGroupUser": { + "$ref": "./examples/ApiManagementCreateGroupUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The user was successfully added to the group.", + "schema": { + "$ref": "./definitions.json#/definitions/UserContract" + } + }, + "200": { + "description": "The specified user is already a member of the specified group.", + "schema": { + "$ref": "./definitions.json#/definitions/UserContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GroupUser" + ], + "operationId": "GroupUser_Delete", + "description": "Remove existing user from existing group.", + "x-ms-examples": { + "ApiManagementDeleteGroupUser": { + "$ref": "./examples/ApiManagementDeleteGroupUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The user was successfully removed from the group." + }, + "204": { + "description": "The user was successfully removed from the group." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimidentityprovider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimidentityprovider.json new file mode 100644 index 000000000000..d70ffad8c60b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimidentityprovider.json @@ -0,0 +1,416 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Identity Provider entity associated with your Azure API Management deployment. Setting up an external Identity Provider for authentication can help you manage the developer portal logins using the OAuth2 flow.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders": { + "get": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_ListByService", + "description": "Lists a collection of Identity Provider configured in the specified service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-aad#how-to-authorize-developer-accounts-using-azure-active-directory" + }, + "x-ms-examples": { + "ApiManagementListIdentityProviders": { + "$ref": "./examples/ApiManagementListIdentityProviders.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Identity Providers.", + "schema": { + "$ref": "./definitions.json#/definitions/IdentityProviderList" + } + }, + "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.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}": { + "head": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_GetEntityTag", + "description": "Gets the entity state (Etag) version of the identityProvider specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadIdentityProvider": { + "$ref": "./examples/ApiManagementHeadIdentityProvider.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified identity provider entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_Get", + "description": "Gets the configuration details of the identity Provider configured in specified service instance.", + "x-ms-examples": { + "ApiManagementGetIdentityProvider": { + "$ref": "./examples/ApiManagementGetIdentityProvider.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified IdentityProvider entity configuration details.", + "schema": { + "$ref": "./definitions.json#/definitions/IdentityProviderContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_CreateOrUpdate", + "description": "Creates or Updates the IdentityProvider configuration.", + "x-ms-examples": { + "ApiManagementCreateIdentityProvider": { + "$ref": "./examples/ApiManagementCreateIdentityProvider.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/IdentityProviderCreateContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "IdentityProvider configuration were successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/IdentityProviderContract" + } + }, + "200": { + "description": "The existing Identity Provider was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/IdentityProviderContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_Update", + "description": "Updates an existing IdentityProvider configuration.", + "x-ms-examples": { + "ApiManagementUpdateIdentityProvider": { + "$ref": "./examples/ApiManagementUpdateIdentityProvider.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/IdentityProviderUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing Identity Provider was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/IdentityProviderContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_Delete", + "description": "Deletes the specified identity provider configuration.", + "x-ms-examples": { + "ApiManagementDeleteIdentityProvider": { + "$ref": "./examples/ApiManagementDeleteIdentityProvider.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The identity provider configuration was successfully deleted." + }, + "204": { + "description": "The identity provider configuration was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}/listSecrets": { + "post": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_ListSecrets", + "description": "Gets the client secret details of the Identity Provider.", + "x-ms-examples": { + "ApiManagementIdentityProviderListSecrets": { + "$ref": "./examples/ApiManagementIdentityProviderListSecrets.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the client secret.", + "schema": { + "$ref": "./definitions.json#/definitions/ClientSecretContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimissues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimissues.json new file mode 100644 index 000000000000..e378c2774551 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimissues.json @@ -0,0 +1,150 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use this REST API to get all the issues across an Azure Api Management service.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues": { + "get": { + "tags": [ + "Issue" + ], + "operationId": "Issue_ListByService", + "description": "Lists a collection of issues in the specified service instance.", + "x-ms-examples": { + "ApiManagementListIssues": { + "$ref": "./examples/ApiManagementListIssues.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| authorName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Issue entities.", + "schema": { + "$ref": "./definitions.json#/definitions/IssueCollection" + } + }, + "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-odata": "./definitions.json#/definitions/IssueContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues/{issueId}": { + "get": { + "tags": [ + "Issue" + ], + "operationId": "Issue_Get", + "description": "Gets API Management issue details", + "x-ms-examples": { + "ApiManagementGetIssue": { + "$ref": "./examples/ApiManagementGetIssue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get the details of the issue.", + "schema": { + "$ref": "./definitions.json#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimloggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimloggers.json new file mode 100644 index 000000000000..df6443879553 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimloggers.json @@ -0,0 +1,382 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on logger entity Azure API Management deployment.The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure EventHub.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers": { + "get": { + "tags": [ + "Logger" + ], + "operationId": "Logger_ListByService", + "description": "Lists a collection of loggers in the specified service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-log-event-hubs" + }, + "x-ms-examples": { + "ApiManagementListLoggers": { + "$ref": "./examples/ApiManagementListLoggers.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Logger entities.", + "schema": { + "$ref": "./definitions.json#/definitions/LoggerCollection" + } + }, + "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-odata": "./definitions.json#/definitions/LoggerContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}": { + "head": { + "tags": [ + "Logger" + ], + "operationId": "Logger_GetEntityTag", + "description": "Gets the entity state (Etag) version of the logger specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadLogger": { + "$ref": "./examples/ApiManagementHeadLogger.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified logger entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Logger" + ], + "operationId": "Logger_Get", + "description": "Gets the details of the logger specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetLogger": { + "$ref": "./examples/ApiManagementGetLogger.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Logger entity.", + "schema": { + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Logger" + ], + "operationId": "Logger_CreateOrUpdate", + "description": "Creates or Updates a logger.", + "x-ms-examples": { + "ApiManagementCreateEHLogger": { + "$ref": "./examples/ApiManagementCreateEHLogger.json" + }, + "ApiManagementCreateAILogger": { + "$ref": "./examples/ApiManagementCreateAILogger.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Logger was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "The existing logger was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Logger" + ], + "operationId": "Logger_Update", + "description": "Updates an existing logger.", + "x-ms-examples": { + "ApiManagementUpdateLogger": { + "$ref": "./examples/ApiManagementUpdateLogger.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/LoggerUpdateContract" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing logger was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Logger" + ], + "operationId": "Logger_Delete", + "description": "Deletes the specified logger.", + "x-ms-examples": { + "ApiManagementDeleteLogger": { + "$ref": "./examples/ApiManagementDeleteLogger.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The logger was successfully deleted." + }, + "204": { + "description": "The logger was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimnamedvalues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimnamedvalues.json new file mode 100644 index 000000000000..67c6b71de680 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimnamedvalues.json @@ -0,0 +1,548 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on NamedValue entity associated with your Azure API Management deployment. API Management policies are a powerful capability of the system that allow the publisher to change the behavior of the API through configuration. Policies are a collection of statements that are executed sequentially on the request or response of an API. Policy statements can be constructed using literal text values, policy expressions, and NamedValues. Each API Management service instance has a NamedValues collection of key/value pairs that are global to the service instance. These NamedValues can be used to manage constant string values across all API configuration and policies.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues": { + "get": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_ListByService", + "description": "Lists a collection of named values defined within a service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties" + }, + "x-ms-examples": { + "ApiManagementListNamedValues": { + "$ref": "./examples/ApiManagementListNamedValues.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "isKeyVaultRefreshFailed", + "in": "query", + "required": false, + "type": "boolean", + "description": "When set to true, the response contains only named value entities which failed refresh." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the named value entities for the specified API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueCollection" + } + }, + "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-odata": "./definitions.json#/definitions/NamedValueContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}": { + "head": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_GetEntityTag", + "description": "Gets the entity state (Etag) version of the named value specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadNamedValue": { + "$ref": "./examples/ApiManagementHeadNamedValue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified named value entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_Get", + "description": "Gets the details of the named value specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetNamedValue": { + "$ref": "./examples/ApiManagementGetNamedValue.json" + }, + "ApiManagementGetNamedValueWithKeyVault": { + "$ref": "./examples/ApiManagementGetNamedValueWithKeyVault.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified named value entity. No secrets included", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_CreateOrUpdate", + "description": "Creates or updates named value.", + "x-ms-examples": { + "ApiManagementCreateNamedValue": { + "$ref": "./examples/ApiManagementCreateNamedValue.json" + }, + "ApiManagementCreateNamedValueWithKeyVault": { + "$ref": "./examples/ApiManagementCreateNamedValueWithKeyVault.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueCreateContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Named value was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "200": { + "description": "Named value was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "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" + } + }, + "patch": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_Update", + "description": "Updates the specific named value.", + "x-ms-examples": { + "ApiManagementUpdateNamedValue": { + "$ref": "./examples/ApiManagementUpdateNamedValue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Request to create or update named value was accepted.", + "headers": { + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "200": { + "description": "Named value was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "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" + } + }, + "delete": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_Delete", + "description": "Deletes specific named value from the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteNamedValue": { + "$ref": "./examples/ApiManagementDeleteNamedValue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Named value was successfully deleted." + }, + "204": { + "description": "Named value was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/namedValues/{namedValueId}/listValue": { + "post": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_ListValue", + "description": "Gets the secret of the named value specified by its identifier.", + "x-ms-examples": { + "ApiManagementNamedValueListValue": { + "$ref": "./examples/ApiManagementNamedValueListValue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified named value secret.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueSecretContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "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.ApiManagement/service/{serviceName}/namedValues/{namedValueId}/refreshSecret": { + "post": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_RefreshSecret", + "description": "Refresh the secret of the named value specified by its identifier.", + "x-ms-examples": { + "ApiManagementRefreshNamedValue": { + "$ref": "./examples/ApiManagementRefreshNamedValue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Request to refresh secret was accepted.", + "headers": { + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "200": { + "description": "Named value was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "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": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimnetworkstatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimnetworkstatus.json new file mode 100644 index 000000000000..42e130519f32 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimnetworkstatus.json @@ -0,0 +1,226 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for getting the network connectivity status of your Azure API Management deployment. When the API Management service is deployed inside a Virtual Network, it needs to have access to other Azure resources it depends on. This also gives details about the DNS Servers visible to Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/networkstatus": { + "get": { + "tags": [ + "NetworkStatus" + ], + "operationId": "NetworkStatus_ListByService", + "description": "Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.", + "x-ms-examples": { + "ApiManagementServiceGetNetworkStatus": { + "$ref": "./examples/ApiManagementServiceGetNetworkStatus.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Gets the list Network status details for all regions in which service is deployed.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkStatusContractByLocation" + }, + "description": "List of Network Status values." + } + }, + "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.ApiManagement/service/{serviceName}/locations/{locationName}/networkstatus": { + "get": { + "tags": [ + "NetworkStatus" + ], + "operationId": "NetworkStatus_ListByLocation", + "description": "Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.", + "x-ms-examples": { + "ApiManagementServiceGetNetworkStatusByLocation": { + "$ref": "./examples/ApiManagementServiceGetNetworkStatusByLocation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Gets the Network status details.", + "schema": { + "$ref": "#/definitions/NetworkStatusContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ConnectivityStatusContract": { + "properties": { + "name": { + "type": "string", + "description": "The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon.", + "minLength": 1 + }, + "status": { + "type": "string", + "enum": [ + "initializing", + "success", + "failure" + ], + "x-ms-enum": { + "name": "ConnectivityStatusType", + "modelAsString": true + }, + "description": "Resource Connectivity Status Type identifier." + }, + "error": { + "type": "string", + "description": "Error details of the connectivity to the resource." + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "lastStatusChange": { + "type": "string", + "format": "date-time", + "description": "The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "resourceType": { + "type": "string", + "description": "Resource Type." + }, + "isOptional": { + "type": "boolean", + "description": "Whether this is optional." + } + }, + "required": [ + "name", + "status", + "lastUpdated", + "lastStatusChange", + "resourceType", + "isOptional" + ], + "description": "Details about connectivity to a resource." + }, + "NetworkStatusContractByLocation": { + "properties": { + "location": { + "type": "string", + "description": "Location of service", + "minLength": 1 + }, + "networkStatus": { + "$ref": "#/definitions/NetworkStatusContract", + "description": "Network status in Location" + } + }, + "description": "Network Status in the Location" + }, + "NetworkStatusContract": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets the list of DNS servers IPV4 addresses." + }, + "connectivityStatus": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectivityStatusContract" + }, + "x-ms-identifiers": [ + "name", + "resourceType" + ], + "description": "Gets the list of Connectivity Status to the Resources on which the service depends upon." + } + }, + "required": [ + "dnsServers", + "connectivityStatus" + ], + "description": "Network Status details." + } + }, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimnotifications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimnotifications.json new file mode 100644 index 000000000000..5db68d46b768 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimnotifications.json @@ -0,0 +1,564 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on who is going to receive notifications associated with your Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications": { + "get": { + "tags": [ + "Notification" + ], + "operationId": "Notification_ListByService", + "description": "Lists a collection of properties defined within a service instance.", + "x-ms-examples": { + "ApiManagementListNotifications": { + "$ref": "./examples/ApiManagementListNotifications.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Notification for the specified API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/NotificationCollection" + } + }, + "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.ApiManagement/service/{serviceName}/notifications/{notificationName}": { + "get": { + "tags": [ + "Notification" + ], + "operationId": "Notification_Get", + "description": "Gets the details of the Notification specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetNotification": { + "$ref": "./examples/ApiManagementGetNotification.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Notification.", + "schema": { + "$ref": "./definitions.json#/definitions/NotificationContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Notification" + ], + "operationId": "Notification_CreateOrUpdate", + "description": "Create or Update API Management publisher notification.", + "x-ms-examples": { + "ApiManagementCreateNotification": { + "$ref": "./examples/ApiManagementCreateNotification.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Notification was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/NotificationContract" + } + }, + "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.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers": { + "get": { + "tags": [ + "NotificationRecipientUser" + ], + "operationId": "NotificationRecipientUser_ListByNotification", + "description": "Gets the list of the Notification Recipient User subscribed to the notification.", + "x-ms-examples": { + "ApiManagementListNotificationRecipientUsers": { + "$ref": "./examples/ApiManagementListNotificationRecipientUsers.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the Recipient User collection for the notification.", + "schema": { + "$ref": "./definitions.json#/definitions/RecipientUserCollection" + } + }, + "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.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{userId}": { + "head": { + "tags": [ + "NotificationRecipientUser" + ], + "operationId": "NotificationRecipientUser_CheckEntityExists", + "description": "Determine if the Notification Recipient User is subscribed to the notification.", + "x-ms-examples": { + "ApiManagementHeadNotificationRecipientUser": { + "$ref": "./examples/ApiManagementHeadNotificationRecipientUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The User is subscribed to receive the notification." + }, + "404": { + "description": "Entity does not exists." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "NotificationRecipientUser" + ], + "operationId": "NotificationRecipientUser_CreateOrUpdate", + "description": "Adds the API Management User to the list of Recipients for the Notification.", + "x-ms-examples": { + "ApiManagementCreateNotificationRecipientUser": { + "$ref": "./examples/ApiManagementCreateNotificationRecipientUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Recipient User was successfully added to the notification list.", + "schema": { + "$ref": "./definitions.json#/definitions/RecipientUserContract" + } + }, + "200": { + "description": "Recipient User is already part of the notification list.", + "schema": { + "$ref": "./definitions.json#/definitions/RecipientUserContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "NotificationRecipientUser" + ], + "operationId": "NotificationRecipientUser_Delete", + "description": "Removes the API Management user from the list of Notification.", + "x-ms-examples": { + "ApiManagementDeleteNotificationRecipientUser": { + "$ref": "./examples/ApiManagementDeleteNotificationRecipientUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Recipient User was successfully removed from the notification list." + }, + "204": { + "description": "Recipient User was successfully removed from the notification list." + }, + "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.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails": { + "get": { + "tags": [ + "NotificationRecipientEmail" + ], + "operationId": "NotificationRecipientEmail_ListByNotification", + "description": "Gets the list of the Notification Recipient Emails subscribed to a notification.", + "x-ms-examples": { + "ApiManagementListNotificationRecipientEmails": { + "$ref": "./examples/ApiManagementListNotificationRecipientEmails.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the Recipient Email collection subscribed to the notification.", + "schema": { + "$ref": "./definitions.json#/definitions/RecipientEmailCollection" + } + }, + "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.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}": { + "head": { + "tags": [ + "NotificationRecipientEmail" + ], + "operationId": "NotificationRecipientEmail_CheckEntityExists", + "description": "Determine if Notification Recipient Email subscribed to the notification.", + "x-ms-examples": { + "ApiManagementHeadNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementHeadNotificationRecipientEmail.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/EmailParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The Users is subscribed to receive the notification." + }, + "404": { + "description": "The Users is not subscribed to receive the notification." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "NotificationRecipientEmail" + ], + "operationId": "NotificationRecipientEmail_CreateOrUpdate", + "description": "Adds the Email address to the list of Recipients for the Notification.", + "x-ms-examples": { + "ApiManagementCreateNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementCreateNotificationRecipientEmail.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/EmailParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Recipient Email was successfully added to the notification list.", + "schema": { + "$ref": "./definitions.json#/definitions/RecipientEmailContract" + } + }, + "200": { + "description": "Recipient Email is already part of the notification list.", + "schema": { + "$ref": "./definitions.json#/definitions/RecipientEmailContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "NotificationRecipientEmail" + ], + "operationId": "NotificationRecipientEmail_Delete", + "description": "Removes the email from the list of Notification.", + "x-ms-examples": { + "ApiManagementDeleteNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementDeleteNotificationRecipientEmail.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/EmailParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Recipient Email was successfully removed to the notification list." + }, + "204": { + "description": "Recipient Email was successfully removed to the notification list." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimopenidconnectproviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimopenidconnectproviders.json new file mode 100644 index 000000000000..45663174d02f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimopenidconnectproviders.json @@ -0,0 +1,427 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on OpenId Connect Provider entity associated with your Azure API Management deployment. API Management allows you to access APIs secured with token from [OpenID Connect Provider ](http://openid.net/connect/) to be accessed from the Developer Console.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders": { + "get": { + "tags": [ + "OpenidConnectProvider" + ], + "operationId": "OpenIdConnectProvider_ListByService", + "description": "Lists of all the OpenId Connect Providers.", + "x-ms-examples": { + "ApiManagementListOpenIdConnectProviders": { + "$ref": "./examples/ApiManagementListOpenIdConnectProviders.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists of all the OpenId Connect Providers.", + "schema": { + "$ref": "./definitions.json#/definitions/OpenIdConnectProviderCollection" + } + }, + "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-odata": "./definitions.json#/definitions/OpenidConnectProviderContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}": { + "head": { + "tags": [ + "OpenidConnectProvider" + ], + "operationId": "OpenIdConnectProvider_GetEntityTag", + "description": "Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementHeadOpenIdConnectProvider.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified openidConnectProvider entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "OpenidConnectProvider" + ], + "operationId": "OpenIdConnectProvider_Get", + "description": "Gets specific OpenID Connect Provider without secrets.", + "x-ms-examples": { + "ApiManagementGetOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementGetOpenIdConnectProvider.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified OpenId Connect Provider entity without secrets.", + "schema": { + "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OpenidConnectProvider" + ], + "operationId": "OpenIdConnectProvider_CreateOrUpdate", + "description": "Creates or updates the OpenID Connect Provider.", + "x-ms-examples": { + "ApiManagementCreateOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementCreateOpenIdConnectProvider.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "OpenIdConnect Provider was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" + } + }, + "200": { + "description": "OpenIdConnect Provider was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "OpenidConnectProvider" + ], + "operationId": "OpenIdConnectProvider_Update", + "description": "Updates the specific OpenID Connect Provider.", + "x-ms-examples": { + "ApiManagementUpdateOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementUpdateOpenIdConnectProvider.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/OpenidConnectProviderUpdateContract" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OpenIdConnect Provider was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "OpenidConnectProvider" + ], + "operationId": "OpenIdConnectProvider_Delete", + "description": "Deletes specific OpenID Connect Provider of the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementDeleteOpenIdConnectProvider.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OpenId Connect Provider was successfully deleted." + }, + "204": { + "description": "OpenId Connect Provider was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}/listSecrets": { + "post": { + "tags": [ + "OpenidConnectProvider" + ], + "operationId": "OpenIdConnectProvider_ListSecrets", + "description": "Gets the client secret details of the OpenID Connect Provider.", + "x-ms-examples": { + "ApiManagementOpenidConnectProviderListSecrets": { + "$ref": "./examples/ApiManagementOpenidConnectProviderListSecrets.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified OpenId Connect Provider secrets.", + "schema": { + "$ref": "./definitions.json#/definitions/ClientSecretContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimoutbounddependency.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimoutbounddependency.json new file mode 100644 index 000000000000..78f0085ac051 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimoutbounddependency.json @@ -0,0 +1,161 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for getting the outbound network dependency of your Azure API Management deployment. When the API Management service is deployed inside a Virtual Network, it needs to have access to other Azure resources it depends on. This also gives details about the DNS Servers visible to Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "OutboundNetworkDependenciesEndpoints" + ], + "operationId": "OutboundNetworkDependenciesEndpoints_ListByService", + "description": "Gets the network endpoints of all outbound dependencies of a ApiManagement service.", + "x-ms-examples": { + "ApiManagementServiceGetOutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OutboundEnvironmentEndpointList": { + "description": "Collection of Outbound Environment Endpoints", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Endpoints accessed for a common purpose that the Api Management Service requires outbound network access to.", + "type": "object", + "properties": { + "category": { + "description": "The type of service accessed by the Api Management Service, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that the Api Management Service reaches the service at.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [ + "domainName" + ] + } + } + }, + "EndpointDependency": { + "description": "A domain name that a service is reached at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports used when connecting to DomainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [ + "region", + "port" + ] + } + } + }, + "EndpointDetail": { + "description": "Current TCP connectivity information from the Api Management Service to a single endpoint.", + "type": "object", + "properties": { + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "region": { + "description": "The region of the dependency.", + "type": "string" + } + } + } + }, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicies.json new file mode 100644 index 000000000000..a6876d970522 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicies.json @@ -0,0 +1,307 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Global Policies in Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies": { + "get": { + "tags": [ + "Policy" + ], + "operationId": "Policy_ListByService", + "description": "Lists all the Global Policy definitions of the Api Management service.", + "x-ms-examples": { + "ApiManagementListPolicies": { + "$ref": "./examples/ApiManagementListPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns an array of Policy Contracts.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyCollection" + } + }, + "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.ApiManagement/service/{serviceName}/policies/{policyId}": { + "head": { + "tags": [ + "Policy" + ], + "operationId": "Policy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Global policy definition in the Api Management service.", + "x-ms-examples": { + "ApiManagementHeadPolicy": { + "$ref": "./examples/ApiManagementHeadPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Policy" + ], + "operationId": "Policy_Get", + "description": "Get the Global policy definition of the Api Management service.", + "x-ms-examples": { + "ApiManagementGetPolicy": { + "$ref": "./examples/ApiManagementGetPolicy.json" + }, + "ApiManagementGetPolicyFormat": { + "$ref": "./examples/ApiManagementGetPolicyFormat.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get the Global policy definition of the Api Management service.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Policy" + ], + "operationId": "Policy_CreateOrUpdate", + "description": "Creates or updates the global policy configuration of the Api Management service.", + "x-ms-examples": { + "ApiManagementCreatePolicy": { + "$ref": "./examples/ApiManagementCreatePolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "description": "The policy contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Global policy configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Global policy configuration of the Api Management service was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Policy" + ], + "operationId": "Policy_Delete", + "description": "Deletes the global policy configuration of the Api Management Service.", + "x-ms-examples": { + "ApiManagementDeletePolicy": { + "$ref": "./examples/ApiManagementDeletePolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Policy was successfully removed" + }, + "204": { + "description": "Policy successfully removed by previous request or does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicydescriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicydescriptions.json new file mode 100644 index 000000000000..58516e002c76 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicydescriptions.json @@ -0,0 +1,100 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing retrieving a collection of policy snippets available in Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions": { + "get": { + "tags": [ + "PolicyDescription" + ], + "operationId": "PolicyDescription_ListByService", + "description": "Lists all policy descriptions.", + "x-ms-examples": { + "ApiManagementListPolicyDescriptions": { + "$ref": "./examples/ApiManagementListPolicyDescriptions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "scope", + "in": "query", + "required": false, + "type": "string", + "description": "Policy scope.", + "enum": [ + "Tenant", + "Product", + "Api", + "Operation", + "All" + ], + "x-ms-enum": { + "name": "PolicyScopeContract", + "modelAsString": false + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns an array of policy descriptions.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyDescriptionCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyfragments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyfragments.json new file mode 100644 index 000000000000..922ca0185fbc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyfragments.json @@ -0,0 +1,398 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "REST API for performing operations on policy fragments in an Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments": { + "get": { + "tags": [ + "PolicyFragment" + ], + "operationId": "PolicyFragment_ListByService", + "description": "Gets all policy fragments.", + "x-ms-examples": { + "ApiManagementListPolicyFragments": { + "$ref": "./examples/ApiManagementListPolicyFragments.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + } + ], + "responses": { + "200": { + "description": "Successfully returned an array of policy fragments.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyFragmentCollection" + } + }, + "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.ApiManagement/service/{serviceName}/policyFragments/{id}": { + "head": { + "tags": [ + "PolicyFragment" + ], + "operationId": "PolicyFragment_GetEntityTag", + "description": "Gets the entity state (Etag) version of a policy fragment.", + "x-ms-examples": { + "ApiManagementHeadPolicyFragment": { + "$ref": "./examples/ApiManagementHeadPolicyFragment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The specified policy fragment exists and the current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "PolicyFragment" + ], + "operationId": "PolicyFragment_Get", + "description": "Gets a policy fragment.", + "x-ms-examples": { + "ApiManagementGetPolicyFragment": { + "$ref": "./examples/ApiManagementGetPolicyFragment.json" + }, + "ApiManagementGetPolicyFragmentFormat": { + "$ref": "./examples/ApiManagementGetPolicyFragmentFormat.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyFragmentContentFormat" + } + ], + "responses": { + "200": { + "description": "Successfully returned a policy fragment.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyFragmentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PolicyFragment" + ], + "operationId": "PolicyFragment_CreateOrUpdate", + "description": "Creates or updates a policy fragment.", + "x-ms-examples": { + "ApiManagementCreatePolicy": { + "$ref": "./examples/ApiManagementCreatePolicyFragment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyFragmentContract" + }, + "description": "The policy fragment contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The policy fragment was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyFragmentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "201": { + "description": "The policy fragment was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyFragmentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "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" + } + }, + "delete": { + "tags": [ + "PolicyFragment" + ], + "operationId": "PolicyFragment_Delete", + "description": "Deletes a policy fragment.", + "x-ms-examples": { + "ApiManagementDeletePolicy": { + "$ref": "./examples/ApiManagementDeletePolicyFragment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The policy fragment was successfully removed." + }, + "204": { + "description": "The policy fragment successfully removed by previous request or does not exist." + }, + "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.ApiManagement/service/{serviceName}/policyFragments/{id}/listReferences": { + "post": { + "tags": [ + "PolicyFragment" + ], + "operationId": "PolicyFragment_ListReferences", + "description": "Lists policy resources that reference the policy fragment.", + "x-ms-examples": { + "ApiManagementListPolicyFragmentReferences": { + "$ref": "./examples/ApiManagementListPolicyFragmentReferences.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + } + ], + "responses": { + "200": { + "description": "Successfully returned an array of references to policy resources that include the policy fragment in their definitions.", + "schema": { + "$ref": "./definitions.json#/definitions/ResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyrestrictions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyrestrictions.json new file mode 100644 index 000000000000..82177c771706 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyrestrictions.json @@ -0,0 +1,362 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "REST API for performing policy restrictions on any created/updated policies in an Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions": { + "get": { + "tags": [ + "PolicyRestrictions" + ], + "operationId": "PolicyRestriction_ListByService", + "description": "Gets all policy restrictions of API Management services.", + "x-ms-examples": { + "ApiManagementListPolicyRestrictions": { + "$ref": "./examples/ApiManagementListPolicyRestrictions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Returns an array of Policy Restrictions.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyRestrictionCollection" + } + }, + "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.ApiManagement/service/{serviceName}/policyRestrictions/{policyRestrictionId}": { + "head": { + "tags": [ + "PolicyRestriction" + ], + "operationId": "PolicyRestriction_GetEntityTag", + "description": "Gets the entity state (Etag) version of the policy restriction in the Api Management service.", + "x-ms-examples": { + "ApiManagementHeadPolicyRestriction": { + "$ref": "./examples/ApiManagementHeadPolicyRestriction.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyRestrictionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "PolicyRestriction" + ], + "operationId": "PolicyRestriction_Get", + "description": "Get the policy restriction of the Api Management service.", + "x-ms-examples": { + "ApiManagementGetPolicyRestriction": { + "$ref": "./examples/ApiManagementGetPolicyRestriction.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyRestrictionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Get the policy restriction of the Api Management service.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyRestrictionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PolicyRestriction" + ], + "operationId": "PolicyRestriction_CreateOrUpdate", + "description": "Creates or updates the policy restriction configuration of the Api Management service.", + "x-ms-examples": { + "ApiManagementCreatePolicyRestriction": { + "$ref": "./examples/ApiManagementCreatePolicyRestriction.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyRestrictionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyRestrictionContract" + }, + "description": "The policy restriction to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Policy restriction configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyRestrictionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Policy restriction configuration of the Api Management service was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyRestrictionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "PolicyRestriction" + ], + "operationId": "PolicyRestriction_Update", + "description": "Updates the policy restriction configuration of the Api Management service.", + "x-ms-examples": { + "ApiManagementUpdatePolicyRestriction": { + "$ref": "./examples/ApiManagementUpdatePolicyRestriction.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyRestrictionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyRestrictionUpdateContract" + }, + "description": "The policy restriction to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Policy restriction configuration of the Api Management service was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyRestrictionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "PolicyRestriction" + ], + "operationId": "PolicyRestriction_Delete", + "description": "Deletes the policy restriction configuration of the Api Management Service.", + "x-ms-examples": { + "ApiManagementDeletePolicyRestriction": { + "$ref": "./examples/ApiManagementDeletePolicyRestriction.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyRestrictionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Policy restriction was successfully removed." + }, + "204": { + "description": "Policy restriction was successfully removed by previous request or does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyrestrictionsvalidation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyrestrictionsvalidation.json new file mode 100644 index 000000000000..49cfc78819d3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyrestrictionsvalidation.json @@ -0,0 +1,95 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "REST API for performing policy restrictions on any created/updated policies in an Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/validatePolicies": { + "post": { + "tags": [ + "PolicyRestrictionsValidations" + ], + "operationId": "PolicyRestrictionValidations_ByService", + "description": "Validate all policies of API Management services.", + "x-ms-examples": { + "ApiManagementListPolicyRestrictions": { + "$ref": "./examples/ApiManagementValidatePolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "location of the header.", + "type": "string" + } + } + }, + "200": { + "description": "Policy Restrictions are successfully validated.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationResultContract" + } + }, + "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": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalconfigs.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalconfigs.json new file mode 100644 index 000000000000..3d3940dfd8ee --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalconfigs.json @@ -0,0 +1,291 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use this REST API to perform operations on the developer portal configuration.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs": { + "get": { + "tags": [ + "PortalConfig" + ], + "operationId": "PortalConfig_ListByService", + "description": "Lists the developer portal configurations.", + "x-ms-examples": { + "ApiManagementListPortalConfig": { + "$ref": "./examples/ApiManagementListPortalConfig.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The developer portal configuration.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalConfigCollection" + } + }, + "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.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}": { + "head": { + "tags": [ + "PortalConfig" + ], + "operationId": "PortalConfig_GetEntityTag", + "description": "Gets the entity state (Etag) version of the developer portal configuration.", + "x-ms-examples": { + "ApiManagementHeadPortalConfig": { + "$ref": "./examples/ApiManagementHeadPortalConfig.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PortalConfigIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "PortalConfig" + ], + "operationId": "PortalConfig_Get", + "description": "Get the developer portal configuration.", + "x-ms-examples": { + "ApiManagementPortalConfig": { + "$ref": "./examples/ApiManagementPortalConfig.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PortalConfigIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The developer portal configuration.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalConfigContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "PortalConfig" + ], + "operationId": "PortalConfig_Update", + "description": "Update the developer portal configuration.", + "x-ms-examples": { + "ApiManagementUpdatePortalConfig": { + "$ref": "./examples/ApiManagementUpdatePortalConfig.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PortalConfigIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PortalConfigContract" + }, + "description": "Update the developer portal configuration." + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalConfigContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PortalConfig" + ], + "operationId": "PortalConfig_CreateOrUpdate", + "description": "Create or update the developer portal configuration.", + "x-ms-examples": { + "ApiManagementCreatePortalConfig": { + "$ref": "./examples/ApiManagementCreatePortalConfig.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PortalConfigIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PortalConfigContract" + }, + "description": "Update the developer portal configuration." + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalConfigContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalrevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalrevisions.json new file mode 100644 index 000000000000..59afa107eba4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalrevisions.json @@ -0,0 +1,341 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations in Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions": { + "get": { + "tags": [ + "PortalRevision" + ], + "operationId": "PortalRevision_ListByService", + "description": "Lists developer portal's revisions.", + "x-ms-examples": { + "ApiManagementListPortalRevisions": { + "$ref": "./examples/ApiManagementListPortalRevisions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n\r\n|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|isCurrent | eq, ne | |\n" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists portal's revisions.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalRevisionCollection" + } + }, + "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.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}": { + "head": { + "tags": [ + "PortalRevision" + ], + "operationId": "PortalRevision_GetEntityTag", + "description": "Gets the developer portal revision specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadPortalRevision": { + "$ref": "./examples/ApiManagementHeadPortalRevision.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The specified portal revision entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "PortalRevision" + ], + "operationId": "PortalRevision_Get", + "description": "Gets the developer portal's revision specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetPortalRevision": { + "$ref": "./examples/ApiManagementGetPortalRevision.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the specified portal's revision.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalRevisionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PortalRevision" + ], + "operationId": "PortalRevision_CreateOrUpdate", + "description": "Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.", + "x-ms-examples": { + "ApiManagementCreatePortalRevision": { + "$ref": "./examples/ApiManagementCreatePortalRevision.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PortalRevisionContract" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The developer portal revision was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalRevisionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "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" + } + }, + "patch": { + "tags": [ + "PortalRevision" + ], + "operationId": "PortalRevision_Update", + "description": "Updates the description of specified portal revision or makes it current.", + "x-ms-examples": { + "ApiManagementUpdatePortalRevision": { + "$ref": "./examples/ApiManagementUpdatePortalRevision.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PortalRevisionContract" + } + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Request to update developer portal revision was accepted.", + "headers": { + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "200": { + "description": "Developer portal revision was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalRevisionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "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": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalsettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalsettings.json new file mode 100644 index 000000000000..23aba1061b11 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalsettings.json @@ -0,0 +1,713 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on PortalSettings entity associated with your Azure API Management deployment. Using this entity you can manage settings for a Developer Portal.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings": { + "get": { + "deprecated": true, + "tags": [ + "PortalSettings" + ], + "operationId": "PortalSettings_ListByService", + "description": "Lists a collection of portalsettings defined within a service instance..", + "x-ms-examples": { + "ApiManagementListPortalSettings": { + "$ref": "./examples/ApiManagementListPortalSettings.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Portal Settings entities.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalSettingsCollection" + } + }, + "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.ApiManagement/service/{serviceName}/portalsettings/signin": { + "head": { + "deprecated": true, + "tags": [ + "SignInSettings" + ], + "operationId": "SignInSettings_GetEntityTag", + "description": "Gets the entity state (Etag) version of the SignInSettings.", + "x-ms-examples": { + "ApiManagementHeadSignInSettings": { + "$ref": "./examples/ApiManagementHeadSignInSettings.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "deprecated": true, + "tags": [ + "SignInSettings" + ], + "operationId": "SignInSettings_Get", + "description": "Get Sign In Settings for the Portal", + "x-ms-examples": { + "ApiManagementPortalSettingsGetSignIn": { + "$ref": "./examples/ApiManagementPortalSettingsGetSignIn.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Sign-In settings.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalSigninSettings" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "deprecated": true, + "tags": [ + "SignInSettings" + ], + "operationId": "SignInSettings_Update", + "description": "Update Sign-In settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateSignIn": { + "$ref": "./examples/ApiManagementPortalSettingsUpdateSignIn.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PortalSigninSettings" + }, + "description": "Update Sign-In settings." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Sign-In settings was updated successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "deprecated": true, + "tags": [ + "SignInSettings" + ], + "operationId": "SignInSettings_CreateOrUpdate", + "description": "Create or Update Sign-In settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateSignIn": { + "$ref": "./examples/ApiManagementPortalSettingsPutSignIn.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PortalSigninSettings" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Sign-In settings was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalSigninSettings" + } + }, + "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.ApiManagement/service/{serviceName}/portalsettings/signup": { + "head": { + "deprecated": true, + "tags": [ + "SignUpSettings" + ], + "operationId": "SignUpSettings_GetEntityTag", + "description": "Gets the entity state (Etag) version of the SignUpSettings.", + "x-ms-examples": { + "ApiManagementHeadSignUpSettings": { + "$ref": "./examples/ApiManagementHeadSignUpSettings.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "deprecated": true, + "tags": [ + "SignUpSettings" + ], + "operationId": "SignUpSettings_Get", + "description": "Get Sign Up Settings for the Portal", + "x-ms-examples": { + "ApiManagementPortalSettingsGetSignUp": { + "$ref": "./examples/ApiManagementPortalSettingsGetSignUp.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Sign-Up settings.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalSignupSettings" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "deprecated": true, + "tags": [ + "SignUpSettings" + ], + "operationId": "SignUpSettings_Update", + "description": "Update Sign-Up settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateSignUp": { + "$ref": "./examples/ApiManagementPortalSettingsUpdateSignUp.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PortalSignupSettings" + }, + "description": "Update Sign-Up settings." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Sign-Up settings was updated successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "deprecated": true, + "tags": [ + "SignUpSettings" + ], + "operationId": "SignUpSettings_CreateOrUpdate", + "description": "Create or Update Sign-Up settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateSignUp": { + "$ref": "./examples/ApiManagementPortalSettingsPutSignUp.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PortalSignupSettings" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Sign-Up settings was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalSignupSettings" + } + }, + "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.ApiManagement/service/{serviceName}/portalsettings/delegation": { + "head": { + "deprecated": true, + "tags": [ + "DelegationSettings" + ], + "operationId": "DelegationSettings_GetEntityTag", + "description": "Gets the entity state (Etag) version of the DelegationSettings.", + "x-ms-examples": { + "ApiManagementHeadDelegationSettings": { + "$ref": "./examples/ApiManagementHeadDelegationSettings.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "deprecated": true, + "tags": [ + "DelegationSettings" + ], + "operationId": "DelegationSettings_Get", + "description": "Get Delegation Settings for the Portal.", + "x-ms-examples": { + "ApiManagementPortalSettingsGetDelegation": { + "$ref": "./examples/ApiManagementPortalSettingsGetDelegation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delegation settings.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalDelegationSettings" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "deprecated": true, + "tags": [ + "DelegationSettings" + ], + "operationId": "DelegationSettings_Update", + "description": "Update Delegation settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateDelegation": { + "$ref": "./examples/ApiManagementPortalSettingsUpdateDelegation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PortalDelegationSettings" + }, + "description": "Update Delegation settings." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delegation settings was updated successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "deprecated": true, + "tags": [ + "DelegationSettings" + ], + "operationId": "DelegationSettings_CreateOrUpdate", + "description": "Create or Update Delegation settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateDelegation": { + "$ref": "./examples/ApiManagementPortalSettingsPutDelegation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PortalDelegationSettings" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delegation settings was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalDelegationSettings" + } + }, + "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.ApiManagement/service/{serviceName}/portalsettings/delegation/listSecrets": { + "post": { + "deprecated": true, + "tags": [ + "DelegationSettings" + ], + "operationId": "DelegationSettings_ListSecrets", + "description": "Gets the secret validation key of the DelegationSettings.", + "x-ms-examples": { + "ApiManagementListSecretsPortalSettings": { + "$ref": "./examples/ApiManagementListSecretsPortalSettingsValidationKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the validation key.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalSettingValidationKeyContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimprivatelink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimprivatelink.json new file mode 100644 index 000000000000..1e9846c3c9ca --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimprivatelink.json @@ -0,0 +1,347 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Private Endpoint Connection in Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnection_ListByService", + "description": "Lists all private endpoint connections of the API Management service instance.", + "x-ms-examples": { + "ApiManagementListPrivateEndpointConnections": { + "$ref": "./examples/ApiManagementListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/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": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnection_GetByName", + "description": "Gets the details of the Private Endpoint Connection specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetPrivateEndpointConnection": { + "$ref": "./examples/ApiManagementGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$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": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnection_CreateOrUpdate", + "description": "Creates a new Private Endpoint Connection or updates an existing one.", + "x-ms-examples": { + "ApiManagementApproveOrRejectPrivateEndpointConnection": { + "$ref": "./examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "privateEndpointConnectionRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PrivateEndpointConnectionRequest" + } + } + ], + "responses": { + "202": { + "description": "Request to approve or reject private endpoint connection. Location header contains the URL where the status of the long running operation can be checked.", + "headers": { + "location": { + "description": "Location header", + "type": "string" + } + } + }, + "200": { + "description": "Private Endpoint Connection Request was completed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/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-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnection_Delete", + "description": "Deletes the specified Private Endpoint Connection.", + "x-ms-examples": { + "ApiManagementDeletePrivateEndpointConnection": { + "$ref": "./examples/ApiManagementDeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Private Endpoint Connection was successfully deleted." + }, + "202": { + "description": "Request to delete API was accepted. Location header contains the URL where the status of the long running operation can be checked.", + "headers": { + "location": { + "description": "Location header", + "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 + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets the private link resources", + "operationId": "PrivateEndpointConnection_ListPrivateLinkResources", + "x-ms-examples": { + "ApiManagementListPrivateLinkGroupResources": { + "$ref": "./examples/ApiManagementListPrivateLinkGroupResources.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "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.ApiManagement/service/{serviceName}/privateLinkResources/{privateLinkSubResourceName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets the private link resources", + "operationId": "PrivateEndpointConnection_GetPrivateLinkResource", + "x-ms-examples": { + "ApiManagementGetPrivateLinkGroupResource": { + "$ref": "./examples/ApiManagementGetPrivateLinkGroupResource.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "privateLinkSubResourceName", + "in": "path", + "description": "Name of the private link resource.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimproducts.json new file mode 100644 index 000000000000..807e1d264c11 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimproducts.json @@ -0,0 +1,2202 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Product entity associated with your Azure API Management deployment. The Product entity represents a product in API Management. Products include one or more APIs and their associated terms of use. Once a product is published, developers can subscribe to the product and begin to use the product’s APIs.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products": { + "get": { + "tags": [ + "Product" + ], + "operationId": "Product_ListByService", + "description": "Lists a collection of products in the specified service instance.", + "x-ms-examples": { + "ApiManagementListProducts": { + "$ref": "./examples/ApiManagementListProducts.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "expandGroups", + "in": "query", + "required": false, + "type": "boolean", + "description": "When set to true, the response contains an array of groups that have visibility to the product. The default is false." + }, + { + "name": "tags", + "in": "query", + "required": false, + "type": "string", + "description": "Products which are part of a specific tag." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Product entities for the specified API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ProductContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}": { + "head": { + "tags": [ + "Product" + ], + "operationId": "Product_GetEntityTag", + "description": "Gets the entity state (Etag) version of the product specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadProduct": { + "$ref": "./examples/ApiManagementHeadProduct.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Product entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Product" + ], + "operationId": "Product_Get", + "description": "Gets the details of the product specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetProduct": { + "$ref": "./examples/ApiManagementGetProduct.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Product entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Product" + ], + "operationId": "Product_CreateOrUpdate", + "description": "Creates or Updates a product.", + "x-ms-examples": { + "ApiManagementCreateProduct": { + "$ref": "./examples/ApiManagementCreateProduct.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Product was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Product was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Product" + ], + "operationId": "Product_Update", + "description": "Update existing product details.", + "x-ms-examples": { + "ApiManagementUpdateProduct": { + "$ref": "./examples/ApiManagementUpdateProduct.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ProductUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Product was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Product" + ], + "operationId": "Product_Delete", + "description": "Delete product.", + "x-ms-examples": { + "ApiManagementDeleteProduct": { + "$ref": "./examples/ApiManagementDeleteProduct.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "name": "deleteSubscriptions", + "in": "query", + "required": false, + "type": "boolean", + "description": "Delete existing subscriptions associated with the product or not." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Product was successfully removed." + }, + "204": { + "description": "Product was successfully removed by previous request or does not exist." + }, + "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.ApiManagement/service/{serviceName}/products/{productId}/apis": { + "get": { + "tags": [ + "ProductApi" + ], + "operationId": "ProductApi_ListByProduct", + "description": "Lists a collection of the APIs associated with a product.", + "x-ms-examples": { + "ApiManagementListProductApis": { + "$ref": "./examples/ApiManagementListProductApis.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of Api entities in the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ApiContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}": { + "head": { + "tags": [ + "ProductApi" + ], + "operationId": "ProductApi_CheckEntityExists", + "description": "Checks that API entity specified by identifier is associated with the Product entity.", + "x-ms-examples": { + "ApiManagementHeadProductApi": { + "$ref": "./examples/ApiManagementHeadProductApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Entity exists" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductApi" + ], + "operationId": "ProductApi_CreateOrUpdate", + "description": "Adds an API to the specified product.", + "x-ms-examples": { + "ApiManagementCreateProductApi": { + "$ref": "./examples/ApiManagementCreateProductApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The API was successfully added to the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + } + }, + "200": { + "description": "The specified API is already added to the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductApi" + ], + "operationId": "ProductApi_Delete", + "description": "Deletes the specified API from the specified product.", + "x-ms-examples": { + "ApiManagementDeleteProductApi": { + "$ref": "./examples/ApiManagementDeleteProductApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API was successfully removed from product" + }, + "204": { + "description": "API successfully removed by previous request or does not exist in product" + }, + "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.ApiManagement/service/{serviceName}/products/{productId}/groups": { + "get": { + "tags": [ + "ProductGroup" + ], + "operationId": "ProductGroup_ListByProduct", + "description": "Lists the collection of developer groups associated with the specified product.", + "x-ms-examples": { + "ApiManagementListProductGroups": { + "$ref": "./examples/ApiManagementListProductGroups.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | |
| displayName | filter | eq, ne | |
| description | filter | eq, ne | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Group entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupCollection" + } + }, + "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-odata": "./definitions.json#/definitions/GroupContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}": { + "head": { + "tags": [ + "ProductGroup" + ], + "operationId": "ProductGroup_CheckEntityExists", + "description": "Checks that Group entity specified by identifier is associated with the Product entity.", + "x-ms-examples": { + "ApiManagementHeadProductGroup": { + "$ref": "./examples/ApiManagementHeadProductGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The Group is associated with the Product." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductGroup" + ], + "operationId": "ProductGroup_CreateOrUpdate", + "description": "Adds the association between the specified developer group with the specified product.", + "x-ms-examples": { + "ApiManagementCreateProductGroup": { + "$ref": "./examples/ApiManagementCreateProductGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The group was successfully associated with the product.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupContract" + } + }, + "200": { + "description": "The specified group is already associated with the product.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductGroup" + ], + "operationId": "ProductGroup_Delete", + "description": "Deletes the association between the specified group and product.", + "x-ms-examples": { + "ApiManagementDeleteProductGroup": { + "$ref": "./examples/ApiManagementDeleteProductGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The group was successfully disassociated with the product." + }, + "204": { + "description": "The group was successfully disassociated with the product." + }, + "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.ApiManagement/service/{serviceName}/products/{productId}/subscriptions": { + "get": { + "tags": [ + "ProductSubscription" + ], + "operationId": "ProductSubscriptions_List", + "description": "Lists the collection of subscriptions to the specified product.", + "x-ms-examples": { + "ApiManagementListProductSubscriptions": { + "$ref": "./examples/ApiManagementListProductSubscriptions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of subscription entities.", + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionCollection" + } + }, + "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-odata": "./definitions.json#/definitions/SubscriptionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies": { + "get": { + "tags": [ + "ProductPolicy" + ], + "operationId": "ProductPolicy_ListByProduct", + "description": "Get the policy configuration at the Product level.", + "x-ms-examples": { + "ApiManagementListProductPolicies": { + "$ref": "./examples/ApiManagementListProductPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Product Policy information.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyCollection" + } + }, + "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.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}": { + "head": { + "tags": [ + "ProductPolicy" + ], + "operationId": "ProductPolicy_GetEntityTag", + "description": "Get the ETag of the policy configuration at the Product level.", + "x-ms-examples": { + "ApiManagementHeadProductPolicy": { + "$ref": "./examples/ApiManagementHeadProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Product Policy Etag information.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ProductPolicy" + ], + "operationId": "ProductPolicy_Get", + "description": "Get the policy configuration at the Product level.", + "x-ms-examples": { + "ApiManagementGetProductPolicy": { + "$ref": "./examples/ApiManagementGetProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Product Policy information.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductPolicy" + ], + "operationId": "ProductPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the Product.", + "x-ms-examples": { + "ApiManagementCreateProductPolicy": { + "$ref": "./examples/ApiManagementCreateProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "description": "The policy contents to apply." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Product policy configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Product policy configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductPolicy" + ], + "operationId": "ProductPolicy_Delete", + "description": "Deletes the policy configuration at the Product.", + "x-ms-examples": { + "ApiManagementDeleteProductPolicy": { + "$ref": "./examples/ApiManagementDeleteProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the policy configuration at the Product level." + }, + "204": { + "description": "Successfully deleted the policy configuration at the Product level." + }, + "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.ApiManagement/service/{serviceName}/products/{productId}/tags": { + "get": { + "tags": [ + "ProductTag" + ], + "operationId": "Tag_ListByProduct", + "description": "Lists all Tags associated with the Product.", + "x-ms-examples": { + "ApiManagementListProductTags": { + "$ref": "./examples/ApiManagementListProductTags.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tags associated with the Product entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}": { + "head": { + "tags": [ + "ProductTag" + ], + "operationId": "Tag_GetEntityStateByProduct", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadProductTag": { + "$ref": "./examples/ApiManagementHeadProductTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ProductTag" + ], + "operationId": "Tag_GetByProduct", + "description": "Get tag associated with the Product.", + "x-ms-examples": { + "ApiManagementGetProductTag": { + "$ref": "./examples/ApiManagementGetProductTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductTag" + ], + "operationId": "Tag_AssignToProduct", + "description": "Assign tag to the Product.", + "x-ms-examples": { + "ApiManagementCreateProductTag": { + "$ref": "./examples/ApiManagementCreateProductTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was assigned to the Product.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, + "200": { + "description": "Tag is already assigned to the Product.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductTag" + ], + "operationId": "Tag_DetachFromProduct", + "description": "Detach the tag from the Product.", + "x-ms-examples": { + "ApiManagementDeleteProductTag": { + "$ref": "./examples/ApiManagementDeleteProductTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully detached the tag from the Product." + }, + "204": { + "description": "Successfully detached the tag from the Product." + }, + "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.ApiManagement/service/{serviceName}/products/{productId}/wikis/default": { + "head": { + "tags": [ + "ProductWiki" + ], + "operationId": "ProductWiki_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Wiki for a Product specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadProductWiki": { + "$ref": "./examples/ApiManagementHeadProductWiki.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ProductWiki" + ], + "operationId": "ProductWiki_Get", + "description": "Gets the details of the Wiki for a Product specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetProductWiki": { + "$ref": "./examples/ApiManagementGetProductWiki.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Wiki entity.", + "schema": { + "$ref": "./definitions.json#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductWiki" + ], + "operationId": "ProductWiki_CreateOrUpdate", + "description": "Creates a new Wiki for a Product or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateProductWiki": { + "$ref": "./examples/ApiManagementCreateProductWiki.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/WikiContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Wiki was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Wiki was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ProductWiki" + ], + "operationId": "ProductWiki_Update", + "description": "Updates the details of the Wiki for a Product specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateProductWiki": { + "$ref": "./examples/ApiManagementUpdateProductWiki.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/WikiUpdateContract" + }, + "description": "Wiki Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Wiki was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductWiki" + ], + "operationId": "ProductWiki_Delete", + "description": "Deletes the specified Wiki from a Product.", + "x-ms-examples": { + "ApiManagementDeleteProductWiki": { + "$ref": "./examples/ApiManagementDeleteProductWiki.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Wiki successfully removed" + }, + "204": { + "description": "Wiki successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/products/{productId}/wikis": { + "get": { + "tags": [ + "ProductWiki" + ], + "operationId": "ProductWikis_list", + "description": "Gets the details of the Wiki for a Product specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiWiki": { + "$ref": "./examples/ApiManagementListProductWikis.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Wiki entity.", + "schema": { + "$ref": "./definitions.json#/definitions/WikiCollection" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "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-odata": "./definitions.json#/definitions/WikiContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apiLinks": { + "get": { + "tags": [ + "ProductApiLink" + ], + "operationId": "ProductApiLink_ListByProduct", + "description": "Lists a collection of the API links associated with a product.", + "x-ms-examples": { + "ApiManagementListProductApiLinks": { + "$ref": "./examples/ApiManagementListProductApiLinks.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of API link entities in the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductApiLinkCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ProductApiLinkContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apiLinks/{apiLinkId}": { + "get": { + "tags": [ + "ProductApiLink" + ], + "operationId": "ProductApiLink_Get", + "description": "Gets the API link for the product.", + "x-ms-examples": { + "ApiManagementGetProductApiLink": { + "$ref": "./examples/ApiManagementGetProductApiLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductApiLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified API link entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductApiLinkContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductApiLink" + ], + "operationId": "ProductApiLink_CreateOrUpdate", + "description": "Adds an API to the specified product via link.", + "x-ms-examples": { + "ApiManagementCreateProductApiLink": { + "$ref": "./examples/ApiManagementCreateProductApiLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductApiLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ProductApiLinkContract" + }, + "description": "Create or update parameters." + } + ], + "responses": { + "200": { + "description": "The specified API is already added to the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductApiLinkContract" + } + }, + "201": { + "description": "The API was successfully added to the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductApiLinkContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductApiLink" + ], + "operationId": "ProductApiLink_Delete", + "description": "Deletes the specified API from the specified product.", + "x-ms-examples": { + "ApiManagementDeleteProductApiLink": { + "$ref": "./examples/ApiManagementDeleteProductApiLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductApiLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API was successfully removed from product" + }, + "204": { + "description": "API successfully removed by previous request or does not exist in product" + }, + "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.ApiManagement/service/{serviceName}/products/{productId}/groupLinks": { + "get": { + "tags": [ + "ProductGroupLink" + ], + "operationId": "ProductGroupLink_ListByProduct", + "description": "Lists a collection of the group links associated with a product.", + "x-ms-examples": { + "ApiManagementListProductGroupLinks": { + "$ref": "./examples/ApiManagementListProductGroupLinks.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| groupId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of group link entities in the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductGroupLinkCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ProductGroupLinkContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groupLinks/{groupLinkId}": { + "get": { + "tags": [ + "ProductGroupLink" + ], + "operationId": "ProductGroupLink_Get", + "description": "Gets the group link for the product.", + "x-ms-examples": { + "ApiManagementGetProductGroupLink": { + "$ref": "./examples/ApiManagementGetProductGroupLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductGroupLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified group link entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductGroupLink" + ], + "operationId": "ProductGroupLink_CreateOrUpdate", + "description": "Adds a group to the specified product via link.", + "x-ms-examples": { + "ApiManagementCreateProductGroupLink": { + "$ref": "./examples/ApiManagementCreateProductGroupLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductGroupLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" + }, + "description": "Create or update parameters." + } + ], + "responses": { + "200": { + "description": "The specified group is already added to the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" + } + }, + "201": { + "description": "The group was successfully added to the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductGroupLink" + ], + "operationId": "ProductGroupLink_Delete", + "description": "Deletes the specified group from the specified product.", + "x-ms-examples": { + "ApiManagementDeleteProductGroupLink": { + "$ref": "./examples/ApiManagementDeleteProductGroupLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductGroupLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Group was successfully removed from product" + }, + "204": { + "description": "Group successfully removed by previous request or does not exist in product" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimproductsByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimproductsByTags.json new file mode 100644 index 000000000000..90dc07b39f55 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimproductsByTags.json @@ -0,0 +1,106 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations to retrieve Products by Tags in Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/productsByTags": { + "get": { + "tags": [ + "ProductsByTag" + ], + "operationId": "Product_ListByTags", + "description": "Lists a collection of products associated with tags.", + "x-ms-examples": { + "ApiManagementListProductsByTags": { + "$ref": "./examples/ApiManagementListProductsByTags.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "includeNotTaggedProducts", + "in": "query", + "required": false, + "type": "boolean", + "description": "Include not tagged Products." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "./definitions.json#/definitions/TagResourceCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagResourceContract" + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimquotas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimquotas.json new file mode 100644 index 000000000000..6110fbead35c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimquotas.json @@ -0,0 +1,248 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Quota entity associated with your Azure API Management deployment. To configure call rate limit and quota policies refer to [how to configure call rate limit and quota](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies).", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}": { + "get": { + "tags": [ + "QuotaByCounterKeys" + ], + "operationId": "QuotaByCounterKeys_ListByService", + "description": "Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies", + "description": "Document describing how to configure the quota policies." + }, + "x-ms-examples": { + "ApiManagementGetQuotaCounterKeys": { + "$ref": "./examples/ApiManagementGetQuotaCounterKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/QuotaCounterKeyParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of the quota counter values.", + "schema": { + "$ref": "./definitions.json#/definitions/QuotaCounterCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "QuotaByCounterKeys" + ], + "operationId": "QuotaByCounterKeys_Update", + "description": "Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.", + "x-ms-examples": { + "ApiManagementUpdateQuotaCounterKey": { + "$ref": "./examples/ApiManagementUpdateQuotaCounterKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/QuotaCounterKeyParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/QuotaCounterValueUpdateContract" + }, + "description": "The value of the quota counter to be applied to all quota counter periods." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Updated Quota Counter Values.", + "schema": { + "$ref": "./definitions.json#/definitions/QuotaCounterCollection" + } + }, + "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.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods/{quotaPeriodKey}": { + "get": { + "tags": [ + "QuotaByPeriodKeys" + ], + "operationId": "QuotaByPeriodKeys_Get", + "description": "Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies", + "description": "Document describing how to configure the quota policies." + }, + "x-ms-examples": { + "ApiManagementGetQuotaCounterKeysByQuotaPeriod": { + "$ref": "./examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/QuotaCounterKeyParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/QuotaPeriodKeyParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the Quota counter details for the specified period.", + "schema": { + "$ref": "./definitions.json#/definitions/QuotaCounterContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "QuotaByPeriodKeys" + ], + "operationId": "QuotaByPeriodKeys_Update", + "description": "Updates an existing quota counter value in the specified service instance.", + "x-ms-examples": { + "ApiManagementUpdateQuotaCounterKeyByQuotaPeriod": { + "$ref": "./examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/QuotaCounterKeyParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/QuotaPeriodKeyParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/QuotaCounterValueUpdateContract" + }, + "description": "The value of the Quota counter to be applied on the specified period." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the Quota counter details for the specified period.", + "schema": { + "$ref": "./definitions.json#/definitions/QuotaCounterContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimregions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimregions.json new file mode 100644 index 000000000000..b24d3d08ffb9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimregions.json @@ -0,0 +1,85 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations in Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions": { + "get": { + "tags": [ + "Region" + ], + "operationId": "Region_ListByService", + "description": "Lists all azure regions in which the service exists.", + "x-ms-examples": { + "ApiManagementListRegions": { + "$ref": "./examples/ApiManagementListRegions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists of Regions in which the service is deployed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/RegionListResult" + } + }, + "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": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimreports.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimreports.json new file mode 100644 index 000000000000..f72440a1e587 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimreports.json @@ -0,0 +1,562 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs to get the analytics reports associated with your Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byApi": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByApi", + "description": "Lists report records by API.", + "x-ms-examples": { + "ApiManagementGetReportsByApi": { + "$ref": "./examples/ApiManagementGetReportsByApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byUser": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByUser", + "description": "Lists report records by User.", + "x-ms-examples": { + "ApiManagementGetReportsByUser": { + "$ref": "./examples/ApiManagementGetReportsByUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| userId | select, filter | eq | |
| apiRegion | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByOperation", + "description": "Lists report records by API Operations.", + "x-ms-examples": { + "ApiManagementGetReportsByOperation": { + "$ref": "./examples/ApiManagementGetReportsByOperation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByProduct", + "description": "Lists report records by Product.", + "x-ms-examples": { + "ApiManagementGetReportsByProduct": { + "$ref": "./examples/ApiManagementGetReportsByProduct.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byGeo": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByGeo", + "description": "Lists report records by geography.", + "x-ms-examples": { + "ApiManagementGetReportsByGeo": { + "$ref": "./examples/ApiManagementGetReportsByGeo.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| country | select | | |
| region | select | | |
| zip | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListBySubscription", + "description": "Lists report records by subscription.", + "x-ms-examples": { + "ApiManagementGetReportsBySubscription": { + "$ref": "./examples/ApiManagementGetReportsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | select, filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byTime": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByTime", + "description": "Lists report records by Time.", + "x-ms-examples": { + "ApiManagementGetReportsByTime": { + "$ref": "./examples/ApiManagementGetReportsByTime.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter, select | ge, le | |
| interval | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, + { + "name": "interval", + "in": "query", + "required": true, + "type": "string", + "format": "duration", + "description": "By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byRequest": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByRequest", + "description": "Lists report records by Request.", + "x-ms-examples": { + "ApiManagementGetReportsByRequest": { + "$ref": "./examples/ApiManagementGetReportsByRequest.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| productId | filter | eq | |
| userId | filter | eq | |
| apiRegion | filter | eq | |
| subscriptionId | filter | eq | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "./definitions.json#/definitions/RequestReportCollection" + } + }, + "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 + }, + "x-ms-odata": "./definitions.json#/definitions/RequestReportRecordContract" + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimschema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimschema.json new file mode 100644 index 000000000000..650e33194cae --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimschema.json @@ -0,0 +1,344 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Schema entity in Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas": { + "get": { + "tags": [ + "Schema" + ], + "operationId": "GlobalSchema_ListByService", + "description": "Lists a collection of schemas registered with service instance.", + "x-ms-examples": { + "ApiManagementListSchemas": { + "$ref": "./examples/ApiManagementListGlobalSchemas.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Schema entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaCollection" + } + }, + "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-odata": "./definitions.json#/definitions/GlobalSchemaContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId}": { + "head": { + "tags": [ + "Schema" + ], + "operationId": "GlobalSchema_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Schema specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApi": { + "$ref": "./examples/ApiManagementHeadGlobalSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Schema entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Schema" + ], + "operationId": "GlobalSchema_Get", + "description": "Gets the details of the Schema specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetSchema1": { + "$ref": "./examples/ApiManagementGetGlobalSchema1.json" + }, + "ApiManagementGetSchema2": { + "$ref": "./examples/ApiManagementGetGlobalSchema2.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Schema entity.", + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Schema" + ], + "operationId": "GlobalSchema_CreateOrUpdate", + "description": "Creates new or updates existing specified Schema of the API Management service instance.", + "x-ms-examples": { + "ApiManagementCreateSchema1": { + "$ref": "./examples/ApiManagementCreateGlobalSchema1.json" + }, + "ApiManagementCreateSchema2": { + "$ref": "./examples/ApiManagementCreateGlobalSchema2.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new Schema was successfully added.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaContract" + } + }, + "200": { + "description": "The Schema details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaContract" + } + }, + "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" + } + }, + "delete": { + "tags": [ + "Schema" + ], + "operationId": "GlobalSchema_Delete", + "description": "Deletes specific Schema.", + "x-ms-examples": { + "ApiManagementDeleteSchema": { + "$ref": "./examples/ApiManagementDeleteGlobalSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Schema was successfully deleted." + }, + "204": { + "description": "The Schema was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimsettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimsettings.json new file mode 100644 index 000000000000..1625b8e2d797 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimsettings.json @@ -0,0 +1,146 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on settings entity associated with your Azure API Management deployment. Using this entity you can manage properties and configuration that apply to the entire API Management service instance.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings": { + "get": { + "deprecated": true, + "tags": [ + "TenantSettings" + ], + "operationId": "TenantSettings_ListByService", + "description": "Public settings.", + "x-ms-examples": { + "ApiManagementListTenantSettings": { + "$ref": "./examples/ApiManagementListTenantSettings.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Not used" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TenantSettings entities.", + "schema": { + "$ref": "./definitions.json#/definitions/TenantSettingsCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TenantSettingsContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings/{settingsType}": { + "get": { + "deprecated": true, + "tags": [ + "TenantSettings" + ], + "operationId": "TenantSettings_Get", + "description": "Get tenant settings.", + "x-ms-examples": { + "ApiManagementGetTenantSettings": { + "$ref": "./examples/ApiManagementGetTenantSettings.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SettingsParameter" + } + ], + "responses": { + "200": { + "description": "Tenant Settings.", + "schema": { + "$ref": "./definitions.json#/definitions/TenantSettingsContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimskus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimskus.json new file mode 100644 index 000000000000..f7e485ccfd55 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimskus.json @@ -0,0 +1,391 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "SKUs available for Microsoft.ApiManagement", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/skus": { + "get": { + "tags": [ + "Skus" + ], + "operationId": "ApiManagementSkus_List", + "description": "Gets the list of Microsoft.ApiManagement SKUs available for your Subscription.", + "x-ms-examples": { + "Lists all available Resource SKUs": { + "$ref": "./examples/ApiManagementListSku.json" + } + }, + "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/ApiManagementSkusResult" + } + }, + "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": { + "ApiManagementSkuCapacity": { + "properties": { + "minimum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The maximum capacity that can be set." + }, + "default": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The default capacity." + }, + "scaleType": { + "type": "string", + "readOnly": true, + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "x-ms-enum": { + "name": "ApiManagementSkuCapacityScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ApiManagementSkuCosts": { + "properties": { + "meterID": { + "type": "string", + "readOnly": true, + "description": "Used for querying price from commerce." + }, + "quantity": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The multiplier is needed to extend the base metered cost." + }, + "extendedUnit": { + "type": "string", + "readOnly": true, + "description": "An invariant to show the extended unit." + } + }, + "description": "Describes metadata for retrieving price info." + }, + "ApiManagementSkuCapabilities": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "An invariant to describe the feature." + }, + "value": { + "type": "string", + "readOnly": true, + "description": "An invariant if the feature is measured by quantity." + } + }, + "description": "Describes The SKU capabilities object." + }, + "ApiManagementSkuZoneDetails": { + "properties": { + "name": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The set of zones that the SKU is available in with the specified capabilities." + }, + "capabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ApiManagementSkuCapabilities" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of capabilities that are available for the SKU in the specified list of zones." + } + }, + "description": "Describes The zonal capabilities of a SKU." + }, + "ApiManagementSkuRestrictions": { + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of restrictions.", + "enum": [ + "Location", + "Zone" + ], + "x-ms-enum": { + "name": "ApiManagementSkuRestrictionsType", + "modelAsString": false + } + }, + "values": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "restrictionInfo": { + "$ref": "#/definitions/ApiManagementSkuRestrictionInfo", + "readOnly": true, + "description": "The information about the restriction where the SKU cannot be used." + }, + "reasonCode": { + "type": "string", + "readOnly": true, + "description": "The reason for restriction.", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ApiManagementSkuRestrictionsReasonCode", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ApiManagementSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of SKU." + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic**" + }, + "size": { + "readOnly": true, + "type": "string", + "description": "The Size of the SKU." + }, + "family": { + "readOnly": true, + "type": "string", + "description": "The Family of this particular SKU." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "The Kind of resources that are supported in this SKU." + }, + "capacity": { + "$ref": "#/definitions/ApiManagementSkuCapacity", + "readOnly": true, + "description": "Specifies the number of virtual machines in the scale set." + }, + "locations": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available." + }, + "locationInfo": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ApiManagementSkuLocationInfo" + }, + "x-ms-identifiers": [ + "location" + ], + "description": "A list of locations and availability zones in those locations where the SKU is available." + }, + "apiVersions": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The api versions that support this SKU." + }, + "costs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ApiManagementSkuCosts" + }, + "x-ms-identifiers": [ + "meterID" + ], + "description": "Metadata for retrieving price info." + }, + "capabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ApiManagementSkuCapabilities" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A name value pair to describe the capability." + }, + "restrictions": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ApiManagementSkuRestrictions" + }, + "x-ms-identifiers": [], + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + }, + "description": "Describes an available ApiManagement SKU." + }, + "ApiManagementSkuLocationInfo": { + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "Location of the SKU" + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is supported." + }, + "zoneDetails": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ApiManagementSkuZoneDetails" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Details of capabilities available to a SKU in specific zones." + } + } + }, + "ApiManagementSkuRestrictionInfo": { + "properties": { + "locations": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "Locations where the SKU is restricted" + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is restricted." + } + } + }, + "ApiManagementSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiManagementSku" + }, + "x-ms-identifiers": [ + "name", + "resourceType" + ], + "description": "The list of skus available for the subscription." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URI to fetch the next page of Resource Skus. Call ListNext() with this URI to fetch the next page of Resource Skus" + } + }, + "required": [ + "value" + ], + "description": "The List Resource Skus operation response." + } + }, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimsubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimsubscriptions.json new file mode 100644 index 000000000000..a1380c747704 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimsubscriptions.json @@ -0,0 +1,523 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Subscription entity associated with your Azure API Management deployment. The Subscription entity represents the association between a user and a product in API Management. Products contain one or more APIs, and once a product is published, developers can subscribe to the product and begin to use the product’s APIs.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions": { + "get": { + "tags": [ + "Subscription" + ], + "operationId": "Subscription_List", + "description": "Lists all subscriptions of the API Management service instance.", + "x-ms-examples": { + "ApiManagementListSubscriptions": { + "$ref": "./examples/ApiManagementListSubscriptions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A collection of the Subscription entities for the specified API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionCollection" + } + }, + "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-odata": "./definitions.json#/definitions/SubscriptionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}": { + "head": { + "tags": [ + "Subscription" + ], + "operationId": "Subscription_GetEntityTag", + "description": "Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadSubscription": { + "$ref": "./examples/ApiManagementHeadSubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified apimanagement subscription entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Subscription" + ], + "operationId": "Subscription_Get", + "description": "Gets the specified Subscription entity.", + "x-ms-examples": { + "ApiManagementGetSubscription": { + "$ref": "./examples/ApiManagementGetSubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Subscription entity.", + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Subscription" + ], + "operationId": "Subscription_CreateOrUpdate", + "description": "Creates or updates the subscription of specified user to the specified product.", + "x-ms-examples": { + "ApiManagementCreateSubscription": { + "$ref": "./examples/ApiManagementCreateSubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionCreateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/NotifySubscriptionStateChangeParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AppTypeParameter" + } + ], + "responses": { + "201": { + "description": "The user was successfully subscribed to the product.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionContract" + } + }, + "200": { + "description": "The user already subscribed to the product.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Subscription" + ], + "operationId": "Subscription_Update", + "description": "Updates the details of a subscription specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateSubscription": { + "$ref": "./examples/ApiManagementUpdateSubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/NotifySubscriptionStateChangeParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AppTypeParameter" + } + ], + "responses": { + "200": { + "description": "The subscription details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Subscription" + ], + "operationId": "Subscription_Delete", + "description": "Deletes the specified subscription.", + "x-ms-examples": { + "ApiManagementDeleteSubscription": { + "$ref": "./examples/ApiManagementDeleteSubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The subscription details were successfully deleted." + }, + "204": { + "description": "The subscription details were successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/subscriptions/{sid}/regeneratePrimaryKey": { + "post": { + "tags": [ + "Subscription" + ], + "operationId": "Subscription_RegeneratePrimaryKey", + "description": "Regenerates primary key of existing subscription of the API Management service instance.", + "x-ms-examples": { + "ApiManagementSubscriptionRegeneratePrimaryKey": { + "$ref": "./examples/ApiManagementSubscriptionRegeneratePrimaryKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The primary key was successfully regenerated." + }, + "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.ApiManagement/service/{serviceName}/subscriptions/{sid}/regenerateSecondaryKey": { + "post": { + "tags": [ + "Subscription" + ], + "operationId": "Subscription_RegenerateSecondaryKey", + "description": "Regenerates secondary key of existing subscription of the API Management service instance.", + "x-ms-examples": { + "ApiManagementSubscriptionRegenerateSecondaryKey": { + "$ref": "./examples/ApiManagementSubscriptionRegenerateSecondaryKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The secondary key was successfully regenerated." + }, + "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.ApiManagement/service/{serviceName}/subscriptions/{sid}/listSecrets": { + "post": { + "tags": [ + "Subscription" + ], + "operationId": "Subscription_ListSecrets", + "description": "Gets the specified Subscription keys.", + "x-ms-examples": { + "ApiManagementSubscriptionListSecrets": { + "$ref": "./examples/ApiManagementSubscriptionListSecrets.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains subscription keys.", + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionKeysContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimtagresources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimtagresources.json new file mode 100644 index 000000000000..b299175f1f8b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimtagresources.json @@ -0,0 +1,99 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for querying APIs. Operations and Products by tags in your Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tagResources": { + "get": { + "tags": [ + "TagResource" + ], + "operationId": "TagResource_ListByService", + "description": "Lists a collection of resources associated with tags.", + "x-ms-examples": { + "ApiManagementListTagResources": { + "$ref": "./examples/ApiManagementListTagResources.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| aid | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| isCurrent | filter | eq | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "./definitions.json#/definitions/TagResourceCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagResourceContract" + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimtags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimtags.json new file mode 100644 index 000000000000..18b7b0cf534b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimtags.json @@ -0,0 +1,1052 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Tag entity in your Azure API Management deployment. Tags can be assigned to APIs, Operations and Products.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags": { + "get": { + "tags": [ + "Tag" + ], + "operationId": "Tag_ListByService", + "description": "Lists a collection of tags defined within a service instance.", + "x-ms-examples": { + "ApiManagementListTags": { + "$ref": "./examples/ApiManagementListTags.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "scope", + "in": "query", + "required": false, + "type": "string", + "description": "Scope like 'apis', 'products' or 'apis/{apiId}" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Tag entities.", + "schema": { + "$ref": "./definitions.json#/definitions/TagCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}": { + "head": { + "tags": [ + "Tag" + ], + "operationId": "Tag_GetEntityState", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadTag": { + "$ref": "./examples/ApiManagementHeadTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Tag" + ], + "operationId": "Tag_Get", + "description": "Gets the details of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetTag": { + "$ref": "./examples/ApiManagementGetTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Tag entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Tag" + ], + "operationId": "Tag_CreateOrUpdate", + "description": "Creates a tag.", + "x-ms-examples": { + "ApiManagementCreateTag": { + "$ref": "./examples/ApiManagementCreateTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/TagCreateUpdateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was created successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, + "200": { + "description": "Tag already exists.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Tag" + ], + "operationId": "Tag_Update", + "description": "Updates the details of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateTag": { + "$ref": "./examples/ApiManagementUpdateTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/TagCreateUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The tag details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Tag" + ], + "operationId": "Tag_Delete", + "description": "Deletes specific tag of the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteTag": { + "$ref": "./examples/ApiManagementDeleteTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Tag successfully removed" + }, + "204": { + "description": "Tag successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/tags/{tagId}/apiLinks": { + "get": { + "tags": [ + "TagApiLink" + ], + "operationId": "TagApiLink_ListByProduct", + "description": "Lists a collection of the API links associated with a tag.", + "x-ms-examples": { + "ApiManagementListTagApiLinks": { + "$ref": "./examples/ApiManagementListTagApiLinks.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of API link entities associated with a tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagApiLinkCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagApiLinkContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}/apiLinks/{apiLinkId}": { + "get": { + "tags": [ + "TagApiLink" + ], + "operationId": "TagApiLink_Get", + "description": "Gets the API link for the tag.", + "x-ms-examples": { + "ApiManagementGetTagApiLink": { + "$ref": "./examples/ApiManagementGetTagApiLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagApiLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified API link entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagApiLinkContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "TagApiLink" + ], + "operationId": "TagApiLink_CreateOrUpdate", + "description": "Adds an API to the specified tag via link.", + "x-ms-examples": { + "ApiManagementCreateTagApiLink": { + "$ref": "./examples/ApiManagementCreateTagApiLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagApiLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/TagApiLinkContract" + }, + "description": "Create or update parameters." + } + ], + "responses": { + "200": { + "description": "The specified API is already added to the tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagApiLinkContract" + } + }, + "201": { + "description": "The API was successfully added to the tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagApiLinkContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "TagApiLink" + ], + "operationId": "TagApiLink_Delete", + "description": "Deletes the specified API from the specified tag.", + "x-ms-examples": { + "ApiManagementDeleteTagApiLink": { + "$ref": "./examples/ApiManagementDeleteTagApiLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagApiLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API was successfully removed from tag" + }, + "204": { + "description": "API successfully removed by previous request or does not exist in tag" + }, + "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.ApiManagement/service/{serviceName}/tags/{tagId}/operationLinks": { + "get": { + "tags": [ + "TagOperationLink" + ], + "operationId": "TagOperationLink_ListByProduct", + "description": "Lists a collection of the operation links associated with a tag.", + "x-ms-examples": { + "ApiManagementListTagOperationLinks": { + "$ref": "./examples/ApiManagementListTagOperationLinks.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| operationId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of operation link entities associated with a tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagOperationLinkCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagOperationLinkContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}/operationLinks/{operationLinkId}": { + "get": { + "tags": [ + "TagOperationLink" + ], + "operationId": "TagOperationLink_Get", + "description": "Gets the operation link for the tag.", + "x-ms-examples": { + "ApiManagementGetTagOperationLink": { + "$ref": "./examples/ApiManagementGetTagOperationLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagOperationLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified operation link entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagOperationLinkContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "TagOperationLink" + ], + "operationId": "TagOperationLink_CreateOrUpdate", + "description": "Adds an operation to the specified tag via link.", + "x-ms-examples": { + "ApiManagementCreateTagOperationLink": { + "$ref": "./examples/ApiManagementCreateTagOperationLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagOperationLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/TagOperationLinkContract" + }, + "description": "Create or update parameters." + } + ], + "responses": { + "200": { + "description": "The specified operation is already added to the tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagOperationLinkContract" + } + }, + "201": { + "description": "The operation was successfully added to the tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagOperationLinkContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "TagOperationLink" + ], + "operationId": "TagOperationLink_Delete", + "description": "Deletes the specified operation from the specified tag.", + "x-ms-examples": { + "ApiManagementDeleteTagOperationLink": { + "$ref": "./examples/ApiManagementDeleteTagOperationLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagOperationLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation was successfully removed from tag" + }, + "204": { + "description": "Operation successfully removed by previous request or does not exist in tag" + }, + "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.ApiManagement/service/{serviceName}/tags/{tagId}/productLinks": { + "get": { + "tags": [ + "TagProductLink" + ], + "operationId": "TagProductLink_ListByProduct", + "description": "Lists a collection of the product links associated with a tag.", + "x-ms-examples": { + "ApiManagementListTagProductLinks": { + "$ref": "./examples/ApiManagementListTagProductLinks.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of product link entities associated with a tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagProductLinkCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagProductLinkContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}/productLinks/{productLinkId}": { + "get": { + "tags": [ + "TagProductLink" + ], + "operationId": "TagProductLink_Get", + "description": "Gets the product link for the tag.", + "x-ms-examples": { + "ApiManagementGetTagProductLink": { + "$ref": "./examples/ApiManagementGetTagProductLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagProductLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified product link entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagProductLinkContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "TagProductLink" + ], + "operationId": "TagProductLink_CreateOrUpdate", + "description": "Adds a product to the specified tag via link.", + "x-ms-examples": { + "ApiManagementCreateTagProductLink": { + "$ref": "./examples/ApiManagementCreateTagProductLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagProductLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/TagProductLinkContract" + }, + "description": "Create or update parameters." + } + ], + "responses": { + "200": { + "description": "The specified product is already added to the tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagProductLinkContract" + } + }, + "201": { + "description": "The product was successfully added to the tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagProductLinkContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "TagProductLink" + ], + "operationId": "TagProductLink_Delete", + "description": "Deletes the specified product from the specified tag.", + "x-ms-examples": { + "ApiManagementDeleteTagProductLink": { + "$ref": "./examples/ApiManagementDeleteTagProductLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagProductLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Product was successfully removed from tag" + }, + "204": { + "description": "Product successfully removed by previous request or does not exist in tag" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimtenant.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimtenant.json new file mode 100644 index 000000000000..4c23b2b6b927 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimtenant.json @@ -0,0 +1,785 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on tenant entity associated with your Azure API Management deployment. Using this entity you can manage properties and configuration that apply to the entire API Management service instance.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant": { + "get": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_ListByService", + "description": "Returns list of access infos - for Git and Management endpoints.", + "x-ms-examples": { + "ApiManagementListTenantAccess": { + "$ref": "./examples/ApiManagementListTenantAccess.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Not used" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TenantAccessInfo entities.", + "schema": { + "$ref": "./definitions.json#/definitions/AccessInformationCollection" + } + }, + "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-odata": "./definitions.json#/definitions/AccessInformationContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}": { + "head": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_GetEntityTag", + "description": "Tenant access metadata", + "x-ms-examples": { + "ApiManagementHeadTenantAccess": { + "$ref": "./examples/ApiManagementHeadTenantAccess.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AccessParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_Get", + "description": "Get tenant access information details without secrets.", + "x-ms-examples": { + "ApiManagementGetTenantAccess": { + "$ref": "./examples/ApiManagementGetTenantAccess.json" + }, + "ApiManagementGetTenantGitAccess": { + "$ref": "./examples/ApiManagementGetTenantGitAccess.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AccessParameter" + } + ], + "responses": { + "200": { + "description": "Tenant Access information.", + "schema": { + "$ref": "./definitions.json#/definitions/AccessInformationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_Create", + "description": "Update tenant access information details.", + "x-ms-examples": { + "ApiManagementCreateTenantAccess": { + "$ref": "./examples/ApiManagementCreateTenantAccess.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/AccessInformationCreateParameters" + }, + "description": "Parameters supplied to retrieve the Tenant Access Information." + }, + { + "$ref": "./apimanagement.json#/parameters/AccessParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Tenant Access information was updated successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/AccessInformationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_Update", + "description": "Update tenant access information details.", + "x-ms-examples": { + "ApiManagementUpdateTenantAccess": { + "$ref": "./examples/ApiManagementUpdateTenantAccess.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/AccessInformationUpdateParameters" + }, + "description": "Parameters supplied to retrieve the Tenant Access Information." + }, + { + "$ref": "./apimanagement.json#/parameters/AccessParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Tenant Access information was updated successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/AccessInformationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "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.ApiManagement/service/{serviceName}/tenant/{accessName}/regeneratePrimaryKey": { + "post": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_RegeneratePrimaryKey", + "description": "Regenerate primary access key", + "x-ms-examples": { + "ApiManagementTenantAccessRegenerateKey": { + "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AccessParameter" + } + ], + "responses": { + "204": { + "description": "The primary key was successfully regenerated." + }, + "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.ApiManagement/service/{serviceName}/tenant/{accessName}/regenerateSecondaryKey": { + "post": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_RegenerateSecondaryKey", + "description": "Regenerate secondary access key", + "x-ms-examples": { + "ApiManagementTenantAccessRegenerateKey": { + "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AccessParameter" + } + ], + "responses": { + "204": { + "description": "The secondary key was successfully regenerated." + }, + "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.ApiManagement/service/{serviceName}/tenant/{accessName}/listSecrets": { + "post": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_ListSecrets", + "description": "Get tenant access information details.", + "x-ms-examples": { + "ApiManagementListSecretsTenantAccess": { + "$ref": "./examples/ApiManagementListSecretsTenantAccess.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AccessParameter" + } + ], + "responses": { + "200": { + "description": "Tenant Access information.", + "schema": { + "$ref": "./definitions.json#/definitions/AccessInformationSecretsContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "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.ApiManagement/service/{serviceName}/tenant/{accessName}/git/regeneratePrimaryKey": { + "post": { + "tags": [ + "TenantAccessGit" + ], + "operationId": "TenantAccessGit_RegeneratePrimaryKey", + "description": "Regenerate primary access key for GIT.", + "x-ms-examples": { + "ApiManagementTenantAccessRegenerateKey": { + "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AccessParameter" + } + ], + "responses": { + "204": { + "description": "The primary key was successfully regenerated." + }, + "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.ApiManagement/service/{serviceName}/tenant/{accessName}/git/regenerateSecondaryKey": { + "post": { + "tags": [ + "TenantAccessGit" + ], + "operationId": "TenantAccessGit_RegenerateSecondaryKey", + "description": "Regenerate secondary access key for GIT.", + "x-ms-examples": { + "ApiManagementTenantAccessRegenerateKey": { + "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AccessParameter" + } + ], + "responses": { + "204": { + "description": "The secondary key was successfully regenerated." + }, + "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.ApiManagement/service/{serviceName}/tenant/{configurationName}/deploy": { + "post": { + "tags": [ + "TenantConfiguration" + ], + "operationId": "TenantConfiguration_Deploy", + "description": "This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.", + "externalDocs": { + "description": "To deploy any service configuration changes to the API Management service instance", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-deploy-any-service-configuration-changes-to-the-api-management-service-instance" + }, + "x-ms-examples": { + "ApiManagementTenantConfigurationDeploy": { + "$ref": "./examples/ApiManagementTenantConfigurationDeploy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DeployConfigurationParameters" + }, + "description": "Deploy Configuration parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ConfigurationParameter" + } + ], + "responses": { + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked.", + "headers": { + "location": { + "type": "string" + } + } + }, + "200": { + "description": "Result of applying changes from Git branch to database.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationResultContract" + } + }, + "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.ApiManagement/service/{serviceName}/tenant/{configurationName}/save": { + "post": { + "tags": [ + "TenantConfiguration" + ], + "operationId": "TenantConfiguration_Save", + "description": "This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.", + "externalDocs": { + "description": "To save the service configuration to the Git repository", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-save-the-service-configuration-to-the-git-repository" + }, + "x-ms-examples": { + "ApiManagementTenantConfigurationSave": { + "$ref": "./examples/ApiManagementTenantConfigurationSave.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/SaveConfigurationParameter" + }, + "description": "Save Configuration parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ConfigurationParameter" + } + ], + "responses": { + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked.", + "headers": { + "location": { + "type": "string" + } + } + }, + "200": { + "description": "Result of creating a commit in the repository.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationResultContract" + } + }, + "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.ApiManagement/service/{serviceName}/tenant/{configurationName}/validate": { + "post": { + "tags": [ + "TenantConfiguration" + ], + "operationId": "TenantConfiguration_Validate", + "description": "This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementTenantConfigurationValidate": { + "$ref": "./examples/ApiManagementTenantConfigurationValidate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DeployConfigurationParameters" + }, + "description": "Validate Configuration parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ConfigurationParameter" + } + ], + "responses": { + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked.", + "headers": { + "location": { + "type": "string" + } + } + }, + "200": { + "description": "Result of validating the changes in the specified Git branch.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationResultContract" + } + }, + "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.ApiManagement/service/{serviceName}/tenant/{configurationName}/syncState": { + "get": { + "tags": [ + "TenantConfigurationSyncState" + ], + "operationId": "TenantConfiguration_GetSyncState", + "description": "Gets the status of the most recent synchronization between the configuration database and the Git repository.", + "x-ms-examples": { + "ApiManagementTenantAccessSyncState": { + "$ref": "./examples/ApiManagementTenantAccessSyncState.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ConfigurationParameter" + } + ], + "responses": { + "200": { + "description": "Sync state result.", + "schema": { + "$ref": "./definitions.json#/definitions/TenantConfigurationSyncStateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimusers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimusers.json new file mode 100644 index 000000000000..4eb495272e03 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimusers.json @@ -0,0 +1,792 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on User entity in Azure API Management deployment. The User entity in API Management represents the developers that call the APIs of the products to which they are subscribed.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users": { + "get": { + "tags": [ + "User" + ], + "operationId": "User_ListByService", + "description": "Lists a collection of registered users in the specified service instance.", + "x-ms-examples": { + "ApiManagementListUsers": { + "$ref": "./examples/ApiManagementListUsers.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| groups | expand | | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "expandGroups", + "in": "query", + "type": "boolean", + "description": "Detailed Group in response." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of User entities.", + "schema": { + "$ref": "./definitions.json#/definitions/UserCollection" + } + }, + "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-odata": "./definitions.json#/definitions/UserContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}": { + "head": { + "tags": [ + "User" + ], + "operationId": "User_GetEntityTag", + "description": "Gets the entity state (Etag) version of the user specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadUser": { + "$ref": "./examples/ApiManagementHeadUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified user entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "User" + ], + "operationId": "User_Get", + "description": "Gets the details of the user specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetUser": { + "$ref": "./examples/ApiManagementGetUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the specified user entity.", + "schema": { + "$ref": "./definitions.json#/definitions/UserContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "User" + ], + "operationId": "User_CreateOrUpdate", + "description": "Creates or Updates a user.", + "x-ms-examples": { + "ApiManagementCreateUser": { + "$ref": "./examples/ApiManagementCreateUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/UserCreateParameters" + }, + "description": "Create or update parameters." + }, + { + "name": "notify", + "in": "query", + "required": false, + "type": "boolean", + "description": "Send an Email notification to the User." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "User was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/UserContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "User was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/UserContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "User" + ], + "operationId": "User_Update", + "description": "Updates the details of the user specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateUser": { + "$ref": "./examples/ApiManagementUpdateUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/UserUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "User was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/UserContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "User" + ], + "operationId": "User_Delete", + "description": "Deletes specific user.", + "x-ms-examples": { + "ApiManagementDeleteUser": { + "$ref": "./examples/ApiManagementDeleteUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "name": "deleteSubscriptions", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to delete user's subscription or not." + }, + { + "name": "notify", + "in": "query", + "required": false, + "type": "boolean", + "description": "Send an Account Closed Email notification to the User." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AppTypeParameter" + } + ], + "responses": { + "202": { + "description": "Request to delete user details was accepted.", + "headers": { + "location": { + "description": "Location header", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "204": { + "description": "The user details were successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/users/{userId}/generateSsoUrl": { + "post": { + "tags": [ + "Users" + ], + "operationId": "User_GenerateSsoUrl", + "description": "Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.", + "x-ms-examples": { + "ApiManagementUserGenerateSsoUrl": { + "$ref": "./examples/ApiManagementUserGenerateSsoUrl.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the single sign-on URL.", + "schema": { + "x-ms-client-flatten": true, + "$ref": "./definitions.json#/definitions/GenerateSsoUrlResult" + } + }, + "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.ApiManagement/service/{serviceName}/users/{userId}/groups": { + "get": { + "tags": [ + "UserGroup" + ], + "operationId": "UserGroup_List", + "description": "Lists all user groups.", + "x-ms-examples": { + "ApiManagementListUserGroups": { + "$ref": "./examples/ApiManagementListUserGroups.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|------------------------|-----------------------------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Group entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupCollection" + } + }, + "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-odata": "./definitions.json#/definitions/GroupContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions": { + "get": { + "tags": [ + "UserSubscription" + ], + "operationId": "UserSubscription_List", + "description": "Lists the collection of subscriptions of the specified user.", + "x-ms-examples": { + "ApiManagementListUserSubscriptions": { + "$ref": "./examples/ApiManagementListUserSubscriptions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|------------------------|-----------------------------------|
|name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Subscription entities.", + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionCollection" + } + }, + "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-odata": "./definitions.json#/definitions/SubscriptionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions/{sid}": { + "get": { + "tags": [ + "Subscription" + ], + "operationId": "UserSubscription_Get", + "description": "Gets the specified Subscription entity associated with a particular user.", + "x-ms-examples": { + "ApiManagementGetUserSubscription": { + "$ref": "./examples/ApiManagementGetUserSubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Subscription entity.", + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "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.ApiManagement/service/{serviceName}/users/{userId}/identities": { + "get": { + "tags": [ + "UserIdentity" + ], + "operationId": "UserIdentities_List", + "description": "List of all user identities.", + "x-ms-examples": { + "ApiManagementListUserIdentities": { + "$ref": "./examples/ApiManagementListUserIdentities.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists of User Identities.", + "schema": { + "$ref": "./definitions.json#/definitions/UserIdentityCollection" + } + }, + "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.ApiManagement/service/{serviceName}/users/{userId}/token": { + "post": { + "tags": [ + "UserToken" + ], + "operationId": "User_GetSharedAccessToken", + "description": "Gets the Shared Access Authorization Token for the User.", + "x-ms-examples": { + "ApiManagementUserToken": { + "$ref": "./examples/ApiManagementUserToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/UserTokenParameters" + }, + "description": "Create Authorization Token parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the authorization token for the user.", + "schema": { + "x-ms-client-flatten": true, + "$ref": "./definitions.json#/definitions/UserTokenResult" + } + }, + "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.ApiManagement/service/{serviceName}/users/{userId}/confirmations/password/send": { + "post": { + "tags": [ + "UserConfirmationPasswordSend" + ], + "operationId": "UserConfirmationPassword_Send", + "description": "Sends confirmation", + "x-ms-examples": { + "ApiManagementUserConfirmationPasswordSend": { + "$ref": "./examples/ApiManagementUserConfirmationPasswordSend.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AppTypeParameter" + } + ], + "responses": { + "204": { + "description": "Notification successfully sent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacebackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacebackends.json new file mode 100644 index 000000000000..eaf76e380b77 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacebackends.json @@ -0,0 +1,397 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Backend entity in Azure API Management deployment. The Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends": { + "get": { + "tags": [ + "Backend" + ], + "operationId": "WorkspaceBackend_ListByWorkspace", + "description": "Lists a collection of backends in the specified workspace.", + "x-ms-examples": { + "ApiManagementListWorkspaceBackends": { + "$ref": "./examples/ApiManagementListWorkspaceBackends.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Backend entities.", + "schema": { + "$ref": "./definitions.json#/definitions/BackendCollection" + } + }, + "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-odata": "./definitions.json#/definitions/BackendContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends/{backendId}": { + "head": { + "tags": [ + "Backend" + ], + "operationId": "WorkspaceBackend_GetEntityTag", + "description": "Gets the entity state (Etag) version of the backend specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceBackend": { + "$ref": "./examples/ApiManagementHeadWorkspaceBackend.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified backend entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Backend" + ], + "operationId": "WorkspaceBackend_Get", + "description": "Gets the details of the backend specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceBackend": { + "$ref": "./examples/ApiManagementGetWorkspaceBackend.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Backend entity.", + "schema": { + "$ref": "./definitions.json#/definitions/BackendContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Backend" + ], + "operationId": "WorkspaceBackend_CreateOrUpdate", + "description": "Creates or Updates a backend.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceBackendServiceFabric": { + "$ref": "./examples/ApiManagementCreateWorkspaceBackendServiceFabric.json" + }, + "ApiManagementCreateWorkspaceBackendProxyBackend": { + "$ref": "./examples/ApiManagementCreateWorkspaceBackendProxyBackend.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/BackendContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Backend was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/BackendContract" + } + }, + "200": { + "description": "The existing backend was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/BackendContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Backend" + ], + "operationId": "WorkspaceBackend_Update", + "description": "Updates an existing backend.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceBackend": { + "$ref": "./examples/ApiManagementUpdateWorkspaceBackend.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/BackendUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing backend was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/BackendContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Backend" + ], + "operationId": "WorkspaceBackend_Delete", + "description": "Deletes the specified backend.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceBackend": { + "$ref": "./examples/ApiManagementDeleteWorkspaceBackend.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The backend was successfully deleted." + }, + "204": { + "description": "The backend was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacecertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacecertificates.json new file mode 100644 index 000000000000..8bf19ff81488 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacecertificates.json @@ -0,0 +1,405 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Certificate entity in your Azure API Management deployment. Certificates can be used to setup mutual authentication with your Backend in API Management. For more information refer to [How to secure backend using Mutual Auth Certificate](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-mutual-certificates).", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates": { + "get": { + "tags": [ + "Certificate" + ], + "operationId": "WorkspaceCertificate_ListByWorkspace", + "description": "Lists a collection of all certificates in the specified workspace.", + "x-ms-examples": { + "ApiManagementListWorkspaceCertificates": { + "$ref": "./examples/ApiManagementListWorkspaceCertificates.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "isKeyVaultRefreshFailed", + "in": "query", + "required": false, + "type": "boolean", + "description": "When set to true, the response contains only certificates entities which failed refresh." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns a collection of Certificate entity.", + "schema": { + "$ref": "./definitions.json#/definitions/CertificateCollection" + } + }, + "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-odata": "./definitions.json#/definitions/CertificateContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}": { + "head": { + "tags": [ + "Certificate" + ], + "operationId": "WorkspaceCertificate_GetEntityTag", + "description": "Gets the entity state (Etag) version of the certificate specified by its identifier.", + "x-ms-examples": { + "ApiManagementWorkspaceHeadCertificate": { + "$ref": "./examples/ApiManagementHeadWorkspaceCertificate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified certificate entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Certificate" + ], + "operationId": "WorkspaceCertificate_Get", + "description": "Gets the details of the certificate specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceCertificate": { + "$ref": "./examples/ApiManagementGetWorkspaceCertificate.json" + }, + "ApiManagementGetWorkspaceCertificateWithKeyVault": { + "$ref": "./examples/ApiManagementGetWorkspaceCertificateWithKeyVault.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Certificate entity.", + "schema": { + "$ref": "./definitions.json#/definitions/CertificateContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Certificate" + ], + "operationId": "WorkspaceCertificate_CreateOrUpdate", + "description": "Creates or updates the certificate being used for authentication with the backend.", + "externalDocs": { + "description": "How to secure back-end services using client certificate authentication in Azure API Management", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceCertificate": { + "$ref": "./examples/ApiManagementCreateWorkspaceCertificate.json" + }, + "ApiManagementCreateWorkspaceCertificateWithKeyVault": { + "$ref": "./examples/ApiManagementCreateWorkspaceCertificateWithKeyVault.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/CertificateCreateOrUpdateParameters" + }, + "description": "Create or Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new certificate was successfully added.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CertificateContract" + } + }, + "200": { + "description": "The certificate details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CertificateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Certificate" + ], + "operationId": "WorkspaceCertificate_Delete", + "description": "Deletes specific certificate.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceCertificate": { + "$ref": "./examples/ApiManagementDeleteWorkspaceCertificate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The certificate was successfully deleted." + }, + "204": { + "description": "The certificate was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}/refreshSecret": { + "post": { + "tags": [ + "Certificate" + ], + "operationId": "WorkspaceCertificate_RefreshSecret", + "description": "From KeyVault, Refresh the certificate being used for authentication with the backend.", + "externalDocs": { + "description": "How to secure back-end services using client certificate authentication in Azure API Management", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" + }, + "x-ms-examples": { + "ApiManagementRefreshWorkspaceCertificate": { + "$ref": "./examples/ApiManagementRefreshWorkspaceCertificate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The certificate details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CertificateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacediagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacediagnostics.json new file mode 100644 index 000000000000..f3b17ad754d0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacediagnostics.json @@ -0,0 +1,766 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Diagnostic entity associated with your Azure API Management deployment. Diagnostics are used to log requests/responses in the API Management proxy.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics": { + "get": { + "tags": [ + "Diagnostic" + ], + "operationId": "WorkspaceDiagnostic_ListByWorkspace", + "description": "Lists all diagnostics in the specified workspace.", + "x-ms-examples": { + "ApiManagementListWorkspaceDiagnostics": { + "$ref": "./examples/ApiManagementListWorkspaceDiagnostics.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result response of diagnostics.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticCollection" + } + }, + "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-odata": "./definitions.json#/definitions/DiagnosticContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics/{diagnosticId}": { + "head": { + "tags": [ + "Diagnostic" + ], + "operationId": "WorkspaceDiagnostic_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Diagnostic specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceDiagnostic": { + "$ref": "./examples/ApiManagementHeadWorkspaceDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the entity tag of the diagnostic", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Diagnostic" + ], + "operationId": "WorkspaceDiagnostic_Get", + "description": "Gets the details of the Diagnostic specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceDiagnostic": { + "$ref": "./examples/ApiManagementGetWorkspaceDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Diagnostic entity.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Diagnostic" + ], + "operationId": "WorkspaceDiagnostic_CreateOrUpdate", + "description": "Creates a new Diagnostic or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceDiagnostic": { + "$ref": "./examples/ApiManagementCreateWorkspaceDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Diagnostic was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + } + }, + "200": { + "description": "Diagnostic successfully updated", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Diagnostic" + ], + "operationId": "WorkspaceDiagnostic_Update", + "description": "Updates the details of the Diagnostic specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceDiagnostic": { + "$ref": "./examples/ApiManagementUpdateWorkspaceDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticUpdateContract" + }, + "description": "Diagnostic Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Diagnostic successfully updated", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Diagnostic" + ], + "operationId": "WorkspaceDiagnostic_Delete", + "description": "Deletes the specified Diagnostic.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceDiagnostic": { + "$ref": "./examples/ApiManagementDeleteWorkspaceDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Diagnostic was successfully deleted." + }, + "204": { + "description": "The Diagnostic was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics": { + "get": { + "tags": [ + "ApiDiagnostic" + ], + "operationId": "WorkspaceApiDiagnostic_ListByWorkspace", + "description": "Lists all diagnostics of an API.", + "x-ms-examples": { + "ApiManagementListWorkspaceApiDiagnostics": { + "$ref": "./examples/ApiManagementListWorkspaceApiDiagnostics.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result response of diagnostics for an API.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticCollection" + } + }, + "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-odata": "./definitions.json#/definitions/DiagnosticContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId}": { + "head": { + "tags": [ + "ApiDiagnostic" + ], + "operationId": "WorkspaceApiDiagnostic_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiDiagnostic": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiDiagnostic" + ], + "operationId": "WorkspaceApiDiagnostic_Get", + "description": "Gets the details of the Diagnostic for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceApiDiagnostic": { + "$ref": "./examples/ApiManagementGetWorkspaceApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Diagnostic entity.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiDiagnostic" + ], + "operationId": "WorkspaceApiDiagnostic_CreateOrUpdate", + "description": "Creates a new Diagnostic for an API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiDiagnostic": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Diagnostic was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Diagnostic was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiDiagnostic" + ], + "operationId": "WorkspaceApiDiagnostic_Update", + "description": "Updates the details of the Diagnostic for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceApiDiagnostic": { + "$ref": "./examples/ApiManagementUpdateWorkspaceApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticUpdateContract" + }, + "description": "Diagnostic Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Diagnostic was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiDiagnostic" + ], + "operationId": "WorkspaceApiDiagnostic_Delete", + "description": "Deletes the specified Diagnostic from an API.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceApiDiagnostic": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Diagnostic successfully removed" + }, + "204": { + "description": "Diagnostic successfully removed by previous request or does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacelinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacelinks.json new file mode 100644 index 000000000000..f0c06019d47a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacelinks.json @@ -0,0 +1,129 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs to manage Azure API Management WorkspaceLinks deployments.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaceLinks": { + "get": { + "tags": [ + "ApiManagementWorkspaceLinks" + ], + "operationId": "ApiManagementWorkspaceLinks_ListByService", + "description": "List all API Management workspaceLinks for a service.", + "x-ms-examples": { + "ApiManagementListGatewayConfigConnection": { + "$ref": "./examples/ApiManagementListWorkspaceLinks.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "The API Management gateway workspaceLinks list.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiManagementWorkspaceLinksListResult" + } + }, + "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.ApiManagement/service/{serviceName}/workspaceLinks/{workspaceId}": { + "get": { + "tags": [ + "ApiManagementWorkspaceLinks" + ], + "operationId": "ApiManagementWorkspaceLink_Get", + "description": "Gets an API Management WorkspaceLink resource description.", + "x-ms-examples": { + "ApiManagementGetWorkspaceLinks": { + "$ref": "./examples/ApiManagementGetWorkspaceLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully got the API Management WorkspaceLink resource.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiManagementWorkspaceLinksResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspaceloggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspaceloggers.json new file mode 100644 index 000000000000..5812e701be63 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspaceloggers.json @@ -0,0 +1,400 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on logger entity Azure API Management deployment.The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure EventHub.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers": { + "get": { + "tags": [ + "Logger" + ], + "operationId": "WorkspaceLogger_ListByWorkspace", + "description": "Lists a collection of loggers in the specified workspace.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-log-event-hubs" + }, + "x-ms-examples": { + "ApiManagementListWorkspaceLoggers": { + "$ref": "./examples/ApiManagementListWorkspaceLoggers.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Logger entities.", + "schema": { + "$ref": "./definitions.json#/definitions/LoggerCollection" + } + }, + "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-odata": "./definitions.json#/definitions/LoggerContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers/{loggerId}": { + "head": { + "tags": [ + "Logger" + ], + "operationId": "WorkspaceLogger_GetEntityTag", + "description": "Gets the entity state (Etag) version of the logger specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceLogger": { + "$ref": "./examples/ApiManagementHeadWorkspaceLogger.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified logger entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Logger" + ], + "operationId": "WorkspaceLogger_Get", + "description": "Gets the details of the logger specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceLogger": { + "$ref": "./examples/ApiManagementGetWorkspaceLogger.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Logger entity.", + "schema": { + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Logger" + ], + "operationId": "WorkspaceLogger_CreateOrUpdate", + "description": "Creates or Updates a logger.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceEHLogger": { + "$ref": "./examples/ApiManagementCreateWorkspaceEHLogger.json" + }, + "ApiManagementCreateWorkspaceAILogger": { + "$ref": "./examples/ApiManagementCreateWorkspaceAILogger.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Logger was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "The existing logger was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Logger" + ], + "operationId": "WorkspaceLogger_Update", + "description": "Updates an existing logger.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceLogger": { + "$ref": "./examples/ApiManagementUpdateWorkspaceLogger.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/LoggerUpdateContract" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing logger was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Logger" + ], + "operationId": "WorkspaceLogger_Delete", + "description": "Deletes the specified logger.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceLogger": { + "$ref": "./examples/ApiManagementDeleteWorkspaceLogger.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The logger was successfully deleted." + }, + "204": { + "description": "The logger was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspaces.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspaces.json new file mode 100644 index 000000000000..e8e8e267a81f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspaces.json @@ -0,0 +1,8367 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Workspace entity and its associated entities within your Azure API Management deployment.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspace_ListByService", + "description": "Lists all workspaces of the API Management service instance.", + "x-ms-examples": { + "ApiManagementListWorkspaces": { + "$ref": "./examples/ApiManagementListWorkspaces.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result response of workspaces.", + "schema": { + "$ref": "./definitions.json#/definitions/WorkspaceCollection" + } + }, + "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-odata": "./definitions.json#/definitions/WorkspaceContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}": { + "head": { + "tags": [ + "Workspace" + ], + "operationId": "Workspace_GetEntityTag", + "description": "Gets the entity state (Etag) version of the workspace specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspace": { + "$ref": "./examples/ApiManagementHeadWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the entity tag of the workspace", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspace_Get", + "description": "Gets the details of the workspace specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspace": { + "$ref": "./examples/ApiManagementGetWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified workspace entity.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/WorkspaceContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Workspace" + ], + "operationId": "Workspace_CreateOrUpdate", + "description": "Creates a new workspace or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateWorkspace": { + "$ref": "./examples/ApiManagementCreateWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/WorkspaceContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Workspace was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/WorkspaceContract" + } + }, + "200": { + "description": "Workspace successfully updated", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/WorkspaceContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Workspace" + ], + "operationId": "Workspace_Update", + "description": "Updates the details of the workspace specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateWorkspace": { + "$ref": "./examples/ApiManagementUpdateWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/WorkspaceContract" + }, + "description": "Workspace Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Workspace successfully updated", + "schema": { + "$ref": "./definitions.json#/definitions/WorkspaceContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Workspace" + ], + "operationId": "Workspace_Delete", + "description": "Deletes the specified workspace.", + "x-ms-examples": { + "ApiManagementDeleteWorkspace": { + "$ref": "./examples/ApiManagementDeleteWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The workspace was successfully deleted." + }, + "204": { + "description": "The workspace was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies": { + "get": { + "tags": [ + "WorkspacePolicy" + ], + "operationId": "WorkspacePolicy_ListByApi", + "description": "Get the policy configuration at the workspace level.", + "x-ms-examples": { + "ApiManagementListWorkspacePolicies": { + "$ref": "./examples/ApiManagementListWorkspacePolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Workspace Policy Collection.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyCollection" + } + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies/{policyId}": { + "head": { + "tags": [ + "WorkspacePolicy" + ], + "operationId": "WorkspacePolicy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the workspace policy specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspacePolicy": { + "$ref": "./examples/ApiManagementHeadWorkspacePolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified workspace Policy entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "WorkspacePolicy" + ], + "operationId": "WorkspacePolicy_Get", + "description": "Get the policy configuration at the API level.", + "x-ms-examples": { + "ApiManagementGetWorkspacePolicy": { + "$ref": "./examples/ApiManagementGetWorkspacePolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Workspace Policy information.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WorkspacePolicy" + ], + "operationId": "WorkspacePolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the workspace.", + "x-ms-examples": { + "ApiManagementCreateWorkspacePolicy": { + "$ref": "./examples/ApiManagementCreateWorkspacePolicy.json" + }, + "ApiManagementCreateWorkspacePolicyNonXmlEncoded": { + "$ref": "./examples/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "description": "The policy contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Workspace policy configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Workspace policy configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WorkspacePolicy" + ], + "operationId": "WorkspacePolicy_Delete", + "description": "Deletes the policy configuration at the workspace.", + "x-ms-examples": { + "ApiManagementDeleteWorkspacePolicy": { + "$ref": "./examples/ApiManagementDeleteWorkspacePolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the policy configuration at the workspace level." + }, + "204": { + "description": "Successfully deleted the policy configuration at the workspace level." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues": { + "get": { + "tags": [ + "NamedValue" + ], + "operationId": "WorkspaceNamedValue_ListByService", + "description": "Lists a collection of named values defined within a workspace in a service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties" + }, + "x-ms-examples": { + "ApiManagementListWorkspaceNamedValues": { + "$ref": "./examples/ApiManagementListWorkspaceNamedValues.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "isKeyVaultRefreshFailed", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "KeyVaultRefreshState", + "modelAsString": true, + "values": [ + { + "value": "true", + "description": "Entities for which KeyVault refresh failed." + }, + { + "value": "false", + "description": "Entities for which KeyVault refresh succeeded" + } + ] + }, + "description": "Query parameter to fetch named value entities based on refresh status." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the named value entities for the specified workspace in an API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueCollection" + } + }, + "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-odata": "./definitions.json#/definitions/NamedValueContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}": { + "head": { + "tags": [ + "NamedValue" + ], + "operationId": "WorkspaceNamedValue_GetEntityTag", + "description": "Gets the entity state (Etag) version of the named value specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceNamedValue": { + "$ref": "./examples/ApiManagementHeadWorkspaceNamedValue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified named value entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "NamedValue" + ], + "operationId": "WorkspaceNamedValue_Get", + "description": "Gets the details of the named value specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceNamedValue": { + "$ref": "./examples/ApiManagementGetWorkspaceNamedValue.json" + }, + "ApiManagementGetWorkspaceNamedValueWithKeyVault": { + "$ref": "./examples/ApiManagementGetWorkspaceNamedValueWithKeyVault.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified named value entity. No secrets included", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "NamedValue" + ], + "operationId": "WorkspaceNamedValue_CreateOrUpdate", + "description": "Creates or updates named value.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceNamedValue": { + "$ref": "./examples/ApiManagementCreateWorkspaceNamedValue.json" + }, + "ApiManagementCreateWorkspaceNamedValueWithKeyVault": { + "$ref": "./examples/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueCreateContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Named value was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "200": { + "description": "Named value was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "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" + } + }, + "patch": { + "tags": [ + "NamedValue" + ], + "operationId": "WorkspaceNamedValue_Update", + "description": "Updates the specific named value.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceNamedValue": { + "$ref": "./examples/ApiManagementUpdateWorkspaceNamedValue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Request to create or update named value was accepted.", + "headers": { + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "200": { + "description": "Named value was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "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" + } + }, + "delete": { + "tags": [ + "NamedValue" + ], + "operationId": "WorkspaceNamedValue_Delete", + "description": "Deletes specific named value from the workspace in an API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceNamedValue": { + "$ref": "./examples/ApiManagementDeleteWorkspaceNamedValue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Named value was successfully deleted." + }, + "204": { + "description": "Named value was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}/listValue": { + "post": { + "tags": [ + "NamedValue" + ], + "operationId": "WorkspaceNamedValue_ListValue", + "description": "Gets the secret of the named value specified by its identifier.", + "x-ms-examples": { + "ApiManagementWorkspaceNamedValueListValue": { + "$ref": "./examples/ApiManagementWorkspaceNamedValueListValue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified named value secret.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueSecretContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}/refreshSecret": { + "post": { + "tags": [ + "NamedValue" + ], + "operationId": "WorkspaceNamedValue_RefreshSecret", + "description": "Refresh the secret of the named value specified by its identifier.", + "x-ms-examples": { + "ApiManagementRefreshWorkspaceNamedValue": { + "$ref": "./examples/ApiManagementRefreshWorkspaceNamedValue.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Request to refresh secret was accepted.", + "headers": { + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "200": { + "description": "Named value was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas": { + "get": { + "tags": [ + "Schema" + ], + "operationId": "WorkspaceGlobalSchema_ListByService", + "description": "Lists a collection of schemas registered with workspace in a service instance.", + "x-ms-examples": { + "ApiManagementListWorkspaceSchemas": { + "$ref": "./examples/ApiManagementListWorkspaceSchemas.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Schema entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaCollection" + } + }, + "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-odata": "./definitions.json#/definitions/GlobalSchemaContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId}": { + "head": { + "tags": [ + "Schema" + ], + "operationId": "WorkspaceGlobalSchema_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Schema specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceSchema": { + "$ref": "./examples/ApiManagementHeadWorkspaceSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Schema entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Schema" + ], + "operationId": "WorkspaceGlobalSchema_Get", + "description": "Gets the details of the Schema specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceSchema": { + "$ref": "./examples/ApiManagementGetWorkspaceSchema.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Schema entity.", + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Schema" + ], + "operationId": "WorkspaceGlobalSchema_CreateOrUpdate", + "description": "Creates new or updates existing specified Schema of the workspace in an API Management service instance.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceSchema": { + "$ref": "./examples/ApiManagementCreateWorkspaceSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new Schema was successfully added.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaContract" + } + }, + "200": { + "description": "The Schema details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaContract" + } + }, + "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" + } + }, + "delete": { + "tags": [ + "Schema" + ], + "operationId": "WorkspaceGlobalSchema_Delete", + "description": "Deletes specific Schema.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceSchema": { + "$ref": "./examples/ApiManagementDeleteWorkspaceSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Schema was successfully deleted." + }, + "204": { + "description": "The Schema was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications": { + "get": { + "tags": [ + "Notification" + ], + "operationId": "WorkspaceNotification_ListByService", + "description": "Lists a collection of properties defined within a service instance.", + "x-ms-examples": { + "ApiManagementListWorkspaceNotifications": { + "$ref": "./examples/ApiManagementListWorkspaceNotifications.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Notification for the specified workspace in a API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/NotificationCollection" + } + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}": { + "get": { + "tags": [ + "Notification" + ], + "operationId": "WorkspaceNotification_Get", + "description": "Gets the details of the Notification specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceNotification": { + "$ref": "./examples/ApiManagementGetWorkspaceNotification.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Notification.", + "schema": { + "$ref": "./definitions.json#/definitions/NotificationContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Notification" + ], + "operationId": "WorkspaceNotification_CreateOrUpdate", + "description": "Create or Update API Management publisher notification for the workspace.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceNotification": { + "$ref": "./examples/ApiManagementCreateWorkspaceNotification.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Notification was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/NotificationContract" + } + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers": { + "get": { + "tags": [ + "NotificationRecipientUser" + ], + "operationId": "WorkspaceNotificationRecipientUser_ListByNotification", + "description": "Gets the list of the Notification Recipient User subscribed to the notification.", + "x-ms-examples": { + "ApiManagementListWorkspaceNotificationRecipientUsers": { + "$ref": "./examples/ApiManagementListWorkspaceNotificationRecipientUsers.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the Recipient User collection for the notification.", + "schema": { + "$ref": "./definitions.json#/definitions/RecipientUserCollection" + } + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers/{userId}": { + "head": { + "tags": [ + "NotificationRecipientUser" + ], + "operationId": "WorkspaceNotificationRecipientUser_CheckEntityExists", + "description": "Determine if the Notification Recipient User is subscribed to the notification.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceNotificationRecipientUser": { + "$ref": "./examples/ApiManagementHeadWorkspaceNotificationRecipientUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The User is subscribed to receive the notification." + }, + "404": { + "description": "Entity does not exists." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "NotificationRecipientUser" + ], + "operationId": "WorkspaceNotificationRecipientUser_CreateOrUpdate", + "description": "Adds the API Management User to the list of Recipients for the Notification.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceNotificationRecipientUser": { + "$ref": "./examples/ApiManagementCreateWorkspaceNotificationRecipientUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Recipient User was successfully added to the notification list.", + "schema": { + "$ref": "./definitions.json#/definitions/RecipientUserContract" + } + }, + "200": { + "description": "Recipient User is already part of the notification list.", + "schema": { + "$ref": "./definitions.json#/definitions/RecipientUserContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "NotificationRecipientUser" + ], + "operationId": "WorkspaceNotificationRecipientUser_Delete", + "description": "Removes the API Management user from the list of Notification.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceNotificationRecipientUser": { + "$ref": "./examples/ApiManagementDeleteWorkspaceNotificationRecipientUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Recipient User was successfully removed from the notification list." + }, + "204": { + "description": "Recipient User was successfully removed from the notification list." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails": { + "get": { + "tags": [ + "NotificationRecipientEmail" + ], + "operationId": "WorkspaceNotificationRecipientEmail_ListByNotification", + "description": "Gets the list of the Notification Recipient Emails subscribed to a notification.", + "x-ms-examples": { + "ApiManagementListWorkspaceNotificationRecipientEmails": { + "$ref": "./examples/ApiManagementListWorkspaceNotificationRecipientEmails.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the Recipient Email collection subscribed to the notification.", + "schema": { + "$ref": "./definitions.json#/definitions/RecipientEmailCollection" + } + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails/{email}": { + "head": { + "tags": [ + "NotificationRecipientEmail" + ], + "operationId": "WorkspaceNotificationRecipientEmail_CheckEntityExists", + "description": "Determine if Notification Recipient Email subscribed to the notification.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementHeadWorkspaceNotificationRecipientEmail.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/EmailParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The Users is subscribed to receive the notification." + }, + "404": { + "description": "The Users is not subscribed to receive the notification." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "NotificationRecipientEmail" + ], + "operationId": "WorkspaceNotificationRecipientEmail_CreateOrUpdate", + "description": "Adds the Email address to the list of Recipients for the Notification.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementCreateWorkspaceNotificationRecipientEmail.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/EmailParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Recipient Email was successfully added to the notification list.", + "schema": { + "$ref": "./definitions.json#/definitions/RecipientEmailContract" + } + }, + "200": { + "description": "Recipient Email is already part of the notification list.", + "schema": { + "$ref": "./definitions.json#/definitions/RecipientEmailContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "NotificationRecipientEmail" + ], + "operationId": "WorkspaceNotificationRecipientEmail_Delete", + "description": "Removes the email from the list of Notification.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/EmailParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Recipient Email was successfully removed to the notification list." + }, + "204": { + "description": "Recipient Email was successfully removed to the notification list." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments": { + "get": { + "tags": [ + "PolicyFragment" + ], + "operationId": "WorkspacePolicyFragment_ListByService", + "description": "Gets all policy fragments defined within a workspace.", + "x-ms-examples": { + "ApiManagementListWorkspacePolicyFragments": { + "$ref": "./examples/ApiManagementListWorkspacePolicyFragments.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + } + ], + "responses": { + "200": { + "description": "Successfully returned an array of policy fragments.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyFragmentCollection" + } + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}": { + "head": { + "tags": [ + "PolicyFragment" + ], + "operationId": "WorkspacePolicyFragment_GetEntityTag", + "description": "Gets the entity state (Etag) version of a policy fragment.", + "x-ms-examples": { + "ApiManagementHeadWorkspacePolicyFragment": { + "$ref": "./examples/ApiManagementHeadWorkspacePolicyFragment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The specified policy fragment exists and the current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "PolicyFragment" + ], + "operationId": "WorkspacePolicyFragment_Get", + "description": "Gets a policy fragment.", + "x-ms-examples": { + "ApiManagementGetWorkspacePolicyFragment": { + "$ref": "./examples/ApiManagementGetWorkspacePolicyFragment.json" + }, + "ApiManagementGetWorkspacePolicyFragmentFormat": { + "$ref": "./examples/ApiManagementGetWorkspacePolicyFragmentFormat.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyFragmentContentFormat" + } + ], + "responses": { + "200": { + "description": "Successfully returned a policy fragment.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyFragmentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PolicyFragment" + ], + "operationId": "WorkspacePolicyFragment_CreateOrUpdate", + "description": "Creates or updates a policy fragment.", + "x-ms-examples": { + "ApiManagementCreateWorkspacePolicyFragment": { + "$ref": "./examples/ApiManagementCreateWorkspacePolicyFragment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyFragmentContract" + }, + "description": "The policy fragment contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The policy fragment was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyFragmentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "201": { + "description": "The policy fragment was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyFragmentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "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" + } + }, + "delete": { + "tags": [ + "PolicyFragment" + ], + "operationId": "WorkspacePolicyFragment_Delete", + "description": "Deletes a policy fragment.", + "x-ms-examples": { + "ApiManagementDeleteWorkspacePolicyFragment": { + "$ref": "./examples/ApiManagementDeleteWorkspacePolicyFragment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The policy fragment was successfully removed." + }, + "204": { + "description": "The policy fragment successfully removed by previous request or does not exist." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}/listReferences": { + "post": { + "tags": [ + "PolicyFragment" + ], + "operationId": "WorkspacePolicyFragment_ListReferences", + "description": "Lists policy resources that reference the policy fragment.", + "x-ms-examples": { + "ApiManagementListWorkspacePolicyFragmentReferences": { + "$ref": "./examples/ApiManagementListWorkspacePolicyFragmentReferences.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + } + ], + "responses": { + "200": { + "description": "Successfully returned an array of references to policy resources that include the policy fragment in their definitions.", + "schema": { + "$ref": "./definitions.json#/definitions/ResourceCollection" + } + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups": { + "get": { + "tags": [ + "Group" + ], + "operationId": "WorkspaceGroup_ListByService", + "description": "Lists a collection of groups defined within a workspace in a service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-groups" + }, + "x-ms-examples": { + "ApiManagementListWorkspaceGroups": { + "$ref": "./examples/ApiManagementListWorkspaceGroups.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| externalId | filter | eq | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Group entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupCollection" + } + }, + "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-odata": "./definitions.json#/definitions/GroupContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}": { + "head": { + "tags": [ + "Group" + ], + "operationId": "WorkspaceGroup_GetEntityTag", + "description": "Gets the entity state (Etag) version of the group specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceGroup": { + "$ref": "./examples/ApiManagementHeadWorkspaceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified group entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Group" + ], + "operationId": "WorkspaceGroup_Get", + "description": "Gets the details of the group specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceGroup": { + "$ref": "./examples/ApiManagementGetWorkspaceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Group entity.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Group" + ], + "operationId": "WorkspaceGroup_CreateOrUpdate", + "description": "Creates or Updates a group.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceGroup": { + "$ref": "./examples/ApiManagementCreateWorkspaceGroup.json" + }, + "ApiManagementCreateWorkspaceGroupExternal": { + "$ref": "./examples/ApiManagementCreateWorkspaceGroupExternal.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GroupCreateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Group was created successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Group already exists.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Group" + ], + "operationId": "WorkspaceGroup_Update", + "description": "Updates the details of the group specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceGroup": { + "$ref": "./examples/ApiManagementUpdateWorkspaceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GroupUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The group details were successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Group" + ], + "operationId": "WorkspaceGroup_Delete", + "description": "Deletes specific group of the workspace in an API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceGroup": { + "$ref": "./examples/ApiManagementDeleteWorkspaceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The group was successfully deleted." + }, + "204": { + "description": "The group was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users": { + "get": { + "tags": [ + "GroupUser" + ], + "operationId": "WorkspaceGroupUser_List", + "description": "Lists a collection of user entities associated with the group.", + "x-ms-examples": { + "ApiManagementListWorkspaceGroupUsers": { + "$ref": "./examples/ApiManagementListWorkspaceGroupUsers.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of user entities associated with the group.", + "schema": { + "$ref": "./definitions.json#/definitions/UserCollection" + } + }, + "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-odata": "./definitions.json#/definitions/UserContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users/{userId}": { + "head": { + "tags": [ + "GroupUser" + ], + "operationId": "WorkspaceGroupUser_CheckEntityExists", + "description": "Checks that user entity specified by identifier is associated with the group entity.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceGroupUser": { + "$ref": "./examples/ApiManagementHeadWorkspaceGroupUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Entity exists" + }, + "404": { + "description": "Entity does not exists." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "GroupUser" + ], + "operationId": "WorkspaceGroupUser_Create", + "description": "Add existing user to existing group", + "x-ms-examples": { + "ApiManagementCreateWorkspaceGroupUser": { + "$ref": "./examples/ApiManagementCreateWorkspaceGroupUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The user was successfully added to the group.", + "schema": { + "$ref": "./definitions.json#/definitions/UserContract" + } + }, + "200": { + "description": "The specified user is already a member of the specified group.", + "schema": { + "$ref": "./definitions.json#/definitions/UserContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GroupUser" + ], + "operationId": "WorkspaceGroupUser_Delete", + "description": "Remove existing user from existing group.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceGroupUser": { + "$ref": "./examples/ApiManagementDeleteWorkspaceGroupUser.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The user was successfully removed from the group." + }, + "204": { + "description": "The user was successfully removed from the group." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions": { + "get": { + "tags": [ + "Subscription" + ], + "operationId": "WorkspaceSubscription_List", + "description": "Lists all subscriptions of the workspace in an API Management service instance.", + "x-ms-examples": { + "ApiManagementListWorkspaceSubscriptions": { + "$ref": "./examples/ApiManagementListWorkspaceSubscriptions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A collection of the Subscription entities for the specified workspace in an API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionCollection" + } + }, + "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-odata": "./definitions.json#/definitions/SubscriptionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}": { + "head": { + "tags": [ + "Subscription" + ], + "operationId": "WorkspaceSubscription_GetEntityTag", + "description": "Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceSubscription": { + "$ref": "./examples/ApiManagementHeadWorkspaceSubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified apimanagement subscription entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Subscription" + ], + "operationId": "WorkspaceSubscription_Get", + "description": "Gets the specified Subscription entity.", + "x-ms-examples": { + "ApiManagementGetWorkspaceSubscription": { + "$ref": "./examples/ApiManagementGetWorkspaceSubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Subscription entity.", + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Subscription" + ], + "operationId": "WorkspaceSubscription_CreateOrUpdate", + "description": "Creates or updates the subscription of specified user to the specified product.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceSubscription": { + "$ref": "./examples/ApiManagementCreateWorkspaceSubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionCreateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/NotifySubscriptionStateChangeParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AppTypeParameter" + } + ], + "responses": { + "201": { + "description": "The user was successfully subscribed to the product.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionContract" + } + }, + "200": { + "description": "The user already subscribed to the product.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Subscription" + ], + "operationId": "WorkspaceSubscription_Update", + "description": "Updates the details of a subscription specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceSubscription": { + "$ref": "./examples/ApiManagementUpdateWorkspaceSubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/NotifySubscriptionStateChangeParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AppTypeParameter" + } + ], + "responses": { + "200": { + "description": "The subscription details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Subscription" + ], + "operationId": "WorkspaceSubscription_Delete", + "description": "Deletes the specified subscription.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceSubscription": { + "$ref": "./examples/ApiManagementDeleteWorkspaceSubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The subscription details were successfully deleted." + }, + "204": { + "description": "The subscription details were successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/regeneratePrimaryKey": { + "post": { + "tags": [ + "Subscription" + ], + "operationId": "WorkspaceSubscription_RegeneratePrimaryKey", + "description": "Regenerates primary key of existing subscription of the workspace in an API Management service instance.", + "x-ms-examples": { + "ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey": { + "$ref": "./examples/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The primary key was successfully regenerated." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/regenerateSecondaryKey": { + "post": { + "tags": [ + "Subscription" + ], + "operationId": "WorkspaceSubscription_RegenerateSecondaryKey", + "description": "Regenerates secondary key of existing subscription of the workspace in an API Management service instance.", + "x-ms-examples": { + "ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey": { + "$ref": "./examples/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The secondary key was successfully regenerated." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/listSecrets": { + "post": { + "tags": [ + "Subscription" + ], + "operationId": "WorkspaceSubscription_ListSecrets", + "description": "Gets the specified Subscription keys.", + "x-ms-examples": { + "ApiManagementWorkspaceSubscriptionListSecrets": { + "$ref": "./examples/ApiManagementWorkspaceSubscriptionListSecrets.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains subscription keys.", + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionKeysContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets": { + "get": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "WorkspaceApiVersionSet_ListByService", + "description": "Lists a collection of API Version Sets in the specified workspace with a service instance.", + "x-ms-examples": { + "ApiManagementListWorkspaceApiVersionSets": { + "$ref": "./examples/ApiManagementListWorkspaceApiVersionSets.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Api Version Set entities.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ApiVersionSetContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}": { + "head": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "WorkspaceApiVersionSet_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Api Version Set specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiVersionSet": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Api Version Set entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "WorkspaceApiVersionSet_Get", + "description": "Gets the details of the Api Version Set specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceApiVersionSet": { + "$ref": "./examples/ApiManagementGetWorkspaceApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the specified Api Version Set entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "WorkspaceApiVersionSet_CreateOrUpdate", + "description": "Creates or Updates a Api Version Set.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiVersionSet": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api Version Set was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Api Version Set was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "WorkspaceApiVersionSet_Update", + "description": "Updates the details of the Api VersionSet specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceApiVersionSet": { + "$ref": "./examples/ApiManagementUpdateWorkspaceApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Version Set was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiVersionSets" + ], + "operationId": "WorkspaceApiVersionSet_Delete", + "description": "Deletes specific Api Version Set.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceApiVersionSet": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The ApiVersion Set details were successfully deleted." + }, + "204": { + "description": "The ApiVersion Set details were successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis": { + "get": { + "tags": [ + "Api" + ], + "operationId": "WorkspaceApi_ListByService", + "description": "Lists all APIs of the workspace in an API Management service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis" + }, + "x-ms-examples": { + "ApiManagementListWorkspaceApis": { + "$ref": "./examples/ApiManagementListWorkspaceApis.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "tags", + "in": "query", + "required": false, + "type": "string", + "description": "Include tags in the response." + }, + { + "name": "expandApiVersionSet", + "in": "query", + "required": false, + "type": "boolean", + "description": "Include full ApiVersionSet resource in response" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result response of Apis.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ApiContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}": { + "head": { + "tags": [ + "Api" + ], + "operationId": "WorkspaceApi_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceApi": { + "$ref": "./examples/ApiManagementHeadWorkspaceApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Api" + ], + "operationId": "WorkspaceApi_Get", + "description": "Gets the details of the API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceApiContract": { + "$ref": "./examples/ApiManagementGetWorkspaceApiContract.json" + }, + "ApiManagementGetWorkspaceApiRevision": { + "$ref": "./examples/ApiManagementGetWorkspaceApiRevision.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified API entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Api" + ], + "operationId": "WorkspaceApi_CreateOrUpdate", + "description": "Creates new or updates existing specified API of the workspace in an API Management service instance.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceApi": { + "$ref": "./examples/ApiManagementCreateWorkspaceApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiCreateOrUpdateParameter" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "API was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "200": { + "description": "API was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "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" + } + }, + "patch": { + "tags": [ + "Api" + ], + "operationId": "WorkspaceApi_Update", + "description": "Updates the specified API of the workspace in an API Management service instance.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceApi": { + "$ref": "./examples/ApiManagementUpdateWorkspaceApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiUpdateContract" + }, + "description": "API Update Contract parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Api" + ], + "operationId": "WorkspaceApi_Delete", + "description": "Deletes the specified API of the workspace in an API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceApi": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApi.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "deleteRevisions", + "in": "query", + "required": false, + "type": "boolean", + "description": "Delete all revisions of the Api." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The API was successfully deleted." + }, + "204": { + "description": "The API was successfully deleted." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/revisions": { + "get": { + "tags": [ + "ApiRevision" + ], + "operationId": "WorkspaceApiRevision_ListByService", + "description": "Lists all revisions of an API.", + "x-ms-examples": { + "ApiManagementListWorkspaceApiRevisions": { + "$ref": "./examples/ApiManagementListWorkspaceApiRevisions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a list of revision details.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiRevisionCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ApiRevisionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases": { + "get": { + "tags": [ + "ApiRelease" + ], + "operationId": "WorkspaceApiRelease_ListByService", + "description": "Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.", + "x-ms-examples": { + "ApiManagementListWorkspaceApiReleases": { + "$ref": "./examples/ApiManagementListWorkspaceApiReleases.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| notes | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a list of API Releases.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ApiReleaseContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}": { + "head": { + "tags": [ + "ApiRelease" + ], + "operationId": "WorkspaceApiRelease_GetEntityTag", + "description": "Returns the etag of an API release.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiRelease": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the entity state (Etag) version of the api release as specified by its identifier.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiRelease" + ], + "operationId": "WorkspaceApiRelease_Get", + "description": "Returns the details of an API release.", + "x-ms-examples": { + "ApiManagementGetWorkspaceApiRelease": { + "$ref": "./examples/ApiManagementGetWorkspaceApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns the details of an API Release.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiRelease" + ], + "operationId": "WorkspaceApiRelease_CreateOrUpdate", + "description": "Creates a new Release for the API.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiRelease": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Release was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Release was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiRelease" + ], + "operationId": "WorkspaceApiRelease_Update", + "description": "Updates the details of the release of the API specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceApiRelease": { + "$ref": "./examples/ApiManagementUpdateWorkspaceApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "description": "API Release Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Release was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiRelease" + ], + "operationId": "WorkspaceApiRelease_Delete", + "description": "Deletes the specified release in the API.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceApiRelease": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API release successfully removed" + }, + "204": { + "description": "API release successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations": { + "get": { + "tags": [ + "ApiOperation" + ], + "operationId": "WorkspaceApiOperation_ListByApi", + "description": "Lists a collection of the operations for the specified API.", + "x-ms-examples": { + "ApiManagementListWorkspaceApiOperations": { + "$ref": "./examples/ApiManagementListWorkspaceApiOperations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "tags", + "in": "query", + "required": false, + "type": "string", + "description": "Include tags in the response." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A collection of operation summary entities at the API level.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationCollection" + } + }, + "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-odata": "./definitions.json#/definitions/OperationContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}": { + "head": { + "tags": [ + "ApiOperation" + ], + "operationId": "WorkspaceApiOperation_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API operation specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiOperation": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API operation entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiOperation" + ], + "operationId": "WorkspaceApiOperation_Get", + "description": "Gets the details of the API Operation specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceApiOperation": { + "$ref": "./examples/ApiManagementGetWorkspaceApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Operation entity.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiOperation" + ], + "operationId": "WorkspaceApiOperation_CreateOrUpdate", + "description": "Creates a new operation in the API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiOperation": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Operation was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Operation was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiOperation" + ], + "operationId": "WorkspaceApiOperation_Update", + "description": "Updates the details of the operation in the API specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceApiOperation": { + "$ref": "./examples/ApiManagementUpdateWorkspaceApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/OperationUpdateContract" + }, + "description": "API Operation Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiOperation" + ], + "operationId": "WorkspaceApiOperation_Delete", + "description": "Deletes the specified operation in the API.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceApiOperation": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API operation successfully removed" + }, + "204": { + "description": "API operation successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies": { + "get": { + "tags": [ + "ApiOperationPolicy" + ], + "operationId": "WorkspaceApiOperationPolicy_ListByOperation", + "description": "Get the list of policy configuration at the API Operation level.", + "x-ms-examples": { + "ApiManagementListWorkspaceApiOperationPolicies": { + "$ref": "./examples/ApiManagementListWorkspaceApiOperationPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Operations Policy Collection.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyCollection" + } + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies/{policyId}": { + "head": { + "tags": [ + "ApiOperationPolicy" + ], + "operationId": "WorkspaceApiOperationPolicy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API operation policy specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiOperationPolicy": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiOperationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API operation policy entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiOperationPolicy" + ], + "operationId": "WorkspaceApiOperationPolicy_Get", + "description": "Get the policy configuration at the API Operation level.", + "x-ms-examples": { + "ApiManagementGetWorkspaceApiOperationPolicy": { + "$ref": "./examples/ApiManagementGetWorkspaceApiOperationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Operation Policy information.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiOperationPolicy" + ], + "operationId": "WorkspaceApiOperationPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the API Operation level.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiOperationPolicy": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiOperationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "description": "The policy contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api Operation policy configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Api Operation policy configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiOperationPolicy" + ], + "operationId": "WorkspaceApiOperationPolicy_Delete", + "description": "Deletes the policy configuration at the Api Operation.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceApiOperationPolicy": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiOperationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Policy successfully removed" + }, + "204": { + "description": "Policy successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies": { + "get": { + "tags": [ + "ApiPolicy" + ], + "operationId": "WorkspaceApiPolicy_ListByApi", + "description": "Get the policy configuration at the API level.", + "x-ms-examples": { + "ApiManagementListWorkspaceApiPolicies": { + "$ref": "./examples/ApiManagementListWorkspaceApiPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Apis Policy Collection.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyCollection" + } + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}": { + "head": { + "tags": [ + "ApiPolicy" + ], + "operationId": "WorkspaceApiPolicy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API policy specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiPolicy": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API Policy entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiPolicy" + ], + "operationId": "WorkspaceApiPolicy_Get", + "description": "Get the policy configuration at the API level.", + "x-ms-examples": { + "ApiManagementGetWorkspaceApiPolicy": { + "$ref": "./examples/ApiManagementGetWorkspaceApiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Policy information.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiPolicy" + ], + "operationId": "WorkspaceApiPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the API.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiPolicy": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "description": "The policy contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api policy configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Api policy configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiPolicy" + ], + "operationId": "WorkspaceApiPolicy_Delete", + "description": "Deletes the policy configuration at the Api.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceApiPolicy": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the policy configuration at the API level." + }, + "204": { + "description": "Successfully deleted the policy configuration at the API level." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas": { + "get": { + "tags": [ + "ApiSchema" + ], + "operationId": "WorkspaceApiSchema_ListByApi", + "description": "Get the schema configuration at the API level.", + "x-ms-examples": { + "ApiManagementListWorkspaceApiSchemas": { + "$ref": "./examples/ApiManagementListWorkspaceApiSchemas.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Apis Schema Collection.", + "schema": { + "$ref": "./definitions.json#/definitions/SchemaCollection" + } + }, + "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-odata": "./definitions.json#/definitions/SchemaContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas/{schemaId}": { + "head": { + "tags": [ + "ApiSchema" + ], + "operationId": "WorkspaceApiSchema_GetEntityTag", + "description": "Gets the entity state (Etag) version of the schema specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiSchema": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified schema entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiSchema" + ], + "operationId": "WorkspaceApiSchema_Get", + "description": "Get the schema configuration at the API level.", + "x-ms-examples": { + "ApiManagementGetWorkspaceApiSchema": { + "$ref": "./examples/ApiManagementGetWorkspaceApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Schema information.", + "schema": { + "$ref": "./definitions.json#/definitions/SchemaContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiSchema" + ], + "operationId": "WorkspaceApiSchema_CreateOrUpdate", + "description": "Creates or updates schema configuration for the API.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiSchema": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/SchemaContract" + }, + "description": "The schema contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api schema configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/SchemaContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "type": "string" + } + } + }, + "200": { + "description": "Api schema configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/SchemaContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + }, + "location": { + "description": "Location header contains the URL where the status of the long running operation can be checked", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", + "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" + } + }, + "delete": { + "tags": [ + "ApiSchema" + ], + "operationId": "WorkspaceApiSchema_Delete", + "description": "Deletes the schema configuration at the Api.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceApiSchema": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "If true removes all references to the schema before deleting it." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the schema configuration at the API level." + }, + "204": { + "description": "Successfully deleted the schema configuration at the API level." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products": { + "get": { + "tags": [ + "Product" + ], + "operationId": "WorkspaceProduct_ListByService", + "description": "Lists a collection of products in the specified workspace in a service instance.", + "x-ms-examples": { + "ApiManagementListWorkspaceProducts": { + "$ref": "./examples/ApiManagementListWorkspaceProducts.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "expandGroups", + "in": "query", + "required": false, + "type": "boolean", + "description": "When set to true, the response contains an array of groups that have visibility to the product. The default is false." + }, + { + "name": "tags", + "in": "query", + "required": false, + "type": "string", + "description": "Products which are part of a specific tag." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Product entities for the specified workspace in an API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ProductContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}": { + "head": { + "tags": [ + "Product" + ], + "operationId": "WorkspaceProduct_GetEntityTag", + "description": "Gets the entity state (Etag) version of the product specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceProduct": { + "$ref": "./examples/ApiManagementHeadWorkspaceProduct.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Product entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Product" + ], + "operationId": "WorkspaceProduct_Get", + "description": "Gets the details of the product specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceProduct": { + "$ref": "./examples/ApiManagementGetWorkspaceProduct.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Product entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Product" + ], + "operationId": "WorkspaceProduct_CreateOrUpdate", + "description": "Creates or Updates a product.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceProduct": { + "$ref": "./examples/ApiManagementCreateWorkspaceProduct.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Product was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Product was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Product" + ], + "operationId": "WorkspaceProduct_Update", + "description": "Update existing product details.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceProduct": { + "$ref": "./examples/ApiManagementUpdateWorkspaceProduct.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ProductUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Product was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Product" + ], + "operationId": "WorkspaceProduct_Delete", + "description": "Delete product.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceProduct": { + "$ref": "./examples/ApiManagementDeleteWorkspaceProduct.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "name": "deleteSubscriptions", + "in": "query", + "required": false, + "type": "boolean", + "description": "Delete existing subscriptions associated with the product or not." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Product was successfully removed." + }, + "204": { + "description": "Product was successfully removed by previous request or does not exist." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/apiLinks": { + "get": { + "tags": [ + "ProductApiLink" + ], + "operationId": "WorkspaceProductApiLink_ListByProduct", + "description": "Lists a collection of the API links associated with a product.", + "x-ms-examples": { + "ApiManagementListWorkspaceProductApiLinks": { + "$ref": "./examples/ApiManagementListWorkspaceProductApiLinks.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of API link entities in the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductApiLinkCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ProductApiLinkContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/apiLinks/{apiLinkId}": { + "get": { + "tags": [ + "ProductApiLink" + ], + "operationId": "WorkspaceProductApiLink_Get", + "description": "Gets the API link for the product.", + "x-ms-examples": { + "ApiManagementGetWorkspaceProductApiLink": { + "$ref": "./examples/ApiManagementGetWorkspaceProductApiLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductApiLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified API link entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductApiLinkContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductApiLink" + ], + "operationId": "WorkspaceProductApiLink_CreateOrUpdate", + "description": "Adds an API to the specified product via link.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceProductApiLink": { + "$ref": "./examples/ApiManagementCreateWorkspaceProductApiLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductApiLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ProductApiLinkContract" + }, + "description": "Create or update parameters." + } + ], + "responses": { + "201": { + "description": "The API was successfully added to the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductApiLinkContract" + } + }, + "200": { + "description": "The specified API is already added to the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductApiLinkContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductApiLink" + ], + "operationId": "WorkspaceProductApiLink_Delete", + "description": "Deletes the specified API from the specified product.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceProductApiLink": { + "$ref": "./examples/ApiManagementDeleteWorkspaceProductApiLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductApiLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API was successfully removed from product" + }, + "204": { + "description": "API successfully removed by previous request or does not exist in product" + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/groupLinks": { + "get": { + "tags": [ + "ProductGroupLink" + ], + "operationId": "WorkspaceProductGroupLink_ListByProduct", + "description": "Lists a collection of the group links associated with a product.", + "x-ms-examples": { + "ApiManagementListWorkspaceProductGroupLinks": { + "$ref": "./examples/ApiManagementListWorkspaceProductGroupLinks.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| groupId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of group link entities in the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductGroupLinkCollection" + } + }, + "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-odata": "./definitions.json#/definitions/ProductGroupLinkContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/groupLinks/{groupLinkId}": { + "get": { + "tags": [ + "ProductGroupLink" + ], + "operationId": "WorkspaceProductGroupLink_Get", + "description": "Gets the group link for the product.", + "x-ms-examples": { + "ApiManagementGetWorkspaceProductGroupLink": { + "$ref": "./examples/ApiManagementGetWorkspaceProductGroupLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductGroupLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified group link entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductGroupLink" + ], + "operationId": "WorkspaceProductGroupLink_CreateOrUpdate", + "description": "Adds a group to the specified product via link.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceProductGroupLink": { + "$ref": "./examples/ApiManagementCreateWorkspaceProductGroupLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductGroupLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" + }, + "description": "Create or update parameters." + } + ], + "responses": { + "201": { + "description": "The group was successfully added to the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" + } + }, + "200": { + "description": "The specified group is already added to the product.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductGroupLink" + ], + "operationId": "WorkspaceProductGroupLink_Delete", + "description": "Deletes the specified group from the specified product.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceProductGroupLink": { + "$ref": "./examples/ApiManagementDeleteWorkspaceProductGroupLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductGroupLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Group was successfully removed from product" + }, + "204": { + "description": "Group successfully removed by previous request or does not exist in product" + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/policies": { + "get": { + "tags": [ + "ProductPolicy" + ], + "operationId": "WorkspaceProductPolicy_ListByProduct", + "description": "Get the policy configuration at the Product level.", + "x-ms-examples": { + "ApiManagementListWorkspaceProductPolicies": { + "$ref": "./examples/ApiManagementListWorkspaceProductPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Product Policy information.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyCollection" + } + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/policies/{policyId}": { + "head": { + "tags": [ + "ProductPolicy" + ], + "operationId": "WorkspaceProductPolicy_GetEntityTag", + "description": "Get the ETag of the policy configuration at the Product level.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceProductPolicy": { + "$ref": "./examples/ApiManagementHeadWorkspaceProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Product Policy Etag information.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ProductPolicy" + ], + "operationId": "WorkspaceProductPolicy_Get", + "description": "Get the policy configuration at the Product level.", + "x-ms-examples": { + "ApiManagementGetWorkspaceProductPolicy": { + "$ref": "./examples/ApiManagementGetWorkspaceProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Product Policy information.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductPolicy" + ], + "operationId": "WorkspaceProductPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the Product.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceProductPolicy": { + "$ref": "./examples/ApiManagementCreateWorkspaceProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "description": "The policy contents to apply." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Product policy configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Product policy configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductPolicy" + ], + "operationId": "WorkspaceProductPolicy_Delete", + "description": "Deletes the policy configuration at the Product.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceProductPolicy": { + "$ref": "./examples/ApiManagementDeleteWorkspaceProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the policy configuration at the Product level." + }, + "204": { + "description": "Successfully deleted the policy configuration at the Product level." + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags": { + "get": { + "tags": [ + "Tag" + ], + "operationId": "WorkspaceTag_ListByService", + "description": "Lists a collection of tags defined within a workspace in a service instance.", + "x-ms-examples": { + "ApiManagementListWorkspaceTags": { + "$ref": "./examples/ApiManagementListWorkspaceTags.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "scope", + "in": "query", + "required": false, + "type": "string", + "description": "Scope like 'apis', 'products' or 'apis/{apiId}" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Tag entities.", + "schema": { + "$ref": "./definitions.json#/definitions/TagCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}": { + "head": { + "tags": [ + "Tag" + ], + "operationId": "WorkspaceTag_GetEntityState", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadWorkspaceTag": { + "$ref": "./examples/ApiManagementHeadWorkspaceTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Tag" + ], + "operationId": "WorkspaceTag_Get", + "description": "Gets the details of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetWorkspaceTag": { + "$ref": "./examples/ApiManagementGetWorkspaceTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Tag entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Tag" + ], + "operationId": "WorkspaceTag_CreateOrUpdate", + "description": "Creates a tag.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceTag": { + "$ref": "./examples/ApiManagementCreateWorkspaceTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/TagCreateUpdateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was created successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, + "200": { + "description": "Tag already exists.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Tag" + ], + "operationId": "WorkspaceTag_Update", + "description": "Updates the details of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateWorkspaceTag": { + "$ref": "./examples/ApiManagementUpdateWorkspaceTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/TagCreateUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The tag details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Tag" + ], + "operationId": "WorkspaceTag_Delete", + "description": "Deletes specific tag of the workspace in an API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceTag": { + "$ref": "./examples/ApiManagementDeleteWorkspaceTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Tag successfully removed" + }, + "204": { + "description": "Tag successfully removed by previous request or does not exist" + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/apiLinks": { + "get": { + "tags": [ + "TagApiLink" + ], + "operationId": "WorkspaceTagApiLink_ListByProduct", + "description": "Lists a collection of the API links associated with a tag.", + "x-ms-examples": { + "ApiManagementListWorkspaceTagApiLinks": { + "$ref": "./examples/ApiManagementListWorkspaceTagApiLinks.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of API link entities associated with a tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagApiLinkCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagApiLinkContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/apiLinks/{apiLinkId}": { + "get": { + "tags": [ + "TagApiLink" + ], + "operationId": "WorkspaceTagApiLink_Get", + "description": "Gets the API link for the tag.", + "x-ms-examples": { + "ApiManagementGetWorkspaceTagApiLink": { + "$ref": "./examples/ApiManagementGetWorkspaceTagApiLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagApiLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified API link entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagApiLinkContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "TagApiLink" + ], + "operationId": "WorkspaceTagApiLink_CreateOrUpdate", + "description": "Adds an API to the specified tag via link.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceTagApiLink": { + "$ref": "./examples/ApiManagementCreateWorkspaceTagApiLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagApiLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/TagApiLinkContract" + }, + "description": "Create or update parameters." + } + ], + "responses": { + "201": { + "description": "The API was successfully added to the tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagApiLinkContract" + } + }, + "200": { + "description": "The specified API is already added to the tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagApiLinkContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "TagApiLink" + ], + "operationId": "WorkspaceTagApiLink_Delete", + "description": "Deletes the specified API from the specified tag.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceTagApiLink": { + "$ref": "./examples/ApiManagementDeleteWorkspaceTagApiLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagApiLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API was successfully removed from tag" + }, + "204": { + "description": "API successfully removed by previous request or does not exist in tag" + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/operationLinks": { + "get": { + "tags": [ + "TagOperationLink" + ], + "operationId": "WorkspaceTagOperationLink_ListByProduct", + "description": "Lists a collection of the operation links associated with a tag.", + "x-ms-examples": { + "ApiManagementListWorkspaceTagOperationLinks": { + "$ref": "./examples/ApiManagementListWorkspaceTagOperationLinks.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| operationId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of operation link entities associated with a tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagOperationLinkCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagOperationLinkContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/operationLinks/{operationLinkId}": { + "get": { + "tags": [ + "TagOperationLink" + ], + "operationId": "WorkspaceTagOperationLink_Get", + "description": "Gets the operation link for the tag.", + "x-ms-examples": { + "ApiManagementGetWorkspaceTagOperationLink": { + "$ref": "./examples/ApiManagementGetWorkspaceTagOperationLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagOperationLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified operation link entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagOperationLinkContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "TagOperationLink" + ], + "operationId": "WorkspaceTagOperationLink_CreateOrUpdate", + "description": "Adds an operation to the specified tag via link.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceTagOperationLink": { + "$ref": "./examples/ApiManagementCreateWorkspaceTagOperationLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagOperationLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/TagOperationLinkContract" + }, + "description": "Create or update parameters." + } + ], + "responses": { + "201": { + "description": "The operation was successfully added to the tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagOperationLinkContract" + } + }, + "200": { + "description": "The specified operation is already added to the tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagOperationLinkContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "TagOperationLink" + ], + "operationId": "WorkspaceTagOperationLink_Delete", + "description": "Deletes the specified operation from the specified tag.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceTagOperationLink": { + "$ref": "./examples/ApiManagementDeleteWorkspaceTagOperationLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagOperationLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation was successfully removed from tag" + }, + "204": { + "description": "Operation successfully removed by previous request or does not exist in tag" + }, + "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/productLinks": { + "get": { + "tags": [ + "TagProductLink" + ], + "operationId": "WorkspaceTagProductLink_ListByProduct", + "description": "Lists a collection of the product links associated with a tag.", + "x-ms-examples": { + "ApiManagementListWorkspaceTagProductLinks": { + "$ref": "./examples/ApiManagementListWorkspaceTagProductLinks.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of product link entities associated with a tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagProductLinkCollection" + } + }, + "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-odata": "./definitions.json#/definitions/TagProductLinkContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/productLinks/{productLinkId}": { + "get": { + "tags": [ + "TagProductLink" + ], + "operationId": "WorkspaceTagProductLink_Get", + "description": "Gets the product link for the tag.", + "x-ms-examples": { + "ApiManagementGetWorkspaceTagProductLink": { + "$ref": "./examples/ApiManagementGetWorkspaceTagProductLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagProductLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified product link entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagProductLinkContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "TagProductLink" + ], + "operationId": "WorkspaceTagProductLink_CreateOrUpdate", + "description": "Adds a product to the specified tag via link.", + "x-ms-examples": { + "ApiManagementCreateWorkspaceTagProductLink": { + "$ref": "./examples/ApiManagementCreateWorkspaceTagProductLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagProductLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/TagProductLinkContract" + }, + "description": "Create or update parameters." + } + ], + "responses": { + "201": { + "description": "The product was successfully added to the tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagProductLinkContract" + } + }, + "200": { + "description": "The specified product is already added to the tag.", + "schema": { + "$ref": "./definitions.json#/definitions/TagProductLinkContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "TagProductLink" + ], + "operationId": "WorkspaceTagProductLink_Delete", + "description": "Deletes the specified product from the specified tag.", + "x-ms-examples": { + "ApiManagementDeleteWorkspaceTagProductLink": { + "$ref": "./examples/ApiManagementDeleteWorkspaceTagProductLink.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagProductLinkIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Product was successfully removed from tag" + }, + "204": { + "description": "Product successfully removed by previous request or does not exist in tag" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "x-ms-paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}?export=true": { + "get": { + "tags": [ + "Apis" + ], + "operationId": "WorkspaceApiExport_Get", + "description": "Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.", + "x-ms-examples": { + "ApiManagementGetWorkspaceApiExportInOpenApi2dot0": { + "$ref": "./examples/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json" + }, + "ApiManagementGetWorkspaceApiExportInOpenApi3dot0": { + "$ref": "./examples/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "format", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "swagger-link", + "wadl-link", + "wsdl-link", + "openapi-link", + "openapi+json-link" + ], + "x-ms-enum": { + "name": "ExportFormat", + "modelAsString": true, + "values": [ + { + "value": "swagger-link", + "description": "Export the Api Definition in OpenAPI 2.0 Specification as JSON document to the Storage Blob.", + "name": "Swagger" + }, + { + "value": "wsdl-link", + "description": "Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`", + "name": "Wsdl" + }, + { + "value": "wadl-link", + "description": "Export the Api Definition in WADL Schema to Storage Blob.", + "name": "Wadl" + }, + { + "value": "openapi-link", + "description": "Export the Api Definition in OpenAPI 3.0 Specification as YAML document to Storage Blob.", + "name": "Openapi" + }, + { + "value": "openapi+json-link", + "description": "Export the Api Definition in OpenAPI 3.0 Specification as JSON document to Storage Blob.", + "name": "OpenapiJson" + } + ] + }, + "description": "Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes." + }, + { + "name": "export", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "true" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ExportApi" + }, + "description": "Query parameter required to export the API details." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response contains a stream with a full set of API metadata and includes API entity with an embedded array of operation entities.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiExportResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/definitions.json new file mode 100644 index 000000000000..e30a7ca9b230 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/definitions.json @@ -0,0 +1,9459 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-09-01-preview", + "description": "A spec file containing all the definitions", + "title": "Definitions file" + }, + "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": {}, + "definitions": { + "AccessInformationCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessInformationContract" + }, + "description": "Page values.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged AccessInformation list representation." + }, + "AccessInformationContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessInformationContractProperties", + "description": "AccessInformation entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Tenant Settings." + }, + "AccessInformationContractProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Access Information type ('access' or 'gitAccess')" + }, + "principalId": { + "type": "string", + "description": "Principal (User) Identifier." + }, + "enabled": { + "type": "boolean", + "description": "Determines whether direct access is enabled." + } + }, + "description": "Tenant access information contract of the API Management service." + }, + "AccessInformationSecretsContract": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Access Information type ('access' or 'gitAccess')" + }, + "principalId": { + "type": "string", + "description": "Principal (User) Identifier." + }, + "primaryKey": { + "type": "string", + "x-ms-secret": true, + "description": "Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." + }, + "secondaryKey": { + "type": "string", + "x-ms-secret": true, + "description": "Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." + }, + "enabled": { + "type": "boolean", + "description": "Determines whether direct access is enabled." + } + }, + "description": "Tenant access information contract of the API Management service." + }, + "AccessInformationCreateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessInformationCreateParameterProperties", + "description": "Tenant access information update parameter properties." + } + }, + "description": "Tenant access information update parameters." + }, + "AccessInformationCreateParameterProperties": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "Principal (User) Identifier." + }, + "primaryKey": { + "type": "string", + "x-ms-secret": true, + "description": "Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." + }, + "secondaryKey": { + "type": "string", + "x-ms-secret": true, + "description": "Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." + }, + "enabled": { + "type": "boolean", + "description": "Determines whether direct access is enabled." + } + }, + "description": "Tenant access information update parameters of the API Management service" + }, + "AccessInformationUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessInformationUpdateParameterProperties", + "description": "Tenant access information update parameter properties." + } + }, + "description": "Tenant access information update parameters." + }, + "AccessInformationUpdateParameterProperties": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether direct access is enabled." + } + }, + "description": "Tenant access information update parameters of the API Management service" + }, + "TenantSettingsCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TenantSettingsContract" + }, + "description": "Page values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged AccessInformation list representation." + }, + "TenantSettingsContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TenantSettingsContractProperties", + "description": "TenantSettings entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Tenant Settings." + }, + "TenantSettingsContractProperties": { + "type": "object", + "properties": { + "settings": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tenant settings" + } + }, + "description": "Tenant access information contract of the API Management service." + }, + "ApiCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiContract" + }, + "description": "Page values.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged API list representation." + }, + "DocumentationCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DocumentationContract" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Page values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Documentation list representation." + }, + "WikiCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WikiContract" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Page values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Wiki list representation." + }, + "ApiContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiContractProperties", + "description": "API entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "API details." + }, + "ApiContractProperties": { + "type": "object", + "properties": { + "sourceApiId": { + "type": "string", + "description": "API identifier of the source API." + }, + "displayName": { + "type": "string", + "description": "API name. Must be 1 to 300 characters long.", + "minLength": 1, + "maxLength": 300 + }, + "serviceUrl": { + "type": "string", + "description": "Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.", + "minLength": 0, + "maxLength": 2000 + }, + "path": { + "type": "string", + "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.", + "minLength": 0, + "maxLength": 400 + }, + "protocols": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "http", + "https", + "ws", + "wss" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true + } + }, + "description": "Describes on which protocols the operations in this API can be invoked." + }, + "apiVersionSet": { + "description": "Version set details", + "$ref": "#/definitions/ApiVersionSetContractDetails" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiEntityBaseContract" + } + ], + "required": [ + "path" + ], + "description": "API Entity Properties" + }, + "ApiCreateOrUpdateParameter": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiCreateOrUpdateProperties", + "description": "API entity create of update properties." + } + }, + "description": "API Create or Update Parameters." + }, + "ApiCreateOrUpdateProperties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Content value when Importing an API." + }, + "format": { + "type": "string", + "description": "Format of the Content in which the API is getting imported. New formats can be added in the future", + "enum": [ + "wadl-xml", + "wadl-link-json", + "swagger-json", + "swagger-link-json", + "wsdl", + "wsdl-link", + "openapi", + "openapi+json", + "openapi-link", + "openapi+json-link", + "graphql-link", + "odata", + "odata-link", + "grpc", + "grpc-link" + ], + "x-ms-enum": { + "name": "ContentFormat", + "modelAsString": true, + "values": [ + { + "value": "wadl-xml", + "description": "The contents are inline and Content type is a WADL document." + }, + { + "value": "wadl-link-json", + "description": "The WADL document is hosted on a publicly accessible internet address." + }, + { + "value": "swagger-json", + "description": "The contents are inline and Content Type is a OpenAPI 2.0 JSON Document." + }, + { + "value": "swagger-link-json", + "description": "The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address." + }, + { + "value": "wsdl", + "description": "The contents are inline and the document is a WSDL/Soap document." + }, + { + "value": "wsdl-link", + "description": "The WSDL document is hosted on a publicly accessible internet address." + }, + { + "value": "openapi", + "description": "The contents are inline and Content Type is a OpenAPI 3.0 YAML Document." + }, + { + "value": "openapi+json", + "description": "The contents are inline and Content Type is a OpenAPI 3.0 JSON Document." + }, + { + "value": "openapi-link", + "description": "The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address." + }, + { + "value": "openapi+json-link", + "description": "The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address." + }, + { + "value": "graphql-link", + "description": "The GraphQL API endpoint hosted on a publicly accessible internet address." + }, + { + "value": "odata", + "description": "The contents are inline and Content Type is a OData XML Document." + }, + { + "value": "odata-link", + "description": "The OData metadata document hosted on a publicly accessible internet address." + }, + { + "value": "grpc", + "description": "The contents are inline and Content Type is a gRPC protobuf file." + }, + { + "value": "grpc-link", + "description": "The gRPC protobuf file is hosted on a publicly accessible internet address." + } + ] + } + }, + "wsdlSelector": { + "type": "object", + "description": "Criteria to limit import of WSDL to a subset of the document.", + "properties": { + "wsdlServiceName": { + "type": "string", + "description": "Name of service to import from WSDL" + }, + "wsdlEndpointName": { + "type": "string", + "description": "Name of endpoint(port) to import from WSDL" + } + } + }, + "apiType": { + "type": "string", + "description": "Type of API to create. \n * `http` creates a REST API \n * `soap` creates a SOAP pass-through API \n * `websocket` creates websocket API \n * `graphql` creates GraphQL API. \n New types can be added in the future.", + "enum": [ + "http", + "soap", + "websocket", + "graphql", + "odata", + "grpc" + ], + "x-ms-client-name": "SoapApiType", + "x-ms-enum": { + "name": "SoapApiType", + "modelAsString": true, + "values": [ + { + "value": "http", + "description": "Imports a SOAP API having a RESTful front end.", + "name": "SoapToRest" + }, + { + "value": "soap", + "description": "Imports the SOAP API having a SOAP front end.", + "name": "SoapPassThrough" + }, + { + "value": "websocket", + "description": "Imports the API having a Websocket front end.", + "name": "WebSocket" + }, + { + "value": "graphql", + "description": "Imports the API having a GraphQL front end.", + "name": "GraphQL" + }, + { + "value": "odata", + "description": "Imports the API having a OData front end.", + "name": "OData" + }, + { + "value": "grpc", + "description": "Imports the API having a gRPC front end.", + "name": "gRPC" + } + ] + } + }, + "translateRequiredQueryParameters": { + "type": "string", + "description": "Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'", + "enum": [ + "template", + "query" + ], + "x-ms-client-name": "TranslateRequiredQueryParametersConduct", + "x-ms-enum": { + "name": "TranslateRequiredQueryParametersConduct", + "modelAsString": true, + "values": [ + { + "value": "template", + "description": "Translates required query parameters to template ones. Is a default value", + "name": "Template" + }, + { + "value": "query", + "description": "Leaves required query parameters as they are (no translation done).", + "name": "Query" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiContractProperties" + } + ], + "description": "API Create or Update Properties." + }, + "ApiEntityBaseContract": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the API. May include HTML formatting tags." + }, + "authenticationSettings": { + "$ref": "#/definitions/AuthenticationSettingsContract", + "description": "Collection of authentication settings included into this API." + }, + "subscriptionKeyParameterNames": { + "$ref": "#/definitions/SubscriptionKeyParameterNamesContract", + "description": "Protocols over which API is made available." + }, + "type": { + "type": "string", + "description": "Type of API.", + "enum": [ + "http", + "soap", + "websocket", + "graphql", + "odata", + "grpc" + ], + "x-ms-client-name": "ApiType", + "x-ms-enum": { + "name": "ApiType", + "modelAsString": true + } + }, + "apiRevision": { + "type": "string", + "description": "Describes the revision of the API. If no value is provided, default revision 1 is created", + "minLength": 1, + "maxLength": 100 + }, + "apiVersion": { + "type": "string", + "description": "Indicates the version identifier of the API if the API is versioned", + "maxLength": 100 + }, + "isCurrent": { + "type": "boolean", + "description": "Indicates if API revision is current api revision." + }, + "isOnline": { + "type": "boolean", + "description": "Indicates if API revision is accessible via the gateway.", + "readOnly": true + }, + "apiRevisionDescription": { + "type": "string", + "description": "Description of the API Revision.", + "maxLength": 256 + }, + "apiVersionDescription": { + "type": "string", + "description": "Description of the API Version.", + "maxLength": 256 + }, + "apiVersionSetId": { + "type": "string", + "description": "A resource identifier for the related ApiVersionSet." + }, + "subscriptionRequired": { + "type": "boolean", + "description": "Specifies whether an API or Product subscription is required for accessing the API." + }, + "termsOfServiceUrl": { + "type": "string", + "description": " A URL to the Terms of Service for the API. MUST be in the format of a URL." + }, + "contact": { + "$ref": "#/definitions/ApiContactInformation", + "description": "Contact information for the API." + }, + "license": { + "$ref": "#/definitions/ApiLicenseInformation", + "description": "License information for the API." + } + }, + "description": "API base contract details." + }, + "ApiContactInformation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The identifying name of the contact person/organization" + }, + "url": { + "type": "string", + "description": "The URL pointing to the contact information. MUST be in the format of a URL" + }, + "email": { + "type": "string", + "description": "The email address of the contact person/organization. MUST be in the format of an email address" + } + }, + "description": "API contact information" + }, + "ApiLicenseInformation": { + "type": "object", + "description": "API license information", + "properties": { + "name": { + "type": "string", + "description": "The license name used for the API" + }, + "url": { + "type": "string", + "description": "A URL to the license used for the API. MUST be in the format of a URL" + } + } + }, + "ApiExportResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ResourceId of the API which was exported." + }, + "format": { + "type": "string", + "enum": [ + "swagger-link-json", + "wadl-link-json", + "wsdl-link+xml", + "openapi-link" + ], + "x-ms-client-name": "ExportResultFormat", + "x-ms-enum": { + "name": "ExportResultFormat", + "modelAsString": true, + "values": [ + { + "value": "swagger-link-json", + "description": "The API Definition is exported in OpenAPI Specification 2.0 format to the Storage Blob.", + "name": "Swagger" + }, + { + "value": "wsdl-link+xml", + "description": "The API Definition is exported in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`", + "name": "Wsdl" + }, + { + "value": "wadl-link-json", + "description": "Export the API Definition in WADL Schema to Storage Blob.", + "name": "Wadl" + }, + { + "value": "openapi-link", + "description": "Export the API Definition in OpenAPI Specification 3.0 to Storage Blob.", + "name": "OpenApi" + } + ] + }, + "description": "Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes." + }, + "value": { + "type": "object", + "description": "The object defining the schema of the exported API Detail", + "properties": { + "link": { + "type": "string", + "description": "Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes." + } + } + } + }, + "description": "API Export result." + }, + "ApiReleaseCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "description": "Page values.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged ApiRelease list representation." + }, + "ApiReleaseContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiReleaseContractProperties", + "description": "ApiRelease entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "ApiRelease details." + }, + "ApiReleaseContractProperties": { + "type": "object", + "properties": { + "apiId": { + "type": "string", + "description": "Identifier of the API the release belongs to." + }, + "createdDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." + }, + "updatedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time the API release was updated." + }, + "notes": { + "type": "string", + "description": "Release Notes" + } + }, + "description": "API Release details" + }, + "ApiRevisionCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiRevisionContract" + }, + "x-ms-identifiers": [ + "apiId" + ], + "description": "Page values.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged API Revision list representation." + }, + "ApiRevisionContract": { + "type": "object", + "properties": { + "apiId": { + "type": "string", + "readOnly": true, + "description": "Identifier of the API Revision." + }, + "apiRevision": { + "type": "string", + "minLength": 1, + "maxLength": 100, + "readOnly": true, + "description": "Revision number of API." + }, + "createdDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." + }, + "updatedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." + }, + "description": { + "type": "string", + "readOnly": true, + "maxLength": 256, + "description": "Description of the API Revision." + }, + "privateUrl": { + "type": "string", + "readOnly": true, + "description": "Gateway URL for accessing the non-current API Revision." + }, + "isOnline": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if API revision is the current api revision." + }, + "isCurrent": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if API revision is accessible via the gateway." + } + }, + "description": "Summary of revision metadata." + }, + "ApiRevisionInfoContract": { + "type": "object", + "description": "Object used to create an API Revision or Version based on an existing API Revision", + "properties": { + "sourceApiId": { + "type": "string", + "description": "Resource identifier of API to be used to create the revision from." + }, + "apiVersionName": { + "type": "string", + "maxLength": 100, + "description": "Version identifier for the new API Version." + }, + "apiRevisionDescription": { + "type": "string", + "maxLength": 256, + "description": "Description of new API Revision." + }, + "apiVersionSet": { + "description": "Version set details", + "$ref": "#/definitions/ApiVersionSetContractDetails" + } + } + }, + "ApiTagResourceContractProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "API identifier in the form /apis/{apiId}." + }, + "name": { + "type": "string", + "description": "API name.", + "minLength": 1, + "maxLength": 300 + }, + "serviceUrl": { + "type": "string", + "description": "Absolute URL of the backend service implementing this API.", + "minLength": 1, + "maxLength": 2000 + }, + "path": { + "type": "string", + "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.", + "minLength": 0, + "maxLength": 400 + }, + "protocols": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "http", + "https", + "ws", + "wss" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true + } + }, + "description": "Describes on which protocols the operations in this API can be invoked." + } + }, + "allOf": [ + { + "$ref": "./definitions.json#/definitions/ApiEntityBaseContract" + } + ], + "description": "API contract properties for the Tag Resources." + }, + "ApiUpdateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiContractUpdateProperties", + "description": "Properties of the API entity that can be updated." + } + }, + "description": "API update contract details." + }, + "ApiContractUpdateProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "API name.", + "minLength": 1, + "maxLength": 300 + }, + "serviceUrl": { + "type": "string", + "description": "Absolute URL of the backend service implementing this API.", + "minLength": 1, + "maxLength": 2000 + }, + "path": { + "type": "string", + "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.", + "minLength": 0, + "maxLength": 400 + }, + "protocols": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "http", + "https", + "ws", + "wss" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true + } + }, + "description": "Describes on which protocols the operations in this API can be invoked." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiEntityBaseContract" + } + ], + "description": "API update contract properties." + }, + "ApiVersionSetCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiVersionSetContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged API Version Set list representation." + }, + "ApiVersionSetContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiVersionSetContractProperties", + "description": "API VersionSet contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "API Version Set Contract details." + }, + "ApiVersionSetContractDetails": { + "type": "object", + "description": "An API Version Set contains the common configuration for a set of API Versions relating ", + "properties": { + "id": { + "type": "string", + "description": "Identifier for existing API Version Set. Omit this value to create a new Version Set." + }, + "name": { + "type": "string", + "description": "The display Name of the API Version Set." + }, + "description": { + "type": "string", + "description": "Description of API Version Set." + }, + "versioningScheme": { + "type": "string", + "description": "An value that determines where the API Version identifier will be located in a HTTP request.", + "enum": [ + "Segment", + "Query", + "Header" + ], + "x-ms-enum": { + "name": "versioningScheme", + "modelAsString": true, + "values": [ + { + "value": "Segment", + "description": "The API Version is passed in a path segment." + }, + { + "value": "Query", + "description": "The API Version is passed in a query parameter." + }, + { + "value": "Header", + "description": "The API Version is passed in a HTTP header." + } + ] + } + }, + "versionQueryName": { + "type": "string", + "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`." + }, + "versionHeaderName": { + "type": "string", + "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`." + } + } + }, + "ApiVersionSetContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Name of API Version Set", + "minLength": 1, + "maxLength": 100 + }, + "versioningScheme": { + "type": "string", + "description": "An value that determines where the API Version identifier will be located in a HTTP request.", + "enum": [ + "Segment", + "Query", + "Header" + ], + "x-ms-enum": { + "name": "versioningScheme", + "modelAsString": true, + "values": [ + { + "value": "Segment", + "description": "The API Version is passed in a path segment." + }, + { + "value": "Query", + "description": "The API Version is passed in a query parameter." + }, + { + "value": "Header", + "description": "The API Version is passed in a HTTP header." + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiVersionSetEntityBase" + } + ], + "required": [ + "displayName", + "versioningScheme" + ], + "description": "Properties of an API Version Set." + }, + "ApiVersionSetEntityBase": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of API Version Set." + }, + "versionQueryName": { + "type": "string", + "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`.", + "minLength": 1, + "maxLength": 100 + }, + "versionHeaderName": { + "type": "string", + "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.", + "minLength": 1, + "maxLength": 100 + } + }, + "description": "API Version set base parameters" + }, + "ApiVersionSetUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiVersionSetUpdateParametersProperties", + "description": "Parameters to update or create an API Version Set Contract." + } + }, + "description": "Parameters to update or create an API Version Set Contract." + }, + "ApiVersionSetUpdateParametersProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Name of API Version Set", + "minLength": 1, + "maxLength": 100 + }, + "versioningScheme": { + "type": "string", + "description": "An value that determines where the API Version identifier will be located in a HTTP request.", + "enum": [ + "Segment", + "Query", + "Header" + ], + "x-ms-enum": { + "name": "versioningScheme", + "modelAsString": true, + "values": [ + { + "value": "Segment", + "description": "The API Version is passed in a path segment." + }, + { + "value": "Query", + "description": "The API Version is passed in a query parameter." + }, + { + "value": "Header", + "description": "The API Version is passed in a HTTP header." + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiVersionSetEntityBase" + } + ], + "description": "Properties used to create or update an API Version Set." + }, + "AuthenticationSettingsContract": { + "type": "object", + "properties": { + "oAuth2": { + "$ref": "#/definitions/OAuth2AuthenticationSettingsContract", + "description": "OAuth2 Authentication settings" + }, + "openid": { + "$ref": "#/definitions/OpenIdAuthenticationSettingsContract", + "description": "OpenID Connect Authentication Settings" + }, + "oAuth2AuthenticationSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/OAuth2AuthenticationSettingsContract" + }, + "x-ms-identifiers": [ + "authorizationServerId" + ], + "description": "Collection of OAuth2 authentication settings included into this API." + }, + "openidAuthenticationSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/OpenIdAuthenticationSettingsContract" + }, + "x-ms-identifiers": [ + "openidProviderId" + ], + "description": "Collection of Open ID Connect authentication settings included into this API." + } + }, + "description": "API Authentication Settings." + }, + "AuthorizationCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AuthorizationContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Authorization list representation." + }, + "AuthorizationContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AuthorizationContractProperties", + "description": "Properties of the Authorization Contract." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Authorization contract." + }, + "AuthorizationContractProperties": { + "type": "object", + "properties": { + "authorizationType": { + "type": "string", + "description": "Authorization type options", + "enum": [ + "OAuth2" + ], + "x-ms-client-name": "AuthorizationType", + "x-ms-enum": { + "name": "AuthorizationType", + "modelAsString": true, + "values": [ + { + "value": "OAuth2", + "description": "OAuth2 authorization type", + "name": "OAuth2" + } + ] + } + }, + "oauth2grantType": { + "type": "string", + "description": "OAuth2 grant type options", + "enum": [ + "AuthorizationCode", + "ClientCredentials" + ], + "x-ms-client-name": "OAuth2GrantType", + "x-ms-enum": { + "name": "OAuth2GrantType", + "modelAsString": true, + "values": [ + { + "value": "AuthorizationCode", + "description": "Authorization Code grant", + "name": "AuthorizationCode" + }, + { + "value": "ClientCredentials", + "description": "Client Credential grant", + "name": "ClientCredentials" + } + ] + } + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Authorization parameters" + }, + "error": { + "description": "", + "$ref": "#/definitions/AuthorizationError" + }, + "status": { + "type": "string", + "description": "Status of the Authorization" + } + }, + "description": "Authorization details." + }, + "AuthorizationError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + } + }, + "description": "Authorization error details." + }, + "AuthorizationAccessPolicyCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AuthorizationAccessPolicyContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Authorization Access Policy list representation." + }, + "AuthorizationAccessPolicyContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AuthorizationAccessPolicyContractProperties", + "description": "Properties of the Authorization Contract." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Authorization access policy contract." + }, + "AuthorizationAccessPolicyContractProperties": { + "type": "object", + "properties": { + "appIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The allowed Azure Active Directory Application IDs" + }, + "tenantId": { + "type": "string", + "description": "The Tenant Id" + }, + "objectId": { + "type": "string", + "description": "The Object Id" + } + }, + "description": "Authorization Access Policy details." + }, + "AuthorizationLoginRequestContract": { + "type": "object", + "properties": { + "postLoginRedirectUrl": { + "type": "string", + "description": "The redirect URL after login has completed." + } + }, + "description": "Authorization login request contract." + }, + "AuthorizationLoginResponseContract": { + "type": "object", + "properties": { + "loginLink": { + "type": "string", + "description": "The login link" + } + }, + "description": "Authorization login response contract." + }, + "AuthorizationConfirmConsentCodeRequestContract": { + "type": "object", + "properties": { + "consentCode": { + "type": "string", + "description": "The consent code from the authorization server after authorizing and consenting." + } + }, + "description": "Authorization confirm consent code request contract." + }, + "AuthorizationProviderCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AuthorizationProviderContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Authorization Provider list representation." + }, + "AuthorizationProviderContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AuthorizationProviderContractProperties", + "description": "Properties of the Authorization Provider Contract." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Authorization Provider contract." + }, + "AuthorizationProviderContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Authorization Provider name. Must be 1 to 300 characters long.", + "minLength": 1, + "maxLength": 300 + }, + "identityProvider": { + "type": "string", + "description": "Identity provider name. Must be 1 to 300 characters long." + }, + "oauth2": { + "description": "OAuth2 settings", + "$ref": "#/definitions/AuthorizationProviderOAuth2Settings" + } + }, + "description": "Authorization Provider details." + }, + "AuthorizationProviderOAuth2Settings": { + "type": "object", + "properties": { + "redirectUrl": { + "type": "string", + "description": "Redirect URL to be set in the OAuth application." + }, + "grantTypes": { + "description": "OAuth2 settings", + "$ref": "#/definitions/AuthorizationProviderOAuth2GrantTypes" + } + }, + "description": "OAuth2 settings details" + }, + "AuthorizationProviderOAuth2GrantTypes": { + "type": "object", + "properties": { + "authorizationCode": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "OAuth2 authorization code grant parameters" + }, + "clientCredentials": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "OAuth2 client credential grant parameters" + } + }, + "description": "Authorization Provider oauth2 grant types settings" + }, + "AuthorizationServerCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AuthorizationServerContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged OAuth2 Authorization Servers list representation." + }, + "AuthorizationServerContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AuthorizationServerContractProperties", + "description": "Properties of the External OAuth authorization server Contract." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "External OAuth authorization server settings." + }, + "AuthorizationServerContractBaseProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the authorization server. Can contain HTML formatting tags." + }, + "authorizationMethods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "HEAD", + "OPTIONS", + "TRACE", + "GET", + "POST", + "PUT", + "PATCH", + "DELETE" + ], + "x-ms-enum": { + "name": "AuthorizationMethod", + "modelAsString": false + } + }, + "description": "HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional." + }, + "clientAuthenticationMethod": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Basic", + "Body" + ], + "x-ms-enum": { + "name": "ClientAuthenticationMethod", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic Client Authentication method." + }, + { + "value": "Body", + "description": "Body based Authentication method." + } + ] + } + }, + "description": "Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format." + }, + "tokenBodyParameters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenBodyParameterContract" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {\"name\" : \"name value\", \"value\": \"a value\"}." + }, + "tokenEndpoint": { + "type": "string", + "description": "OAuth token endpoint. Contains absolute URI to entity being referenced.", + "externalDocs": { + "url": "http://tools.ietf.org/html/rfc6749#section-3.1" + } + }, + "supportState": { + "type": "boolean", + "description": "If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.", + "externalDocs": { + "url": "http://tools.ietf.org/html/rfc6749#section-3.1" + } + }, + "defaultScope": { + "type": "string", + "description": "Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.", + "externalDocs": { + "url": "http://tools.ietf.org/html/rfc6749#section-3.3" + } + }, + "bearerTokenSendingMethods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "authorizationHeader", + "query" + ], + "x-ms-enum": { + "name": "BearerTokenSendingMethod", + "modelAsString": true + } + }, + "description": "Specifies the mechanism by which access token is passed to the API. ", + "externalDocs": { + "url": "http://tools.ietf.org/html/rfc6749#section-4" + } + }, + "resourceOwnerUsername": { + "type": "string", + "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." + }, + "resourceOwnerPassword": { + "type": "string", + "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." + } + }, + "description": "External OAuth authorization server Update settings contract." + }, + "AuthorizationServerContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly authorization server name.", + "minLength": 1, + "maxLength": 50 + }, + "useInTestConsole": { + "type": "boolean", + "description": "If true, the authorization server may be used in the developer portal test console. True by default if no value is provided." + }, + "useInApiDocumentation": { + "type": "boolean", + "description": "If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided." + }, + "clientRegistrationEndpoint": { + "type": "string", + "description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced." + }, + "authorizationEndpoint": { + "type": "string", + "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." + }, + "grantTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "authorizationCode", + "implicit", + "resourceOwnerPassword", + "clientCredentials" + ], + "x-ms-enum": { + "name": "GrantType", + "modelAsString": true, + "values": [ + { + "value": "authorizationCode", + "description": "Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1." + }, + { + "value": "implicit", + "description": "Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2." + }, + { + "value": "resourceOwnerPassword", + "description": "Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3." + }, + { + "value": "clientCredentials", + "description": "Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4." + } + ] + } + }, + "description": "Form of an authorization grant, which the client uses to request the access token.", + "externalDocs": { + "url": "http://tools.ietf.org/html/rfc6749#section-4" + } + }, + "clientId": { + "type": "string", + "description": "Client or app id registered with this authorization server." + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string", + "description": "Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AuthorizationServerContractBaseProperties" + } + ], + "required": [ + "displayName", + "clientRegistrationEndpoint", + "authorizationEndpoint", + "clientId", + "grantTypes" + ], + "description": "External OAuth authorization server settings Properties." + }, + "AuthorizationServerUpdateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AuthorizationServerUpdateContractProperties", + "description": "Properties of the External OAuth authorization server update Contract." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "External OAuth authorization server settings." + }, + "AuthorizationServerUpdateContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly authorization server name.", + "minLength": 1, + "maxLength": 50 + }, + "useInTestConsole": { + "type": "boolean", + "description": "If true, the authorization server may be used in the developer portal test console. True by default if no value is provided." + }, + "useInApiDocumentation": { + "type": "boolean", + "description": "If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided." + }, + "clientRegistrationEndpoint": { + "type": "string", + "description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced." + }, + "authorizationEndpoint": { + "type": "string", + "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." + }, + "grantTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "authorizationCode", + "implicit", + "resourceOwnerPassword", + "clientCredentials" + ], + "x-ms-enum": { + "name": "GrantType", + "modelAsString": true, + "values": [ + { + "value": "authorizationCode", + "description": "Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1." + }, + { + "value": "implicit", + "description": "Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2." + }, + { + "value": "resourceOwnerPassword", + "description": "Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3." + }, + { + "value": "clientCredentials", + "description": "Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4." + } + ] + } + }, + "description": "Form of an authorization grant, which the client uses to request the access token.", + "externalDocs": { + "url": "http://tools.ietf.org/html/rfc6749#section-4" + } + }, + "clientId": { + "type": "string", + "description": "Client or app id registered with this authorization server." + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string", + "description": "Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AuthorizationServerContractBaseProperties" + } + ], + "description": "External OAuth authorization server Update settings contract." + }, + "AuthorizationServerSecretsContract": { + "type": "object", + "properties": { + "clientSecret": { + "type": "string", + "x-ms-secret": true, + "description": "oAuth Authorization Server Secrets." + }, + "resourceOwnerUsername": { + "type": "string", + "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." + }, + "resourceOwnerPassword": { + "type": "string", + "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." + } + }, + "description": "OAuth Server Secrets Contract." + }, + "BackendAuthorizationHeaderCredentials": { + "type": "object", + "properties": { + "scheme": { + "type": "string", + "description": "Authentication Scheme name.", + "minLength": 1, + "maxLength": 100 + }, + "parameter": { + "type": "string", + "description": "Authentication Parameter value.", + "minLength": 1, + "maxLength": 300 + } + }, + "required": [ + "scheme", + "parameter" + ], + "description": "Authorization header information." + }, + "BackendBaseParameters": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "Backend Title.", + "minLength": 1, + "maxLength": 300 + }, + "description": { + "type": "string", + "description": "Backend Description.", + "minLength": 1, + "maxLength": 2000 + }, + "resourceId": { + "type": "string", + "description": "Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.", + "minLength": 1, + "maxLength": 2000 + }, + "properties": { + "$ref": "#/definitions/BackendProperties", + "description": "Backend Properties contract" + }, + "credentials": { + "$ref": "#/definitions/BackendCredentialsContract", + "description": "Backend Credentials Contract Properties" + }, + "proxy": { + "$ref": "#/definitions/BackendProxyContract", + "description": "Backend gateway Contract Properties" + }, + "tls": { + "$ref": "#/definitions/BackendTlsProperties", + "description": "Backend TLS Properties" + }, + "circuitBreaker": { + "$ref": "#/definitions/BackendCircuitBreaker", + "description": "Backend Circuit Breaker Configuration" + }, + "pool": { + "allOf": [ + { + "$ref": "#/definitions/BackendPool" + }, + { + "description": "Backend Pool Properties" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Single", + "Pool" + ], + "x-ms-enum": { + "name": "BackendType", + "modelAsString": true, + "values": [ + { + "value": "Single", + "description": "supports single backend" + }, + { + "value": "Pool", + "description": "supports pool backend" + } + ] + }, + "description": "Type of the backend. A backend can be either Single or Pool." + } + }, + "description": "Backend entity base Parameter set." + }, + "BackendCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BackendContract" + }, + "description": "Backend values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Backend list representation." + }, + "BackendContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BackendContractProperties", + "description": "Backend entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Backend details." + }, + "BackendContractProperties": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "Runtime Url of the Backend.", + "minLength": 1, + "maxLength": 2000 + }, + "protocol": { + "type": "string", + "enum": [ + "http", + "soap" + ], + "x-ms-enum": { + "name": "BackendProtocol", + "modelAsString": true, + "values": [ + { + "value": "http", + "description": "The Backend is a RESTful service." + }, + { + "value": "soap", + "description": "The Backend is a SOAP service." + } + ] + }, + "description": "Backend communication protocol." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BackendBaseParameters" + } + ], + "required": [ + "url", + "protocol" + ], + "description": "Parameters supplied to the Create Backend operation." + }, + "BackendCredentialsContract": { + "type": "object", + "properties": { + "certificateIds": { + "type": "array", + "items": { + "type": "string" + }, + "maxItems": 32, + "description": "List of Client Certificate Ids." + }, + "certificate": { + "type": "array", + "items": { + "type": "string" + }, + "maxItems": 32, + "description": "List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided." + }, + "query": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Query Parameter description." + }, + "header": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Header Parameter description." + }, + "authorization": { + "description": "Authorization header authentication", + "$ref": "#/definitions/BackendAuthorizationHeaderCredentials" + } + }, + "description": "Details of the Credentials used to connect to Backend." + }, + "BackendProperties": { + "type": "object", + "properties": { + "serviceFabricCluster": { + "$ref": "#/definitions/BackendServiceFabricClusterProperties", + "description": "Backend Service Fabric Cluster Properties" + } + }, + "description": "Properties specific to the Backend Type." + }, + "BackendProxyContract": { + "type": "object", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/system.net.webproxy(v=vs.110).aspx", + "description": "Backend entity uses these details to connect to a WebProxy." + }, + "properties": { + "url": { + "type": "string", + "description": "WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.", + "minLength": 1, + "maxLength": 2000 + }, + "username": { + "type": "string", + "description": "Username to connect to the WebProxy server" + }, + "password": { + "type": "string", + "description": "Password to connect to the WebProxy Server" + } + }, + "required": [ + "url" + ], + "description": "Details of the Backend WebProxy Server to use in the Request to Backend." + }, + "BackendReconnectContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BackendReconnectProperties", + "description": "Reconnect request properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Reconnect request parameters." + }, + "BackendReconnectProperties": { + "type": "object", + "properties": { + "after": { + "type": "string", + "format": "duration", + "description": "Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M." + } + }, + "description": "Properties to control reconnect requests." + }, + "BackendServiceFabricClusterProperties": { + "type": "object", + "properties": { + "clientCertificateId": { + "description": "The client certificate id for the management endpoint.", + "type": "string" + }, + "clientCertificatethumbprint": { + "description": "The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided", + "type": "string" + }, + "maxPartitionResolutionRetries": { + "description": "Maximum number of retries while attempting resolve the partition.", + "format": "int32", + "type": "integer" + }, + "managementEndpoints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The cluster management endpoint." + }, + "serverCertificateThumbprints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Thumbprints of certificates cluster management service uses for tls communication" + }, + "serverX509Names": { + "type": "array", + "items": { + "$ref": "#/definitions/X509CertificateName" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Server X509 Certificate Names Collection" + } + }, + "required": [ + "managementEndpoints" + ], + "description": "Properties of the Service Fabric Type Backend." + }, + "BackendTlsProperties": { + "type": "object", + "properties": { + "validateCertificateChain": { + "description": "Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.", + "type": "boolean", + "default": true + }, + "validateCertificateName": { + "description": "Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.", + "type": "boolean", + "default": true + } + }, + "description": "Properties controlling TLS Certificate Validation." + }, + "BackendUpdateParameterProperties": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "Runtime Url of the Backend.", + "minLength": 1, + "maxLength": 2000 + }, + "protocol": { + "type": "string", + "enum": [ + "http", + "soap" + ], + "x-ms-enum": { + "name": "BackendProtocol", + "modelAsString": true, + "values": [ + { + "value": "http", + "description": "The Backend is a RESTful service." + }, + { + "value": "soap", + "description": "The Backend is a SOAP service." + } + ] + }, + "description": "Backend communication protocol." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BackendBaseParameters" + } + ], + "description": "Parameters supplied to the Update Backend operation." + }, + "BackendUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BackendUpdateParameterProperties", + "description": "Backend entity update contract properties." + } + }, + "description": "Backend update parameters." + }, + "BackendCircuitBreaker": { + "type": "object", + "description": "The configuration of the backend circuit breaker", + "properties": { + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/CircuitBreakerRule" + }, + "maxItems": 15, + "description": "The rules for tripping the backend.", + "x-ms-identifiers": [] + } + } + }, + "CircuitBreakerRule": { + "type": "object", + "description": "Rule configuration to trip the backend.", + "properties": { + "name": { + "type": "string", + "description": "The rule name." + }, + "failureCondition": { + "$ref": "#/definitions/CircuitBreakerFailureCondition", + "description": "The conditions for tripping the circuit breaker." + }, + "tripDuration": { + "type": "string", + "format": "duration", + "description": "The duration for which the circuit will be tripped." + }, + "acceptRetryAfter": { + "type": "boolean", + "description": "flag to accept Retry-After header from the backend." + } + } + }, + "CircuitBreakerFailureCondition": { + "type": "object", + "description": "The trip conditions of the circuit breaker", + "properties": { + "count": { + "type": "integer", + "format": "int64", + "description": "The threshold for opening the circuit." + }, + "percentage": { + "type": "integer", + "format": "int64", + "description": "The threshold for opening the circuit." + }, + "interval": { + "type": "string", + "format": "duration", + "description": "The interval during which the failures are counted." + }, + "statusCodeRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/FailureStatusCodeRange" + }, + "maxItems": 10, + "description": "The status code ranges which are considered as failure.", + "x-ms-identifiers": [] + }, + "errorReasons": { + "type": "array", + "items": { + "type": "string", + "maxLength": 200 + }, + "maxItems": 10, + "description": "The error reasons which are considered as failure.", + "x-ms-identifiers": [] + } + } + }, + "FailureStatusCodeRange": { + "type": "object", + "description": "The failure http status code range", + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum http status code.", + "minimum": 200, + "maximum": 599 + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum http status code.", + "minimum": 200, + "maximum": 599 + } + } + }, + "BackendPool": { + "type": "object", + "description": "Backend pool information", + "properties": { + "services": { + "type": "array", + "description": "The list of backend entities belonging to a pool.", + "items": { + "$ref": "#/definitions/BackendPoolItem" + }, + "minItems": 1, + "x-ms-identifiers": [], + "example": { + "services": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends" + } + } + } + }, + "BackendPoolItem": { + "type": "object", + "description": "Backend pool service information", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.", + "example": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend" + } + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.", + "minimum": 0, + "maximum": 100, + "example": { + "weight": 1 + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.", + "minimum": 0, + "maximum": 100, + "example": { + "priority": 1 + } + } + }, + "required": [ + "id" + ] + }, + "BearerTokenSendingMethodsContract": { + "type": "string", + "description": "Form of an authorization grant, which the client uses to request the access token.", + "enum": [ + "authorizationHeader", + "query" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "bearerTokenSendingMethods", + "values": [ + { + "value": "authorizationHeader", + "description": "Access token will be transmitted in the Authorization header using Bearer schema" + }, + { + "value": "query", + "description": "Access token will be transmitted as query parameters." + } + ] + } + }, + "BodyDiagnosticSettings": { + "type": "object", + "properties": { + "bytes": { + "type": "integer", + "format": "int32", + "maximum": 8192, + "description": "Number of request body bytes to log." + } + }, + "description": "Body logging settings." + }, + "CacheCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CacheContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Caches list representation." + }, + "CacheContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CacheContractProperties", + "description": "Cache properties details." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Cache details." + }, + "CacheContractProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Cache description", + "maxLength": 2000 + }, + "connectionString": { + "type": "string", + "description": "Runtime connection string to cache", + "maxLength": 300 + }, + "useFromLocation": { + "type": "string", + "description": "Location identifier to use cache from (should be either 'default' or valid Azure region identifier)", + "maxLength": 256 + }, + "resourceId": { + "type": "string", + "description": "Original uri of entity in external system cache points to", + "maxLength": 2000 + } + }, + "required": [ + "connectionString", + "useFromLocation" + ], + "description": "Properties of the Cache contract." + }, + "CacheUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CacheUpdateProperties", + "description": "Cache update properties details." + } + }, + "description": "Cache update details." + }, + "CacheUpdateProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Cache description", + "maxLength": 2000 + }, + "connectionString": { + "type": "string", + "description": "Runtime connection string to cache", + "maxLength": 300 + }, + "useFromLocation": { + "type": "string", + "description": "Location identifier to use cache from (should be either 'default' or valid Azure region identifier)", + "maxLength": 256 + }, + "resourceId": { + "type": "string", + "description": "Original uri of entity in external system cache points to", + "maxLength": 2000 + } + }, + "description": "Parameters supplied to the Update Cache operation." + }, + "CertificateCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Certificates list representation." + }, + "CertificateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CertificateContractProperties", + "description": "Certificate properties details." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Certificate details." + }, + "CertificateContractProperties": { + "type": "object", + "properties": { + "subject": { + "type": "string", + "description": "Subject attribute of the certificate." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "keyVault": { + "$ref": "#/definitions/KeyVaultContractProperties", + "description": "KeyVault location details of the certificate." + } + }, + "required": [ + "subject", + "thumbprint", + "expirationDate" + ], + "description": "Properties of the Certificate contract." + }, + "CertificateCreateOrUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CertificateCreateOrUpdateProperties", + "description": "Certificate create or update properties details." + } + }, + "description": "Certificate create or update details." + }, + "CertificateCreateOrUpdateProperties": { + "type": "object", + "properties": { + "data": { + "type": "string", + "description": "Base 64 encoded certificate using the application/x-pkcs12 representation." + }, + "password": { + "type": "string", + "description": "Password for the Certificate" + }, + "keyVault": { + "$ref": "#/definitions/KeyVaultContractCreateProperties", + "description": "KeyVault location details of the certificate." + } + }, + "description": "Parameters supplied to the CreateOrUpdate certificate operation." + }, + "DataMasking": { + "type": "object", + "properties": { + "queryParams": { + "type": "array", + "items": { + "$ref": "#/definitions/DataMaskingEntity" + }, + "x-ms-identifiers": [], + "description": "Masking settings for Url query parameters" + }, + "headers": { + "type": "array", + "items": { + "$ref": "#/definitions/DataMaskingEntity" + }, + "x-ms-identifiers": [], + "description": "Masking settings for headers" + } + } + }, + "DataMaskingEntity": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The name of an entity to mask (e.g. a name of a header or a query parameter)." + }, + "mode": { + "type": "string", + "enum": [ + "Mask", + "Hide" + ], + "x-ms-enum": { + "name": "DataMaskingMode", + "modelAsString": true, + "values": [ + { + "value": "Mask", + "description": "Mask the value of an entity." + }, + { + "value": "Hide", + "description": "Hide the presence of an entity." + } + ] + }, + "description": "Data masking mode." + } + } + }, + "DeployConfigurationParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeployConfigurationParameterProperties", + "description": "Deploy Configuration Parameter contract properties." + } + }, + "description": "Deploy Tenant Configuration Contract." + }, + "DeployConfigurationParameterProperties": { + "type": "object", + "properties": { + "branch": { + "type": "string", + "description": "The name of the Git branch from which the configuration is to be deployed to the configuration database." + }, + "force": { + "type": "boolean", + "description": "The value enforcing deleting subscriptions to products that are deleted in this update." + } + }, + "required": [ + "branch" + ], + "description": "Parameters supplied to the Deploy Configuration operation." + }, + "DiagnosticCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Diagnostic list representation." + }, + "DiagnosticContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiagnosticContractProperties", + "description": "Diagnostic entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Diagnostic details." + }, + "DiagnosticContractProperties": { + "type": "object", + "properties": { + "alwaysLog": { + "type": "string", + "enum": [ + "allErrors" + ], + "x-ms-enum": { + "name": "AlwaysLog", + "modelAsString": true, + "values": [ + { + "value": "allErrors", + "description": "Always log all erroneous request regardless of sampling settings." + } + ] + }, + "description": "Specifies for what type of messages sampling settings should not apply." + }, + "loggerId": { + "type": "string", + "description": "Resource Id of a target logger." + }, + "sampling": { + "$ref": "#/definitions/SamplingSettings", + "description": "Sampling settings for Diagnostic." + }, + "frontend": { + "$ref": "#/definitions/PipelineDiagnosticSettings", + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." + }, + "backend": { + "$ref": "#/definitions/PipelineDiagnosticSettings", + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Backend" + }, + "logClientIp": { + "type": "boolean", + "description": "Log the ClientIP. Default is false." + }, + "httpCorrelationProtocol": { + "type": "string", + "enum": [ + "None", + "Legacy", + "W3C" + ], + "x-ms-enum": { + "name": "HttpCorrelationProtocol", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Do not read and inject correlation headers." + }, + { + "value": "Legacy", + "description": "Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md." + }, + { + "value": "W3C", + "description": "Inject Trace Context headers. See https://w3c.github.io/trace-context." + } + ] + }, + "description": "Sets correlation protocol to use for Application Insights diagnostics." + }, + "verbosity": { + "type": "string", + "enum": [ + "verbose", + "information", + "error" + ], + "x-ms-enum": { + "name": "Verbosity", + "modelAsString": true, + "values": [ + { + "value": "verbose", + "description": "All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance." + }, + { + "value": "information", + "description": "Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance." + }, + { + "value": "error", + "description": "Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance." + } + ] + }, + "description": "The verbosity level applied to traces emitted by trace policies." + }, + "operationNameFormat": { + "type": "string", + "enum": [ + "Name", + "Url" + ], + "x-ms-enum": { + "name": "OperationNameFormat", + "modelAsString": true, + "values": [ + { + "value": "Name", + "description": "API_NAME;rev=API_REVISION - OPERATION_NAME" + }, + { + "value": "Url", + "description": "HTTP_VERB URL" + } + ] + }, + "description": "The format of the Operation Name for Application Insights telemetries. Default is Name." + }, + "metrics": { + "type": "boolean", + "description": "Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings." + } + }, + "required": [ + "loggerId" + ], + "description": "Diagnostic Entity Properties" + }, + "DiagnosticUpdateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiagnosticContractUpdateProperties", + "description": "Diagnostic entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Diagnostic details." + }, + "DiagnosticContractUpdateProperties": { + "type": "object", + "properties": { + "alwaysLog": { + "type": "string", + "enum": [ + "allErrors" + ], + "x-ms-enum": { + "name": "AlwaysLog", + "modelAsString": true, + "values": [ + { + "value": "allErrors", + "description": "Always log all erroneous request regardless of sampling settings." + } + ] + }, + "description": "Specifies for what type of messages sampling settings should not apply." + }, + "loggerId": { + "type": "string", + "description": "Resource Id of a target logger." + }, + "sampling": { + "$ref": "#/definitions/SamplingSettings", + "description": "Sampling settings for Diagnostic." + }, + "frontend": { + "$ref": "#/definitions/PipelineDiagnosticSettings", + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." + }, + "backend": { + "$ref": "#/definitions/PipelineDiagnosticSettings", + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Backend" + }, + "logClientIp": { + "type": "boolean", + "description": "Log the ClientIP. Default is false." + }, + "httpCorrelationProtocol": { + "type": "string", + "enum": [ + "None", + "Legacy", + "W3C" + ], + "x-ms-enum": { + "name": "HttpCorrelationProtocol", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Do not read and inject correlation headers." + }, + { + "value": "Legacy", + "description": "Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md." + }, + { + "value": "W3C", + "description": "Inject Trace Context headers. See https://w3c.github.io/trace-context." + } + ] + }, + "description": "Sets correlation protocol to use for Application Insights diagnostics." + }, + "verbosity": { + "type": "string", + "enum": [ + "verbose", + "information", + "error" + ], + "x-ms-enum": { + "name": "Verbosity", + "modelAsString": true, + "values": [ + { + "value": "verbose", + "description": "All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance." + }, + { + "value": "information", + "description": "Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance." + }, + { + "value": "error", + "description": "Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance." + } + ] + }, + "description": "The verbosity level applied to traces emitted by trace policies." + }, + "operationNameFormat": { + "type": "string", + "enum": [ + "Name", + "Url" + ], + "x-ms-enum": { + "name": "OperationNameFormat", + "modelAsString": true, + "values": [ + { + "value": "Name", + "description": "API_NAME;rev=API_REVISION - OPERATION_NAME" + }, + { + "value": "Url", + "description": "HTTP_VERB URL" + } + ] + }, + "description": "The format of the Operation Name for Application Insights telemetries. Default is Name." + }, + "metrics": { + "type": "boolean", + "description": "Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings." + } + }, + "description": "Diagnostic Entity Properties" + }, + "EmailTemplateCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EmailTemplateContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged email template list representation." + }, + "EmailTemplateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EmailTemplateContractProperties", + "description": "Email Template entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Email Template details." + }, + "EmailTemplateContractProperties": { + "type": "object", + "properties": { + "subject": { + "type": "string", + "description": "Subject of the Template.", + "minLength": 1, + "maxLength": 1000 + }, + "body": { + "type": "string", + "description": "Email Template Body. This should be a valid XDocument", + "minLength": 1 + }, + "title": { + "type": "string", + "description": "Title of the Template." + }, + "description": { + "type": "string", + "description": "Description of the Email Template." + }, + "isDefault": { + "type": "boolean", + "description": "Whether the template is the default template provided by API Management or has been edited.", + "readOnly": true + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/EmailTemplateParametersContractProperties" + }, + "x-ms-identifiers": [ + "title" + ], + "description": "Email Template Parameter values." + } + }, + "required": [ + "body", + "subject" + ], + "description": "Email Template Contract properties." + }, + "EmailTemplateParametersContractProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Template parameter name.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + }, + "title": { + "type": "string", + "description": "Template parameter title.", + "minLength": 1, + "maxLength": 4096 + }, + "description": { + "type": "string", + "description": "Template parameter description.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + } + }, + "description": "Email Template Parameter contract." + }, + "EmailTemplateUpdateParameterProperties": { + "type": "object", + "properties": { + "subject": { + "type": "string", + "description": "Subject of the Template.", + "minLength": 1, + "maxLength": 1000 + }, + "title": { + "type": "string", + "description": "Title of the Template." + }, + "description": { + "type": "string", + "description": "Description of the Email Template." + }, + "body": { + "type": "string", + "description": "Email Template Body. This should be a valid XDocument", + "minLength": 1 + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/EmailTemplateParametersContractProperties" + }, + "x-ms-identifiers": [ + "title" + ], + "description": "Email Template Parameter values." + } + }, + "description": "Email Template Update Contract properties." + }, + "EmailTemplateUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EmailTemplateUpdateParameterProperties", + "description": "Email Template Update contract properties." + } + }, + "description": "Email Template update Parameters." + }, + "GenerateSsoUrlResult": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Redirect Url containing the SSO URL value." + } + }, + "description": "Generate SSO Url operations response details." + }, + "GroupCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GroupContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Group list representation." + }, + "GroupContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GroupContractProperties", + "description": "Group entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Contract details." + }, + "GroupContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Group name.", + "maxLength": 300, + "minLength": 1 + }, + "description": { + "type": "string", + "description": "Group description. Can contain HTML formatting tags.", + "maxLength": 1000 + }, + "builtIn": { + "readOnly": true, + "type": "boolean", + "description": "true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false." + }, + "type": { + "type": "string", + "description": "Group type.", + "enum": [ + "custom", + "system", + "external" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": false + } + }, + "externalId": { + "type": "string", + "description": "For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null." + } + }, + "required": [ + "displayName" + ], + "description": "Group contract Properties." + }, + "GroupCreateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GroupCreateParametersProperties", + "description": "Properties supplied to Create Group operation." + } + }, + "description": "Parameters supplied to the Create Group operation." + }, + "GroupCreateParametersProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Group name.", + "maxLength": 300, + "minLength": 1 + }, + "description": { + "type": "string", + "description": "Group description." + }, + "type": { + "type": "string", + "description": "Group type.", + "enum": [ + "custom", + "system", + "external" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": false + } + }, + "externalId": { + "type": "string", + "description": "Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null." + } + }, + "required": [ + "displayName" + ], + "description": "Parameters supplied to the Create Group operation." + }, + "GroupUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GroupUpdateParametersProperties", + "description": "Group entity update contract properties." + } + }, + "description": "Parameters supplied to the Update Group operation." + }, + "GroupUpdateParametersProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Group name.", + "maxLength": 300, + "minLength": 1 + }, + "description": { + "type": "string", + "description": "Group description." + }, + "type": { + "type": "string", + "description": "Group type.", + "enum": [ + "custom", + "system", + "external" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": false + } + }, + "externalId": { + "type": "string", + "description": "Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null." + } + }, + "description": "Parameters supplied to the Update Group operation." + }, + "HttpMessageDiagnostic": { + "type": "object", + "properties": { + "headers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of HTTP Headers to log." + }, + "body": { + "$ref": "#/definitions/BodyDiagnosticSettings", + "description": "Body logging settings." + }, + "dataMasking": { + "$ref": "#/definitions/DataMasking", + "description": "Data masking settings." + } + }, + "description": "Http message diagnostic settings." + }, + "IdentityProviderBaseParameters": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ], + "x-ms-enum": { + "name": "IdentityProviderType", + "modelAsString": true, + "values": [ + { + "value": "facebook", + "description": "Facebook as Identity provider." + }, + { + "value": "google", + "description": "Google as Identity provider." + }, + { + "value": "microsoft", + "description": "Microsoft Live as Identity provider." + }, + { + "value": "twitter", + "description": "Twitter as Identity provider." + }, + { + "value": "aad", + "description": "Azure Active Directory as Identity provider." + }, + { + "value": "aadB2C", + "description": "Azure Active Directory B2C as Identity provider." + } + ] + }, + "description": "Identity Provider Type identifier." + }, + "signinTenant": { + "type": "string", + "description": "The TenantId to use instead of Common when logging into Active Directory" + }, + "allowedTenants": { + "type": "array", + "items": { + "type": "string" + }, + "maxItems": 32, + "description": "List of Allowed Tenants when configuring Azure Active Directory login." + }, + "authority": { + "type": "string", + "description": "OpenID Connect discovery endpoint hostname for AAD or AAD B2C." + }, + "signupPolicyName": { + "type": "string", + "description": "Signup Policy Name. Only applies to AAD B2C Identity Provider.", + "minLength": 1 + }, + "signinPolicyName": { + "type": "string", + "description": "Signin Policy Name. Only applies to AAD B2C Identity Provider.", + "minLength": 1 + }, + "profileEditingPolicyName": { + "type": "string", + "description": "Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.", + "minLength": 1 + }, + "passwordResetPolicyName": { + "type": "string", + "description": "Password Reset Policy Name. Only applies to AAD B2C Identity Provider.", + "minLength": 1 + }, + "clientLibrary": { + "type": "string", + "description": "The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.", + "minLength": 0, + "maxLength": 16 + } + }, + "description": "Identity Provider Base Parameter Properties." + }, + "IdentityProviderCreateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IdentityProviderCreateContractProperties", + "description": "Identity Provider contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Identity Provider details." + }, + "IdentityProviderCreateContractProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.", + "minLength": 1 + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string", + "description": "Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "minLength": 1 + } + }, + "allOf": [ + { + "$ref": "#/definitions/IdentityProviderBaseParameters" + } + ], + "required": [ + "clientId", + "clientSecret" + ], + "description": "The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users." + }, + "IdentityProviderContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IdentityProviderContractProperties", + "description": "Identity Provider contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Identity Provider details." + }, + "IdentityProviderContractProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.", + "minLength": 1 + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string", + "description": "Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "minLength": 1 + } + }, + "allOf": [ + { + "$ref": "#/definitions/IdentityProviderBaseParameters" + } + ], + "required": [ + "clientId" + ], + "description": "The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users." + }, + "IdentityProviderList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IdentityProviderContract" + }, + "description": "Identity Provider configuration values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "List of all the Identity Providers configured on the service instance." + }, + "IdentityProviderUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IdentityProviderUpdateProperties", + "description": "Identity Provider update properties." + } + }, + "description": "Parameters supplied to update Identity Provider" + }, + "IdentityProviderUpdateProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.", + "minLength": 1 + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string", + "description": "Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.", + "minLength": 1 + } + }, + "allOf": [ + { + "$ref": "#/definitions/IdentityProviderBaseParameters" + } + ], + "description": "Parameters supplied to the Update Identity Provider operation." + }, + "IssueAttachmentCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IssueAttachmentContract" + }, + "description": "Issue Attachment values.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Issue Attachment list representation." + }, + "IssueAttachmentContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IssueAttachmentContractProperties", + "description": "Properties of the Issue Attachment." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Issue Attachment Contract details." + }, + "IssueAttachmentContractProperties": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "Filename by which the binary data will be saved." + }, + "contentFormat": { + "type": "string", + "description": "Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property." + }, + "content": { + "type": "string", + "description": "An HTTP link or Base64-encoded binary data." + } + }, + "required": [ + "title", + "contentFormat", + "content" + ], + "description": "Issue Attachment contract Properties." + }, + "IssueCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IssueContract" + }, + "description": "Issue values.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Issue list representation." + }, + "IssueCommentCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IssueCommentContract" + }, + "description": "Issue Comment values.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Issue Comment list representation." + }, + "IssueCommentContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IssueCommentContractProperties", + "description": "Properties of the Issue Comment." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Issue Comment Contract details." + }, + "IssueCommentContractProperties": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "Comment text." + }, + "createdDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the comment was created." + }, + "userId": { + "type": "string", + "description": "A resource identifier for the user who left the comment." + } + }, + "required": [ + "text", + "userId" + ], + "description": "Issue Comment contract Properties." + }, + "IssueContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IssueContractProperties", + "description": "Properties of the Issue." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Issue Contract details." + }, + "IssueContractBaseProperties": { + "type": "object", + "properties": { + "createdDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the issue was created." + }, + "state": { + "type": "string", + "description": "Status of the issue.", + "enum": [ + "proposed", + "open", + "removed", + "resolved", + "closed" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "value": "proposed", + "description": "The issue is proposed." + }, + { + "value": "open", + "description": "The issue is opened." + }, + { + "value": "removed", + "description": "The issue was removed." + }, + { + "value": "resolved", + "description": "The issue is now resolved." + }, + { + "value": "closed", + "description": "The issue was closed." + } + ] + } + }, + "apiId": { + "type": "string", + "description": "A resource identifier for the API the issue was created for." + } + }, + "description": "Issue contract Base Properties." + }, + "IssueContractProperties": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The issue title." + }, + "description": { + "type": "string", + "description": "Text describing the issue." + }, + "userId": { + "type": "string", + "description": "A resource identifier for the user created the issue." + } + }, + "required": [ + "title", + "description", + "userId" + ], + "allOf": [ + { + "$ref": "#/definitions/IssueContractBaseProperties" + } + ], + "description": "Issue contract Properties." + }, + "IssueUpdateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IssueUpdateContractProperties", + "description": "Issue entity Update contract properties." + } + }, + "description": "Issue update Parameters." + }, + "IssueUpdateContractProperties": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The issue title." + }, + "description": { + "type": "string", + "description": "Text describing the issue." + }, + "userId": { + "type": "string", + "description": "A resource identifier for the user created the issue." + } + }, + "allOf": [ + { + "$ref": "#/definitions/IssueContractBaseProperties" + } + ], + "description": "Issue contract Update Properties." + }, + "KeyVaultContractCreateProperties": { + "type": "object", + "properties": { + "secretIdentifier": { + "type": "string", + "description": "Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi" + }, + "identityClientId": { + "type": "string", + "description": "Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret." + } + }, + "description": "Create keyVault contract details." + }, + "KeyVaultContractProperties": { + "type": "object", + "properties": { + "lastStatus": { + "$ref": "#/definitions/KeyVaultLastAccessStatusContractProperties", + "description": "Last time sync and refresh status of secret from key vault." + } + }, + "allOf": [ + { + "$ref": "#/definitions/KeyVaultContractCreateProperties" + } + ], + "description": "KeyVault contract details." + }, + "KeyVaultLastAccessStatusContractProperties": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Last status code for sync and refresh of secret from key vault." + }, + "message": { + "type": "string", + "description": "Details of the error else empty." + }, + "timeStampUtc": { + "type": "string", + "format": "date-time", + "description": "Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + } + }, + "description": "Issue contract Update Properties." + }, + "LoggerCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LoggerContract" + }, + "description": "Logger values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Logger list representation." + }, + "LoggerContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoggerContractProperties", + "description": "Logger entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Logger details." + }, + "LoggerContractProperties": { + "type": "object", + "properties": { + "loggerType": { + "type": "string", + "description": "Logger type.", + "enum": [ + "azureEventHub", + "applicationInsights", + "azureMonitor" + ], + "x-ms-enum": { + "name": "LoggerType", + "modelAsString": true, + "values": [ + { + "value": "azureEventHub", + "description": "Azure Event Hub as log destination." + }, + { + "value": "applicationInsights", + "description": "Azure Application Insights as log destination." + }, + { + "value": "azureMonitor", + "description": "Azure Monitor" + } + ] + } + }, + "description": { + "type": "string", + "description": "Logger description.", + "maxLength": 256 + }, + "credentials": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The name and SendRule connection string of the event hub for azureEventHub logger.\nInstrumentation key for applicationInsights logger.", + "example": { + "name": "apim", + "connectionString": "Endpoint=sb://contoso-ns.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=..." + } + }, + "isBuffered": { + "type": "boolean", + "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." + }, + "resourceId": { + "type": "string", + "description": "Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource)." + } + }, + "required": [ + "loggerType" + ], + "description": "The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs." + }, + "LoggerUpdateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoggerUpdateParameters", + "description": "Logger entity update contract properties." + } + }, + "description": "Logger update contract." + }, + "LoggerUpdateParameters": { + "type": "object", + "properties": { + "loggerType": { + "type": "string", + "description": "Logger type.", + "enum": [ + "azureEventHub", + "applicationInsights", + "azureMonitor" + ], + "x-ms-enum": { + "name": "LoggerType", + "modelAsString": true, + "values": [ + { + "value": "azureEventHub", + "description": "Azure Event Hub as log destination." + }, + { + "value": "applicationInsights", + "description": "Azure Application Insights as log destination." + }, + { + "value": "azureMonitor", + "description": "Azure Monitor" + } + ] + } + }, + "description": { + "type": "string", + "description": "Logger description." + }, + "credentials": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Logger credentials." + }, + "isBuffered": { + "type": "boolean", + "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." + } + }, + "description": "Parameters supplied to the Update Logger operation." + }, + "NotificationCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NotificationContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Notification list representation." + }, + "NotificationContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NotificationContractProperties", + "description": "Notification entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Notification details." + }, + "NotificationContractProperties": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "Title of the Notification.", + "minLength": 1, + "maxLength": 1000 + }, + "description": { + "type": "string", + "description": "Description of the Notification." + }, + "recipients": { + "$ref": "#/definitions/RecipientsContractProperties", + "description": "Recipient Parameter values." + } + }, + "required": [ + "title" + ], + "description": "Notification Contract properties." + }, + "OAuth2AuthenticationSettingsContract": { + "type": "object", + "properties": { + "authorizationServerId": { + "type": "string", + "description": "OAuth authorization server identifier." + }, + "scope": { + "type": "string", + "description": "operations scope." + } + }, + "description": "API OAuth2 Authentication settings details." + }, + "OpenIdAuthenticationSettingsContract": { + "type": "object", + "properties": { + "openidProviderId": { + "type": "string", + "description": "OAuth authorization server identifier." + }, + "bearerTokenSendingMethods": { + "description": "How to send token to the server.", + "type": "array", + "items": { + "$ref": "#/definitions/BearerTokenSendingMethodsContract" + } + } + }, + "description": "API OAuth2 Authentication settings details." + }, + "OpenIdConnectProviderCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OpenidConnectProviderContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged OpenIdProviders list representation." + }, + "OpenidConnectProviderContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OpenidConnectProviderContractProperties", + "description": "OpenId Connect Provider contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "OpenId Connect Provider details." + }, + "OpenidConnectProviderContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly OpenID Connect Provider name.", + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "User-friendly description of OpenID Connect Provider." + }, + "metadataEndpoint": { + "type": "string", + "description": "Metadata endpoint URI." + }, + "clientId": { + "type": "string", + "description": "Client ID of developer console which is the client application." + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string", + "description": "Client Secret of developer console which is the client application." + }, + "useInTestConsole": { + "type": "boolean", + "description": "If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided." + }, + "useInApiDocumentation": { + "type": "boolean", + "description": "If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided." + } + }, + "required": [ + "displayName", + "metadataEndpoint", + "clientId" + ], + "description": "OpenID Connect Providers Contract." + }, + "OpenidConnectProviderUpdateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OpenidConnectProviderUpdateContractProperties", + "description": "OpenId Connect Provider Update contract properties." + } + }, + "description": "Parameters supplied to the Update OpenID Connect Provider operation." + }, + "OpenidConnectProviderUpdateContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly OpenID Connect Provider name.", + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "User-friendly description of OpenID Connect Provider." + }, + "metadataEndpoint": { + "type": "string", + "description": "Metadata endpoint URI." + }, + "clientId": { + "type": "string", + "description": "Client ID of developer console which is the client application." + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string", + "description": "Client Secret of developer console which is the client application." + }, + "useInTestConsole": { + "type": "boolean", + "description": "If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided." + }, + "useInApiDocumentation": { + "type": "boolean", + "description": "If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided." + } + }, + "description": "Parameters supplied to the Update OpenID Connect Provider operation." + }, + "OperationCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OperationContract" + }, + "description": "Page values.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Operation list representation." + }, + "OperationContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationContractProperties", + "description": "Properties of the Operation Contract." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "API Operation details." + }, + "OperationContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Operation Name.", + "minLength": 1, + "maxLength": 300 + }, + "method": { + "type": "string", + "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", + "externalDocs": { + "description": "As defined by RFC.", + "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" + } + }, + "urlTemplate": { + "type": "string", + "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", + "minLength": 1, + "maxLength": 1000 + } + }, + "allOf": [ + { + "$ref": "#/definitions/OperationEntityBaseContract" + } + ], + "required": [ + "displayName", + "method", + "urlTemplate" + ], + "description": "Operation Contract Properties" + }, + "OperationEntityBaseContract": { + "type": "object", + "properties": { + "templateParameters": { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "description": "Collection of URL template parameters." + }, + "description": { + "type": "string", + "description": "Description of the operation. May include HTML formatting tags.", + "maxLength": 1000 + }, + "request": { + "$ref": "#/definitions/RequestContract", + "description": "An entity containing request details." + }, + "responses": { + "type": "array", + "items": { + "$ref": "#/definitions/ResponseContract" + }, + "x-ms-identifiers": [], + "description": "Array of Operation responses." + }, + "policies": { + "type": "string", + "description": "Operation Policies" + } + }, + "description": "API Operation Entity Base Contract details." + }, + "OperationResultContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationResultContractProperties", + "description": "Properties of the Operation Contract." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Long Running Git Operation Results." + }, + "OperationResultContractProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Operation result identifier." + }, + "status": { + "type": "string", + "description": "Status of an async operation.", + "enum": [ + "Started", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncOperationStatus", + "modelAsString": false + } + }, + "started": { + "type": "string", + "format": "date-time", + "description": "Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "updated": { + "type": "string", + "format": "date-time", + "description": "Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "resultInfo": { + "type": "string", + "description": "Optional result info." + }, + "error": { + "$ref": "./apimanagement.json#/definitions/ErrorResponseBody", + "description": "Error Body Contract" + }, + "actionLog": { + "type": "array", + "items": { + "$ref": "#/definitions/OperationResultLogItemContract" + }, + "x-ms-identifiers": [ + "objectKey" + ], + "readOnly": true, + "description": "This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation." + } + }, + "description": "Operation Result." + }, + "OperationResultLogItemContract": { + "type": "object", + "properties": { + "objectType": { + "type": "string", + "description": "The type of entity contract." + }, + "action": { + "type": "string", + "description": "Action like create/update/delete." + }, + "objectKey": { + "type": "string", + "description": "Identifier of the entity being created/updated/deleted." + } + }, + "description": "Log of the entity being created, updated or deleted." + }, + "OperationTagResourceContractProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the operation in form /operations/{operationId}." + }, + "name": { + "type": "string", + "description": "Operation name.", + "readOnly": true + }, + "apiName": { + "type": "string", + "description": "API Name.", + "readOnly": true + }, + "apiRevision": { + "type": "string", + "description": "API Revision.", + "readOnly": true + }, + "apiVersion": { + "type": "string", + "description": "API Version.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Operation Description.", + "readOnly": true + }, + "method": { + "type": "string", + "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", + "externalDocs": { + "description": "As defined by RFC.", + "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" + }, + "readOnly": true + }, + "urlTemplate": { + "type": "string", + "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", + "readOnly": true + } + }, + "description": "Operation Entity contract Properties." + }, + "OperationUpdateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationUpdateContractProperties", + "description": "Properties of the API Operation entity that can be updated." + } + }, + "description": "API Operation Update Contract details." + }, + "OperationUpdateContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Operation Name.", + "minLength": 1, + "maxLength": 300 + }, + "method": { + "type": "string", + "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", + "externalDocs": { + "description": "As defined by RFC.", + "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" + } + }, + "urlTemplate": { + "type": "string", + "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", + "minLength": 1, + "maxLength": 1000 + } + }, + "allOf": [ + { + "$ref": "#/definitions/OperationEntityBaseContract" + } + ], + "description": "Operation Update Contract Properties." + }, + "ParameterContract": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Parameter name." + }, + "description": { + "type": "string", + "description": "Parameter description." + }, + "type": { + "type": "string", + "description": "Parameter type." + }, + "defaultValue": { + "type": "string", + "description": "Default parameter value." + }, + "required": { + "type": "boolean", + "description": "Specifies whether parameter is required or not." + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Parameter values." + }, + "schemaId": { + "type": "string", + "description": "Schema identifier." + }, + "typeName": { + "type": "string", + "description": "Type name defined by the schema." + }, + "examples": { + "$ref": "#/definitions/ParameterExamplesContract", + "description": "Exampled defined for the parameter." + } + }, + "required": [ + "name", + "type" + ], + "description": "Operation parameters details." + }, + "ParameterExamplesContract": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ParameterExampleContract", + "description": "Parameter example." + }, + "description": "Parameter examples." + }, + "ParameterExampleContract": { + "type": "object", + "description": "Parameter example.", + "properties": { + "summary": { + "type": "string", + "description": "Short description for the example" + }, + "description": { + "type": "string", + "description": "Long description for the example" + }, + "value": { + "description": "Example value. May be a primitive value, or an object." + }, + "externalValue": { + "type": "string", + "description": "A URL that points to the literal example" + } + } + }, + "PipelineDiagnosticSettings": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/HttpMessageDiagnostic", + "description": "Diagnostic settings for request." + }, + "response": { + "$ref": "#/definitions/HttpMessageDiagnostic", + "description": "Diagnostic settings for response." + } + }, + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." + }, + "PolicyCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyContract" + }, + "description": "Policy Contract value." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "The response of the list policy operation." + }, + "PolicyContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyContractProperties", + "description": "Properties of the Policy." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Policy Contract details." + }, + "PolicyContractProperties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Contents of the Policy as defined by the format." + }, + "format": { + "type": "string", + "description": "Format of the policyContent.", + "enum": [ + "xml", + "xml-link", + "rawxml", + "rawxml-link" + ], + "x-ms-enum": { + "name": "PolicyContentFormat", + "modelAsString": true, + "values": [ + { + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "value": "xml-link", + "description": "The policy XML document is hosted on a HTTP endpoint accessible from the API Management service." + }, + { + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + }, + { + "value": "rawxml-link", + "description": "The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service." + } + ] + }, + "default": "xml" + } + }, + "required": [ + "value" + ], + "description": "Policy contract Properties." + }, + "PolicyWithComplianceCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyWithComplianceContract" + }, + "description": "Policy Contract value." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "The response of the list policy operation." + }, + "PolicyWithComplianceContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyWithComplianceContractProperties", + "description": "Properties of the Policy." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Policy Contract details." + }, + "PolicyWithComplianceContractProperties": { + "type": "object", + "properties": { + "referencePolicyId": { + "type": "string", + "description": "Policy Identifier" + }, + "complianceState": { + "type": "string", + "description": "Policy Restriction Compliance State", + "enum": [ + "Pending", + "NonCompliant", + "Compliant" + ], + "x-ms-enum": { + "name": "PolicyComplianceState", + "modelAsString": true, + "values": [ + { + "value": "Pending", + "description": "The policy restriction compliance state has not yet been determined." + }, + { + "value": "NonCompliant", + "description": "The scope in restriction is out of compliance." + }, + { + "value": "Compliant", + "description": "The scope in restriction is in compliance." + } + ] + }, + "default": "Pending" + } + }, + "description": "Policy contract Properties." + }, + "PolicyDescriptionContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyDescriptionContractProperties", + "description": "Policy description contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Policy description details." + }, + "PolicyDescriptionContractProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Policy description.", + "readOnly": true + }, + "scope": { + "type": "integer", + "format": "int64", + "description": "Binary OR value of the Snippet scope.", + "readOnly": true + } + }, + "description": "Policy description properties." + }, + "PolicyDescriptionCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyDescriptionContract" + }, + "description": "Descriptions of API Management policies." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + } + }, + "description": "Descriptions of API Management policies." + }, + "PolicyFragmentCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyFragmentContract" + }, + "description": "Policy fragment contract value." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "The response of the get policy fragments operation." + }, + "PolicyFragmentContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyFragmentContractProperties", + "description": "Properties of the Policy Fragment." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Policy fragment contract details." + }, + "PolicyFragmentContractProperties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Contents of the policy fragment." + }, + "description": { + "type": "string", + "description": "Policy fragment description.", + "minLength": 0, + "maxLength": 1000 + }, + "format": { + "type": "string", + "description": "Format of the policy fragment content.", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyFragmentContentFormat", + "modelAsString": true, + "values": [ + { + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + }, + "default": "xml" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state" + } + }, + "required": [ + "value" + ], + "description": "Policy fragment contract properties." + }, + "PolicyRestrictionCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyRestrictionContract" + } + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "The response of the get policy restrictions operation." + }, + "PolicyRestrictionUpdateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyRestrictionContractProperties", + "description": "Properties of the Policy Restriction." + } + }, + "description": "Policy restriction contract details." + }, + "PolicyRestrictionContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyRestrictionContractProperties", + "description": "Properties of the Policy Restriction." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Policy restriction contract details." + }, + "PolicyRestrictionContractProperties": { + "type": "object", + "properties": { + "scope": { + "type": "string", + "description": "Path to the policy document." + }, + "requireBase": { + "type": "string", + "description": "Indicates if base policy should be enforced for the policy document.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "PolicyRestrictionRequireBase", + "modelAsString": true, + "values": [ + { + "value": "true", + "description": "The policy is required to have base policy" + }, + { + "value": "false", + "description": "The policy does not require to have base policy" + } + ] + }, + "default": "false" + } + }, + "description": "Policy restrictions contract properties." + }, + "AllPoliciesCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AllPoliciesContract" + }, + "description": "AllPolicies Contract value." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "The response of All Policies." + }, + "AllPoliciesContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AllPoliciesContractProperties", + "description": "Properties of the All Policies." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "AllPolicies Contract details." + }, + "AllPoliciesContractProperties": { + "type": "object", + "properties": { + "referencePolicyId": { + "type": "string", + "description": "Policy Identifier" + }, + "complianceState": { + "type": "string", + "description": "Policy Restriction Compliance State", + "enum": [ + "Pending", + "NonCompliant", + "Compliant" + ], + "x-ms-enum": { + "name": "PolicyComplianceState", + "modelAsString": true, + "values": [ + { + "value": "Pending", + "description": "The policy restriction compliance state has not yet been determined." + }, + { + "value": "NonCompliant", + "description": "The scope in restriction is out of compliance." + }, + { + "value": "Compliant", + "description": "The scope in restriction is in compliance." + } + ] + }, + "default": "Pending" + } + }, + "description": "AllPolicies Properties." + }, + "ResourceCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "description": "A collection of resources." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "A collection of resources." + }, + "PortalConfigCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PortalConfigContract" + }, + "description": "The developer portal configurations." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "The collection of the developer portal configurations." + }, + "PortalConfigContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PortalConfigProperties", + "description": "The developer portal configuration contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "The developer portal configuration contract." + }, + "PortalConfigProperties": { + "type": "object", + "properties": { + "enableBasicAuth": { + "type": "boolean", + "description": "Enable or disable Basic authentication method.", + "default": true + }, + "signin": { + "type": "object", + "properties": { + "require": { + "type": "boolean", + "description": "Redirect anonymous users to the sign-in page.", + "default": false + } + } + }, + "signup": { + "type": "object", + "properties": { + "termsOfService": { + "type": "object", + "$ref": "#/definitions/PortalConfigTermsOfServiceProperties", + "description": "Terms of service settings." + } + } + }, + "delegation": { + "type": "object", + "$ref": "#/definitions/PortalConfigDelegationProperties", + "description": "The developer portal delegation settings." + }, + "cors": { + "type": "object", + "$ref": "#/definitions/PortalConfigCorsProperties", + "description": "The developer portal Cross-Origin Resource Sharing (CORS) settings." + }, + "csp": { + "type": "object", + "$ref": "#/definitions/PortalConfigCspProperties", + "description": "The developer portal Content Security Policy (CSP) settings." + } + }, + "description": "The developer portal configuration contract properties." + }, + "PortalConfigDelegationProperties": { + "type": "object", + "properties": { + "delegateRegistration": { + "type": "boolean", + "description": "Enable or disable delegation for user registration.", + "default": false + }, + "delegateSubscription": { + "type": "boolean", + "description": "Enable or disable delegation for product subscriptions.", + "default": false + }, + "delegationUrl": { + "type": "string", + "description": "A delegation endpoint URL." + }, + "validationKey": { + "x-ms-secret": true, + "type": "string", + "description": "A base64-encoded validation key to ensure requests originate from Azure API Management service." + } + } + }, + "PortalConfigTermsOfServiceProperties": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "A terms of service text." + }, + "requireConsent": { + "type": "boolean", + "description": "Ask user for consent to the terms of service.", + "default": false + } + }, + "description": "Terms of service contract properties." + }, + "PortalConfigCorsProperties": { + "type": "object", + "properties": { + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed origins, e.g. `https://trusted.com`." + } + }, + "description": "The developer portal Cross-Origin Resource Sharing (CORS) settings." + }, + "PortalConfigCspProperties": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "description": "The mode of the developer portal Content Security Policy (CSP).", + "enum": [ + "enabled", + "disabled", + "reportOnly" + ], + "default": "disabled", + "x-ms-enum": { + "modelAsString": true, + "name": "PortalSettingsCspMode", + "values": [ + { + "value": "enabled", + "description": "The browser will block requests not matching allowed origins." + }, + { + "value": "disabled", + "description": "The browser will not apply the origin restrictions." + }, + { + "value": "reportOnly", + "description": "The browser will report requests not matching allowed origins without blocking them." + } + ] + } + }, + "reportUri": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The URLs used by the browser to report CSP violations." + }, + "allowedSources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed sources, e.g. `*.trusted.com`, `trusted.com`, `https://`." + } + }, + "description": "The developer portal Content Security Policy (CSP) settings." + }, + "PortalDelegationSettings": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PortalDelegationSettingsProperties", + "description": "Delegation settings contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Delegation settings for a developer portal." + }, + "PortalDelegationSettingsProperties": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "A delegation Url." + }, + "validationKey": { + "x-ms-secret": true, + "type": "string", + "description": "A base64-encoded validation key to validate, that a request is coming from Azure API Management." + }, + "subscriptions": { + "$ref": "#/definitions/SubscriptionsDelegationSettingsProperties", + "description": "Subscriptions delegation settings." + }, + "userRegistration": { + "$ref": "#/definitions/RegistrationDelegationSettingsProperties", + "description": "User registration delegation settings." + } + }, + "description": "Delegation settings contract properties." + }, + "PortalSettingsCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PortalSettingsContract" + }, + "description": "Descriptions of API Management policies." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + } + }, + "description": "Descriptions of API Management policies." + }, + "PortalSettingsContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PortalSettingsContractProperties", + "description": "Portal Settings contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Portal Settings for the Developer Portal." + }, + "PortalSettingsContractProperties": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "A delegation Url." + }, + "validationKey": { + "x-ms-secret": true, + "type": "string", + "description": "A base64-encoded validation key to validate, that a request is coming from Azure API Management." + }, + "subscriptions": { + "$ref": "#/definitions/SubscriptionsDelegationSettingsProperties", + "description": "Subscriptions delegation settings." + }, + "userRegistration": { + "$ref": "#/definitions/RegistrationDelegationSettingsProperties", + "description": "User registration delegation settings." + }, + "enabled": { + "type": "boolean", + "description": "Redirect Anonymous users to the Sign-In page." + }, + "termsOfService": { + "type": "object", + "$ref": "#/definitions/TermsOfServiceProperties", + "description": "Terms of service contract properties." + } + }, + "description": "Sign-in settings contract properties." + }, + "PortalSigninSettingProperties": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Redirect Anonymous users to the Sign-In page." + } + }, + "description": "Sign-in settings contract properties." + }, + "PortalSigninSettings": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PortalSigninSettingProperties", + "description": "Sign-in settings contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Sign-In settings for the Developer Portal." + }, + "PortalSignupSettings": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PortalSignupSettingsProperties", + "description": "Sign-up settings contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Sign-Up settings for a developer portal." + }, + "PortalSignupSettingsProperties": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Allow users to sign up on a developer portal." + }, + "termsOfService": { + "type": "object", + "$ref": "#/definitions/TermsOfServiceProperties", + "description": "Terms of service contract properties." + } + }, + "description": "Sign-up settings contract properties." + }, + "ProductCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Products list representation." + }, + "ProductContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProductContractProperties", + "description": "Product entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Product details." + }, + "ProductContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Product name.", + "minLength": 1, + "maxLength": 300 + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProductEntityBaseParameters" + } + ], + "required": [ + "displayName" + ], + "description": "Product profile." + }, + "ProductEntityBaseParameters": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Product description. May include HTML formatting tags.", + "minLength": 0, + "maxLength": 1000 + }, + "terms": { + "type": "string", + "description": "Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process." + }, + "subscriptionRequired": { + "description": "Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.", + "type": "boolean" + }, + "approvalRequired": { + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.", + "type": "boolean" + }, + "subscriptionsLimit": { + "type": "integer", + "format": "int32", + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + }, + "state": { + "type": "string", + "description": "whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.", + "enum": [ + "notPublished", + "published" + ], + "x-ms-enum": { + "name": "ProductState", + "modelAsString": false + } + } + }, + "description": "Product Entity Base Parameters" + }, + "ProductTagResourceContractProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the product in the form of /products/{productId}" + }, + "name": { + "type": "string", + "description": "Product name.", + "minLength": 1, + "maxLength": 300 + } + }, + "allOf": [ + { + "$ref": "./definitions.json#/definitions/ProductEntityBaseParameters" + } + ], + "required": [ + "name" + ], + "description": "Product profile." + }, + "ProductUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProductUpdateProperties", + "description": "Product entity Update contract properties." + } + }, + "description": "Product Update parameters." + }, + "ProductUpdateProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Product name.", + "maxLength": 300, + "minLength": 1 + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProductEntityBaseParameters" + } + ], + "description": "Parameters supplied to the Update Product operation." + }, + "NamedValueCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NamedValueContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged NamedValue list representation." + }, + "NamedValueCreateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NamedValueCreateContractProperties", + "description": "NamedValue entity contract properties for PUT operation." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "NamedValue details." + }, + "NamedValueCreateContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + }, + "value": { + "type": "string", + "description": "Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "maxLength": 4096 + }, + "keyVault": { + "$ref": "#/definitions/KeyVaultContractCreateProperties", + "description": "KeyVault location details of the namedValue." + } + }, + "allOf": [ + { + "$ref": "#/definitions/NamedValueEntityBaseParameters" + } + ], + "required": [ + "displayName" + ], + "description": "NamedValue Contract properties." + }, + "NamedValueContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NamedValueContractProperties", + "description": "NamedValue entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "NamedValue details." + }, + "NamedValueContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + }, + "value": { + "type": "string", + "description": "Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "maxLength": 4096 + }, + "keyVault": { + "$ref": "#/definitions/KeyVaultContractProperties", + "description": "KeyVault location details of the namedValue." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state" + } + }, + "allOf": [ + { + "$ref": "#/definitions/NamedValueEntityBaseParameters" + } + ], + "required": [ + "displayName" + ], + "description": "NamedValue Contract properties." + }, + "NamedValueEntityBaseParameters": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "maxItems": 32, + "description": "Optional tags that when provided can be used to filter the NamedValue list." + }, + "secret": { + "description": "Determines whether the value is a secret and should be encrypted or not. Default value is false.", + "type": "boolean" + } + }, + "description": "NamedValue Entity Base Parameters set." + }, + "NamedValueUpdateParameterProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + }, + "value": { + "type": "string", + "description": "Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace.", + "minLength": 1, + "maxLength": 4096 + }, + "keyVault": { + "$ref": "#/definitions/KeyVaultContractCreateProperties", + "description": "KeyVault location details of the namedValue." + } + }, + "allOf": [ + { + "$ref": "#/definitions/NamedValueEntityBaseParameters" + } + ], + "description": "NamedValue Contract properties." + }, + "NamedValueUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NamedValueUpdateParameterProperties", + "description": "NamedValue entity Update contract properties." + } + }, + "description": "NamedValue update Parameters." + }, + "QuotaCounterCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/QuotaCounterContract" + }, + "x-ms-identifiers": [ + "counterKey", + "periodKey" + ], + "description": "Quota counter values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Quota Counter list representation." + }, + "QuotaCounterContract": { + "type": "object", + "properties": { + "counterKey": { + "type": "string", + "description": "The Key value of the Counter. Must not be empty.", + "minLength": 1 + }, + "periodKey": { + "type": "string", + "description": "Identifier of the Period for which the counter was collected. Must not be empty.", + "minLength": 1 + }, + "periodStartTime": { + "type": "string", + "format": "date-time", + "description": "The date of the start of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "periodEndTime": { + "type": "string", + "format": "date-time", + "description": "The date of the end of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "value": { + "$ref": "#/definitions/QuotaCounterValueContractProperties", + "description": "Quota Value Properties" + } + }, + "required": [ + "counterKey", + "periodKey", + "periodStartTime", + "periodEndTime" + ], + "description": "Quota counter details." + }, + "QuotaCounterValueContract": { + "type": "object", + "properties": { + "value": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuotaCounterValueContractProperties", + "description": "Quota counter Value Properties." + } + }, + "description": "Quota counter value details." + }, + "QuotaCounterValueContractProperties": { + "type": "object", + "properties": { + "callsCount": { + "type": "integer", + "format": "int32", + "description": "Number of times Counter was called." + }, + "kbTransferred": { + "type": "number", + "format": "double", + "description": "Data Transferred in KiloBytes." + } + }, + "description": "Quota counter value details." + }, + "QuotaCounterValueUpdateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuotaCounterValueContractProperties", + "description": "Quota counter value details." + } + }, + "description": "Quota counter value details." + }, + "RecipientEmailCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RecipientEmailContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Recipient User list representation." + }, + "RecipientEmailContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RecipientEmailContractProperties", + "description": "Recipient Email contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Recipient Email details." + }, + "RecipientEmailContractProperties": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "User Email subscribed to notification." + } + }, + "description": "Recipient Email Contract Properties." + }, + "RecipientsContractProperties": { + "type": "object", + "properties": { + "emails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Emails subscribed for the notification." + }, + "users": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Users subscribed for the notification." + } + }, + "description": "Notification Parameter contract." + }, + "RecipientUserCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RecipientUserContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Recipient User list representation." + }, + "RecipientUserContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RecipientUsersContractProperties", + "description": "Recipient User entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Recipient User details." + }, + "RecipientUsersContractProperties": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "API Management UserId subscribed to notification." + } + }, + "description": "Recipient User Contract Properties." + }, + "RegistrationDelegationSettingsProperties": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable delegation for user registration." + } + }, + "description": "User registration delegation settings properties." + }, + "ReportCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ReportRecordContract" + }, + "x-ms-identifiers": [ + "name", + "userId" + ], + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Report records list representation." + }, + "ReportRecordContract": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name depending on report endpoint specifies product, API, operation or developer name." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "interval": { + "type": "string", + "description": "Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." + }, + "country": { + "type": "string", + "description": "Country to which this record data is related." + }, + "region": { + "type": "string", + "description": "Country region to which this record data is related." + }, + "zip": { + "type": "string", + "description": "Zip code to which this record data is related." + }, + "userId": { + "readOnly": true, + "type": "string", + "description": "User identifier path. /users/{userId}" + }, + "productId": { + "readOnly": true, + "type": "string", + "description": "Product identifier path. /products/{productId}" + }, + "apiId": { + "type": "string", + "description": "API identifier path. /apis/{apiId}" + }, + "operationId": { + "type": "string", + "description": "Operation identifier path. /apis/{apiId}/operations/{operationId}" + }, + "apiRegion": { + "type": "string", + "description": "API region identifier." + }, + "subscriptionId": { + "type": "string", + "description": "Subscription identifier path. /subscriptions/{subscriptionId}" + }, + "callCountSuccess": { + "type": "integer", + "format": "int32", + "description": "Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" + }, + "callCountBlocked": { + "type": "integer", + "format": "int32", + "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" + }, + "callCountFailed": { + "type": "integer", + "format": "int32", + "description": "Number of calls failed due to gateway or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600" + }, + "callCountOther": { + "type": "integer", + "format": "int32", + "description": "Number of other calls." + }, + "callCountTotal": { + "type": "integer", + "format": "int32", + "description": "Total number of calls." + }, + "bandwidth": { + "type": "integer", + "format": "int64", + "description": "Bandwidth consumed." + }, + "cacheHitCount": { + "type": "integer", + "format": "int32", + "description": "Number of times when content was served from cache policy." + }, + "cacheMissCount": { + "type": "integer", + "format": "int32", + "description": "Number of times content was fetched from backend." + }, + "apiTimeAvg": { + "type": "number", + "format": "double", + "description": "Average time it took to process request." + }, + "apiTimeMin": { + "type": "number", + "format": "double", + "description": "Minimum time it took to process request." + }, + "apiTimeMax": { + "type": "number", + "format": "double", + "description": "Maximum time it took to process request." + }, + "serviceTimeAvg": { + "type": "number", + "format": "double", + "description": "Average time it took to process request on backend." + }, + "serviceTimeMin": { + "type": "number", + "format": "double", + "description": "Minimum time it took to process request on backend." + }, + "serviceTimeMax": { + "type": "number", + "format": "double", + "description": "Maximum time it took to process request on backend." + } + }, + "description": "Report data." + }, + "RepresentationContract": { + "type": "object", + "properties": { + "contentType": { + "type": "string", + "description": "Specifies a registered or custom content type for this representation, e.g. application/xml." + }, + "schemaId": { + "type": "string", + "description": "Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." + }, + "typeName": { + "type": "string", + "description": "Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." + }, + "formParameters": { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "description": "Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.." + }, + "examples": { + "$ref": "#/definitions/ParameterExamplesContract", + "description": "Exampled defined for the representation." + } + }, + "required": [ + "contentType" + ], + "description": "Operation request/response representation details." + }, + "RequestContract": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Operation request description." + }, + "queryParameters": { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "description": "Collection of operation request query parameters." + }, + "headers": { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "description": "Collection of operation request headers." + }, + "representations": { + "type": "array", + "items": { + "$ref": "#/definitions/RepresentationContract" + }, + "x-ms-identifiers": [], + "description": "Collection of operation request representations." + } + }, + "description": "Operation request details." + }, + "RequestReportCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestReportRecordContract" + }, + "x-ms-identifiers": [ + "url" + ], + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + } + }, + "description": "Paged Report records list representation." + }, + "RequestReportRecordContract": { + "type": "object", + "properties": { + "apiId": { + "type": "string", + "description": "API identifier path. /apis/{apiId}" + }, + "operationId": { + "type": "string", + "description": "Operation identifier path. /apis/{apiId}/operations/{operationId}" + }, + "productId": { + "readOnly": true, + "type": "string", + "description": "Product identifier path. /products/{productId}" + }, + "userId": { + "readOnly": true, + "type": "string", + "description": "User identifier path. /users/{userId}" + }, + "method": { + "type": "string", + "description": "The HTTP method associated with this request.." + }, + "url": { + "type": "string", + "description": "The full URL associated with this request." + }, + "ipAddress": { + "type": "string", + "description": "The client IP address associated with this request." + }, + "backendResponseCode": { + "type": "string", + "description": "The HTTP status code received by the gateway as a result of forwarding this request to the backend." + }, + "responseCode": { + "type": "integer", + "format": "int32", + "description": "The HTTP status code returned by the gateway." + }, + "responseSize": { + "type": "integer", + "format": "int32", + "description": "The size of the response returned by the gateway." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when this request was received by the gateway in ISO 8601 format." + }, + "cache": { + "type": "string", + "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend." + }, + "apiTime": { + "type": "number", + "format": "double", + "description": "The total time it took to process this request." + }, + "serviceTime": { + "type": "number", + "format": "double", + "description": "he time it took to forward this request to the backend and get the response back." + }, + "apiRegion": { + "type": "string", + "description": "Azure region where the gateway that processed this request is located." + }, + "subscriptionId": { + "type": "string", + "description": "Subscription identifier path. /subscriptions/{subscriptionId}" + }, + "requestId": { + "type": "string", + "description": "Request Identifier." + }, + "requestSize": { + "type": "integer", + "format": "int32", + "description": "The size of this request.." + } + }, + "description": "Request Report data." + }, + "ResolverCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResolverContract" + }, + "description": "Page values.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Resolver list representation." + }, + "ResolverContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResolverEntityBaseContract", + "description": "Properties of the Resolver Contract." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "GraphQL API Resolver details." + }, + "ResolverEntityBaseContract": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Resolver Name.", + "minLength": 1, + "maxLength": 300 + }, + "path": { + "type": "string", + "description": "Path is type/field being resolved.", + "minLength": 1, + "maxLength": 300 + }, + "description": { + "type": "string", + "description": "Description of the resolver. May include HTML formatting tags.", + "maxLength": 1000 + } + }, + "description": "GraphQL API Resolver Entity Base Contract details." + }, + "ResolverResultContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResolverResultContractProperties", + "description": "Properties of the Resolver Contract." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Long Running Git Resolver Results." + }, + "ResolverResultContractProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resolver result identifier." + }, + "status": { + "type": "string", + "description": "Status of an async resolver.", + "enum": [ + "Started", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncResolverStatus", + "modelAsString": false + } + }, + "started": { + "type": "string", + "format": "date-time", + "description": "Start time of an async resolver. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "updated": { + "type": "string", + "format": "date-time", + "description": "Last update time of an async resolver. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "resultInfo": { + "type": "string", + "description": "Optional result info." + }, + "error": { + "$ref": "./apimanagement.json#/definitions/ErrorResponseBody", + "description": "Error Body Contract" + }, + "actionLog": { + "type": "array", + "items": { + "$ref": "#/definitions/ResolverResultLogItemContract" + }, + "x-ms-identifiers": [ + "objectKey" + ], + "readOnly": true, + "description": "This property if only provided as part of the TenantConfiguration_Validate resolver. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy resolver." + } + }, + "description": "Resolver Result." + }, + "ResolverResultLogItemContract": { + "type": "object", + "properties": { + "objectType": { + "type": "string", + "description": "The type of entity contract." + }, + "action": { + "type": "string", + "description": "Action like create/update/delete." + }, + "objectKey": { + "type": "string", + "description": "Identifier of the entity being created/updated/deleted." + } + }, + "description": "Log of the entity being created, updated or deleted." + }, + "ResolverUpdateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResolverUpdateContractProperties", + "description": "Properties of the GraphQL API Resolver entity that can be updated." + } + }, + "description": "GraphQL API Resolver Update Contract details." + }, + "ResolverUpdateContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Resolver Name.", + "minLength": 1, + "maxLength": 300 + }, + "path": { + "type": "string", + "description": "Path is type/field being resolved.", + "minLength": 1, + "maxLength": 300 + }, + "description": { + "type": "string", + "description": "Description of the resolver. May include HTML formatting tags.", + "maxLength": 1000 + } + }, + "description": "Resolver Update Contract Properties." + }, + "ResponseContract": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer", + "format": "int32", + "description": "Operation response HTTP status code." + }, + "description": { + "type": "string", + "description": "Operation response description." + }, + "representations": { + "type": "array", + "items": { + "$ref": "#/definitions/RepresentationContract" + }, + "x-ms-identifiers": [], + "description": "Collection of operation response representations." + }, + "headers": { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "description": "Collection of operation response headers." + } + }, + "required": [ + "statusCode" + ], + "description": "Operation response details." + }, + "SamplingSettings": { + "type": "object", + "properties": { + "samplingType": { + "type": "string", + "description": "Sampling type.", + "enum": [ + "fixed" + ], + "x-ms-enum": { + "name": "SamplingType", + "modelAsString": true, + "values": [ + { + "value": "fixed", + "description": "Fixed-rate sampling." + } + ] + } + }, + "percentage": { + "type": "number", + "format": "double", + "minimum": 0, + "maximum": 100, + "description": "Rate of sampling for fixed-rate sampling." + } + }, + "description": "Sampling settings for Diagnostic." + }, + "SaveConfigurationParameter": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SaveConfigurationParameterProperties", + "description": "Properties of the Save Configuration Parameters." + } + }, + "description": "Save Tenant Configuration Contract details." + }, + "SaveConfigurationParameterProperties": { + "type": "object", + "properties": { + "branch": { + "type": "string", + "description": "The name of the Git branch in which to commit the current configuration snapshot." + }, + "force": { + "type": "boolean", + "description": "The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten." + } + }, + "required": [ + "branch" + ], + "description": "Parameters supplied to the Save Tenant Configuration operation." + }, + "SchemaCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SchemaContract" + }, + "description": "API Schema Contract value.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "The response of the list schema operation." + }, + "SchemaContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SchemaContractProperties", + "description": "Properties of the API Schema." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "API Schema Contract details." + }, + "SchemaContractProperties": { + "type": "object", + "properties": { + "contentType": { + "type": "string", + "description": "Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`." + }, + "document": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SchemaDocumentProperties", + "description": "Create or update Properties of the API Schema Document." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state" + } + }, + "required": [ + "contentType", + "document" + ], + "description": "API Schema create or update contract Properties." + }, + "SchemaDocumentProperties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI." + }, + "definitions": { + "type": "object", + "description": "Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise." + }, + "components": { + "type": "object", + "description": "Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise." + } + }, + "description": "Api Schema Document Properties." + }, + "GlobalSchemaCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GlobalSchemaContract" + }, + "description": "Global Schema Contract value.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "The response of the list schema operation." + }, + "GlobalSchemaContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GlobalSchemaContractProperties", + "description": "Properties of the Global Schema." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Global Schema Contract details." + }, + "GlobalSchemaContractProperties": { + "type": "object", + "properties": { + "schemaType": { + "type": "string", + "description": "Schema Type. Immutable.", + "enum": [ + "xml", + "json" + ], + "x-ms-client-name": "SchemaType", + "x-ms-enum": { + "name": "SchemaType", + "modelAsString": true, + "values": [ + { + "value": "xml", + "description": "XML schema type.", + "name": "Xml" + }, + { + "value": "json", + "description": "Json schema type.", + "name": "Json" + } + ] + } + }, + "description": { + "type": "string", + "description": "Free-form schema entity description." + }, + "value": { + "description": "Json-encoded string for non json-based schema." + }, + "document": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GlobalSchemaDocumentProperties", + "description": "Global Schema document object for json-based schema formats(e.g. json schema)." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state" + } + }, + "required": [ + "schemaType" + ], + "description": "Schema create or update contract Properties." + }, + "GlobalSchemaDocumentProperties": { + "type": "object", + "description": "Global Schema Document Properties." + }, + "SubscriptionCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Subscriptions list representation." + }, + "SubscriptionContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionContractProperties", + "description": "Subscription contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Subscription details." + }, + "SubscriptionContractProperties": { + "type": "object", + "properties": { + "ownerId": { + "type": "string", + "description": "The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier." + }, + "scope": { + "type": "string", + "description": "Scope like /products/{productId} or /apis or /apis/{apiId}." + }, + "displayName": { + "type": "string", + "description": "The name of the subscription, or null if the subscription has no name.", + "minLength": 0, + "maxLength": 100 + }, + "state": { + "type": "string", + "description": "Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.", + "enum": [ + "suspended", + "active", + "expired", + "submitted", + "rejected", + "cancelled" + ], + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": false + } + }, + "createdDate": { + "type": "string", + "format": "date-time", + "description": "Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n", + "readOnly": true + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "notificationDate": { + "type": "string", + "format": "date-time", + "description": "Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "primaryKey": { + "x-ms-secret": true, + "type": "string", + "description": "Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "minLength": 1, + "maxLength": 256 + }, + "secondaryKey": { + "x-ms-secret": true, + "type": "string", + "description": "Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "minLength": 1, + "maxLength": 256 + }, + "stateComment": { + "type": "string", + "description": "Optional subscription comment added by an administrator when the state is changed to the 'rejected'." + }, + "allowTracing": { + "type": "boolean", + "description": "Determines whether tracing is enabled", + "x-apim-code-nillable": true + } + }, + "required": [ + "scope", + "state" + ], + "description": "Subscription details." + }, + "SubscriptionCreateParameterProperties": { + "type": "object", + "properties": { + "ownerId": { + "type": "string", + "description": "User (user id path) for whom subscription is being created in form /users/{userId}" + }, + "scope": { + "type": "string", + "description": "Scope like /products/{productId} or /apis or /apis/{apiId}." + }, + "displayName": { + "type": "string", + "description": "Subscription name.", + "minLength": 1, + "maxLength": 100 + }, + "primaryKey": { + "type": "string", + "description": "Primary subscription key. If not specified during request key will be generated automatically.", + "minLength": 1, + "maxLength": 256 + }, + "secondaryKey": { + "type": "string", + "description": "Secondary subscription key. If not specified during request key will be generated automatically.", + "minLength": 1, + "maxLength": 256 + }, + "state": { + "type": "string", + "description": "Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.", + "enum": [ + "suspended", + "active", + "expired", + "submitted", + "rejected", + "cancelled" + ], + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": false + } + }, + "allowTracing": { + "type": "boolean", + "description": "Determines whether tracing can be enabled" + } + }, + "required": [ + "scope", + "displayName" + ], + "description": "Parameters supplied to the Create subscription operation." + }, + "SubscriptionCreateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionCreateParameterProperties", + "description": "Subscription contract properties." + } + }, + "description": "Subscription create details." + }, + "SubscriptionKeyParameterNamesContract": { + "type": "object", + "properties": { + "header": { + "type": "string", + "description": "Subscription key header name." + }, + "query": { + "type": "string", + "description": "Subscription key query string parameter name." + } + }, + "description": "Subscription key parameter names details.", + "example": { + "subscriptionKeyParameterNames": { + "query": "customQueryParameterName", + "header": "customHeaderParameterName" + } + } + }, + "SubscriptionsDelegationSettingsProperties": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable delegation for subscriptions." + } + }, + "description": "Subscriptions delegation settings properties." + }, + "SubscriptionUpdateParameterProperties": { + "type": "object", + "properties": { + "ownerId": { + "type": "string", + "description": "User identifier path: /users/{userId}" + }, + "scope": { + "type": "string", + "description": "Scope like /products/{productId} or /apis or /apis/{apiId}" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "displayName": { + "type": "string", + "description": "Subscription name." + }, + "primaryKey": { + "type": "string", + "description": "Primary subscription key.", + "minLength": 1, + "maxLength": 256 + }, + "secondaryKey": { + "type": "string", + "description": "Secondary subscription key.", + "minLength": 1, + "maxLength": 256 + }, + "state": { + "type": "string", + "description": "Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.", + "enum": [ + "suspended", + "active", + "expired", + "submitted", + "rejected", + "cancelled" + ], + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": false + } + }, + "stateComment": { + "type": "string", + "description": "Comments describing subscription state change by the administrator when the state is changed to the 'rejected'." + }, + "allowTracing": { + "type": "boolean", + "description": "Determines whether tracing can be enabled" + } + }, + "description": "Parameters supplied to the Update subscription operation." + }, + "SubscriptionUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionUpdateParameterProperties", + "description": "Subscription Update contract properties." + } + }, + "description": "Subscription update details." + }, + "TagCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Tag list representation." + }, + "TagContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagContractProperties", + "description": "Tag entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Tag Contract details." + }, + "TagContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Tag name.", + "maxLength": 160, + "minLength": 1 + } + }, + "required": [ + "displayName" + ], + "description": "Tag contract Properties." + }, + "TagCreateUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagContractProperties", + "description": "Properties supplied to Create Tag operation." + } + }, + "description": "Parameters supplied to Create/Update Tag operations." + }, + "TagDescriptionBaseProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the Tag." + }, + "externalDocsUrl": { + "type": "string", + "description": "Absolute URL of external resources describing the tag.", + "maxLength": 2000 + }, + "externalDocsDescription": { + "type": "string", + "description": "Description of the external resources describing the tag." + } + }, + "description": "Parameters supplied to the Create TagDescription operation." + }, + "TagDescriptionCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagDescriptionContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged TagDescription list representation." + }, + "TagDescriptionContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagDescriptionContractProperties", + "description": "TagDescription entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Contract details." + }, + "TagDescriptionContractProperties": { + "type": "object", + "properties": { + "tagId": { + "type": "string", + "description": "Identifier of the tag in the form of /tags/{tagId}" + }, + "displayName": { + "type": "string", + "description": "Tag name.", + "maxLength": 160, + "minLength": 1 + } + }, + "allOf": [ + { + "$ref": "#/definitions/TagDescriptionBaseProperties" + } + ], + "description": "TagDescription contract Properties." + }, + "TagDescriptionCreateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagDescriptionBaseProperties", + "description": "Properties supplied to Create TagDescription operation." + } + }, + "description": "Parameters supplied to the Create TagDescription operation." + }, + "TagResourceCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagResourceContract" + }, + "x-ms-identifiers": [ + "tag/id" + ], + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Tag list representation." + }, + "TagResourceContract": { + "type": "object", + "properties": { + "tag": { + "$ref": "#/definitions/TagTagResourceContractProperties", + "description": "Tag associated with the resource." + }, + "api": { + "$ref": "#/definitions/ApiTagResourceContractProperties", + "description": "API associated with the tag." + }, + "operation": { + "$ref": "#/definitions/OperationTagResourceContractProperties", + "description": "Operation associated with the tag." + }, + "product": { + "$ref": "#/definitions/ProductTagResourceContractProperties", + "description": "Product associated with the tag." + } + }, + "required": [ + "tag" + ], + "description": "TagResource contract properties." + }, + "TagTagResourceContractProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Tag identifier" + }, + "name": { + "type": "string", + "description": "Tag Name", + "minLength": 1, + "maxLength": 160 + } + }, + "description": "Contract defining the Tag property in the Tag Resource Contract" + }, + "TenantConfigurationSyncStateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TenantConfigurationSyncStateContractProperties", + "description": "Properties returned Tenant Configuration Sync State check." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Result of Tenant Configuration Sync State." + }, + "TenantConfigurationSyncStateContractProperties": { + "type": "object", + "properties": { + "branch": { + "type": "string", + "description": "The name of Git branch." + }, + "commitId": { + "type": "string", + "description": "The latest commit Id." + }, + "isExport": { + "type": "boolean", + "description": "value indicating if last sync was save (true) or deploy (false) operation." + }, + "isSynced": { + "type": "boolean", + "description": "value indicating if last synchronization was later than the configuration change." + }, + "isGitEnabled": { + "type": "boolean", + "description": "value indicating whether Git configuration access is enabled." + }, + "syncDate": { + "type": "string", + "format": "date-time", + "description": "The date of the latest synchronization. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "configurationChangeDate": { + "type": "string", + "format": "date-time", + "description": "The date of the latest configuration change. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "lastOperationId": { + "type": "string", + "description": "Most recent tenant configuration operation identifier" + } + }, + "description": "Tenant Configuration Synchronization State." + }, + "TermsOfServiceProperties": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "A terms of service text." + }, + "enabled": { + "type": "boolean", + "description": "Display terms of service during a sign-up process." + }, + "consentRequired": { + "type": "boolean", + "description": "Ask user for consent to the terms of service." + } + }, + "description": "Terms of service contract properties." + }, + "TokenBodyParameterContract": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "body parameter name." + }, + "value": { + "type": "string", + "description": "body parameter value." + } + }, + "required": [ + "name", + "value" + ], + "description": "OAuth acquire token request body parameter (www-url-form-encoded)." + }, + "UserCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UserContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Users list representation." + }, + "UserContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserContractProperties", + "description": "User entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "User details." + }, + "UserContractProperties": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "First name." + }, + "lastName": { + "type": "string", + "description": "Last name." + }, + "email": { + "type": "string", + "description": "Email address." + }, + "registrationDate": { + "type": "string", + "format": "date-time", + "description": "Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "groups": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./definitions.json#/definitions/GroupContractProperties" + }, + "x-ms-identifiers": [ + "displayName" + ], + "description": "Collection of groups user is part of." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UserEntityBaseParameters" + } + ], + "description": "User profile." + }, + "UserCreateParameterProperties": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "Email address. Must not be empty and must be unique within the service instance.", + "minLength": 1, + "maxLength": 254 + }, + "firstName": { + "type": "string", + "description": "First name.", + "minLength": 1, + "maxLength": 100 + }, + "lastName": { + "type": "string", + "description": "Last name.", + "minLength": 1, + "maxLength": 100 + }, + "password": { + "type": "string", + "description": "User Password. If no value is provided, a default password is generated." + }, + "appType": { + "type": "string", + "description": "Determines the type of application which send the create user request. Default is legacy portal.", + "enum": [ + "portal", + "developerPortal" + ], + "x-ms-enum": { + "name": "AppType", + "modelAsString": true, + "values": [ + { + "value": "portal", + "description": "User create request was sent by legacy developer portal." + }, + { + "value": "developerPortal", + "description": "User create request was sent by new developer portal." + } + ] + } + }, + "confirmation": { + "type": "string", + "description": "Determines the type of confirmation e-mail that will be sent to the newly created user.", + "enum": [ + "signup", + "invite" + ], + "x-ms-enum": { + "name": "Confirmation", + "modelAsString": true, + "values": [ + { + "value": "signup", + "description": "Send an e-mail to the user confirming they have successfully signed up." + }, + { + "value": "invite", + "description": "Send an e-mail inviting the user to sign-up and complete registration." + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/UserEntityBaseParameters" + } + ], + "required": [ + "email", + "firstName", + "lastName" + ], + "description": "Parameters supplied to the Create User operation." + }, + "UserCreateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserCreateParameterProperties", + "description": "User entity create contract properties." + } + }, + "description": "User create details." + }, + "UserEntityBaseParameters": { + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.", + "enum": [ + "active", + "blocked", + "pending", + "deleted" + ], + "default": "active", + "x-ms-enum": { + "name": "UserState", + "modelAsString": true, + "values": [ + { + "value": "active", + "description": "User state is active." + }, + { + "value": "blocked", + "description": "User is blocked. Blocked users cannot authenticate at developer portal or call API." + }, + { + "value": "pending", + "description": "User account is pending. Requires identity confirmation before it can be made active." + }, + { + "value": "deleted", + "description": "User account is closed. All identities and related entities are removed." + } + ] + } + }, + "note": { + "type": "string", + "description": "Optional note about a user set by the administrator." + }, + "identities": { + "type": "array", + "items": { + "$ref": "#/definitions/UserIdentityContract" + }, + "description": "Collection of user identities." + } + }, + "description": "User Entity Base Parameters set." + }, + "UserIdentityCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UserIdentityContract" + }, + "description": "User Identity values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "List of Users Identity list representation." + }, + "UserIdentityContract": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "Identity provider name." + }, + "id": { + "type": "string", + "description": "Identifier value within provider." + } + }, + "description": "User identity details." + }, + "UserTokenParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserTokenParameterProperties", + "description": "User Token Parameter contract properties." + } + }, + "description": "Get User Token parameters." + }, + "UserTokenParameterProperties": { + "type": "object", + "properties": { + "keyType": { + "type": "string", + "description": "The Key to be used to generate token for user.", + "enum": [ + "primary", + "secondary" + ], + "default": "primary", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "expiry": { + "type": "string", + "format": "date-time", + "description": "The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + } + }, + "required": [ + "keyType", + "expiry" + ], + "description": "Parameters supplied to the Get User Token operation." + }, + "UserTokenResult": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Shared Access Authorization token for the User." + } + }, + "description": "Get User Token response details." + }, + "UserUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserUpdateParametersProperties", + "description": "User entity update contract properties." + } + }, + "description": "User update parameters." + }, + "UserUpdateParametersProperties": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "Email address. Must not be empty and must be unique within the service instance.", + "minLength": 1, + "maxLength": 254 + }, + "password": { + "type": "string", + "description": "User Password." + }, + "firstName": { + "type": "string", + "description": "First name.", + "minLength": 1, + "maxLength": 100 + }, + "lastName": { + "type": "string", + "description": "Last name.", + "minLength": 1, + "maxLength": 100 + } + }, + "allOf": [ + { + "$ref": "#/definitions/UserEntityBaseParameters" + } + ], + "description": "Parameters supplied to the Update User operation." + }, + "X509CertificateName": { + "type": "object", + "properties": { + "name": { + "description": "Common Name of the Certificate.", + "type": "string" + }, + "issuerCertificateThumbprint": { + "description": "Thumbprint for the Issuer of the Certificate.", + "type": "string" + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-windows-cluster-x509-security" + }, + "description": "Properties of server X509Names." + }, + "ClientSecretContract": { + "type": "object", + "properties": { + "clientSecret": { + "type": "string", + "x-ms-secret": true, + "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth." + } + }, + "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth." + }, + "NamedValueSecretContract": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "This is secret value of the NamedValue entity." + } + }, + "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth." + }, + "PortalSettingValidationKeyContract": { + "type": "object", + "properties": { + "validationKey": { + "type": "string", + "x-ms-secret": true, + "description": "This is secret value of the validation key in portal settings." + } + }, + "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth." + }, + "SubscriptionKeysContract": { + "type": "object", + "properties": { + "primaryKey": { + "type": "string", + "description": "Subscription primary key.", + "minLength": 1, + "maxLength": 256 + }, + "secondaryKey": { + "type": "string", + "description": "Subscription secondary key.", + "minLength": 1, + "maxLength": 256 + } + }, + "description": "Subscription keys." + }, + "GatewayCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayContract" + }, + "description": "Page values.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Gateway list representation." + }, + "GatewayContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GatewayContractProperties", + "description": "Gateway details." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Gateway details." + }, + "GatewayContractProperties": { + "type": "object", + "properties": { + "locationData": { + "$ref": "#/definitions/ResourceLocationDataContract", + "description": "Gateway location." + }, + "description": { + "type": "string", + "description": "Gateway description", + "maxLength": 1000 + } + }, + "description": "Properties of the Gateway contract." + }, + "WorkspaceLinksBaseProperties": { + "type": "object", + "properties": { + "workspaceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ApiManagement/service/workspaces" + } + ] + }, + "description": "The link to the API Management service workspace." + }, + "gateways": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceLinksGateway" + }, + "description": "The array of linked gateways." + } + } + }, + "WorkspaceLinksGateway": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ApiManagement/gateways" + } + ] + }, + "description": "The link to the API Management gateway." + } + } + }, + "ApiManagementWorkspaceLinksProperties": { + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "#/definitions/WorkspaceLinksBaseProperties" + } + ], + "description": "Properties of an API Management workspaceLinks resource." + }, + "ApiManagementWorkspaceLinksResource": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiManagementWorkspaceLinksProperties", + "description": "Properties of the API Management WorkspaceLinks." + }, + "etag": { + "type": "string", + "description": "ETag of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "description": "A single API Management WorkspaceLinks in List or Get response." + }, + "ApiManagementWorkspaceLinksListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiManagementWorkspaceLinksResource" + }, + "description": "Result of the List API Management WorkspaceLinks operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." + } + }, + "required": [ + "value" + ], + "description": "The response of the List API Management WorkspaceLink operation." + }, + "ResourceLocationDataContract": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "A canonical name for the geographic or physical location.", + "maxLength": 256 + }, + "city": { + "type": "string", + "description": "The city or locality where the resource is located.", + "maxLength": 256 + }, + "district": { + "type": "string", + "description": "The district, state, or province where the resource is located.", + "maxLength": 256 + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region where the resource is located.", + "maxLength": 256 + } + }, + "required": [ + "name" + ], + "description": "Resource location data properties." + }, + "GatewayKeysContract": { + "type": "object", + "properties": { + "primary": { + "type": "string", + "description": "Primary gateway key." + }, + "secondary": { + "type": "string", + "description": "Secondary gateway key." + } + }, + "description": "Gateway authentication keys." + }, + "GatewayTokenRequestContract": { + "type": "object", + "properties": { + "keyType": { + "type": "string", + "description": "The Key to be used to generate gateway token.", + "enum": [ + "primary", + "secondary" + ], + "default": "primary", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "expiry": { + "type": "string", + "format": "date-time", + "description": "The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + } + }, + "required": [ + "keyType", + "expiry" + ], + "description": "Gateway token request contract properties." + }, + "GatewayTokenContract": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Shared Access Authentication token value for the Gateway." + } + }, + "description": "Gateway access token." + }, + "GatewayKeyRegenerationRequestContract": { + "type": "object", + "properties": { + "keyType": { + "type": "string", + "description": "The Key being regenerated.", + "enum": [ + "primary", + "secondary" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + } + }, + "required": [ + "keyType" + ], + "description": "Gateway key regeneration request contract properties." + }, + "GatewayHostnameConfigurationCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayHostnameConfigurationContract" + }, + "description": "Page values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Gateway hostname configuration list representation." + }, + "GatewayHostnameConfigurationContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GatewayHostnameConfigurationContractProperties", + "description": "Gateway hostname configuration details." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Gateway hostname configuration details." + }, + "GatewayHostnameConfigurationContractProperties": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Hostname value. Supports valid domain name, partial or full wildcard" + }, + "certificateId": { + "type": "string", + "description": "Identifier of Certificate entity that will be used for TLS connection establishment" + }, + "negotiateClientCertificate": { + "type": "boolean", + "description": "Determines whether gateway requests client certificate" + }, + "tls10Enabled": { + "type": "boolean", + "description": "Specifies if TLS 1.0 is supported" + }, + "tls11Enabled": { + "type": "boolean", + "description": "Specifies if TLS 1.1 is supported" + }, + "http2Enabled": { + "type": "boolean", + "description": "Specifies if HTTP/2.0 is supported" + } + }, + "description": "Gateway hostname configuration details." + }, + "GatewayCertificateAuthorityCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayCertificateAuthorityContract" + }, + "description": "Page values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Gateway certificate authority list representation." + }, + "GatewayCertificateAuthorityContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GatewayCertificateAuthorityContractProperties", + "description": "Gateway certificate authority details." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Gateway certificate authority details." + }, + "GatewayCertificateAuthorityContractProperties": { + "type": "object", + "properties": { + "isTrusted": { + "type": "boolean", + "description": "Determines whether certificate authority is trusted." + } + }, + "description": "Gateway certificate authority details." + }, + "AssociationContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "type": "string", + "description": "Provisioning state.", + "enum": [ + "created" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + } + }, + "description": "Association entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Association entity details." + }, + "ContentTypeCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentTypeContract" + }, + "description": "Collection of content types.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link, if any.", + "readOnly": true + } + }, + "description": "Paged list of content types." + }, + "ContentTypeContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContentTypeContractProperties", + "description": "Properties of the content type." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Content type contract details." + }, + "ContentTypeContractProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Content type identifier" + }, + "name": { + "type": "string", + "description": "Content type name. Must be 1 to 250 characters long." + }, + "description": { + "type": "string", + "description": "Content type description." + }, + "schema": { + "type": "object", + "description": "Content type schema." + }, + "version": { + "type": "string", + "description": "Content type version." + } + } + }, + "ContentItemCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentItemContract" + }, + "description": "Collection of content items.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link, if any.", + "readOnly": true + } + }, + "description": "Paged list of content items." + }, + "ContentItemContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContentItemContractProperties", + "description": "Properties of the content item." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Content type contract details." + }, + "ContentItemContractProperties": { + "properties": {}, + "additionalProperties": true + }, + "DeletedServicesCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedServiceContract" + }, + "description": "Page values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged deleted API Management Services List Representation." + }, + "DeletedServiceContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeletedServiceContractProperties", + "description": "Deleted API Management Service details." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "API Management Service Master Location." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Deleted API Management Service information." + }, + "DeletedServiceContractProperties": { + "type": "object", + "properties": { + "serviceId": { + "type": "string", + "description": "Fully-qualified API Management Service Resource ID" + }, + "scheduledPurgeDate": { + "type": "string", + "format": "date-time", + "description": "UTC Date and Time when the service will be automatically purged. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." + }, + "deletionDate": { + "type": "string", + "format": "date-time", + "description": "UTC Timestamp when the service was soft-deleted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." + } + } + }, + "PortalRevisionCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PortalRevisionContract" + }, + "description": "Collection of portal revisions.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link, if any.", + "readOnly": true + } + }, + "description": "Paged list of portal revisions." + }, + "PortalRevisionContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PortalRevisionContractProperties", + "description": "Properties of the portal revisions." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Portal Revision's contract details." + }, + "PortalRevisionContractProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Portal revision description.", + "maxLength": 2000 + }, + "statusDetails": { + "type": "string", + "description": "Portal revision publishing status details.", + "maxLength": 2000, + "readOnly": true + }, + "status": { + "type": "string", + "description": "Status of the portal's revision.", + "enum": [ + "pending", + "publishing", + "completed", + "failed" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "portalRevisionStatus", + "values": [ + { + "value": "pending", + "description": "Portal's revision has been queued." + }, + { + "value": "publishing", + "description": "Portal's revision is being published." + }, + { + "value": "completed", + "description": "Portal's revision publishing completed." + }, + { + "value": "failed", + "description": "Portal's revision publishing failed." + } + ] + }, + "readOnly": true + }, + "isCurrent": { + "type": "boolean", + "description": "Indicates if the portal's revision is public." + }, + "createdDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Portal's revision creation date and time." + }, + "updatedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Last updated date and time." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state" + } + } + }, + "PrivateEndpointConnectionRequest": { + "description": "A request to approve or reject a private endpoint connection", + "type": "object", + "properties": { + "id": { + "description": "Private Endpoint Connection Resource Id.", + "type": "string" + }, + "properties": { + "type": "object", + "description": "The connection state of the private endpoint connection.", + "properties": { + "privateLinkServiceConnectionState": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + } + } + } + }, + "RemotePrivateEndpointConnectionWrapper": { + "description": "Remote Private Endpoint Connection resource.", + "type": "object", + "properties": { + "id": { + "description": "Private Endpoint connection resource id", + "type": "string" + }, + "name": { + "description": "Private Endpoint Connection Name", + "type": "string" + }, + "type": { + "description": "Private Endpoint Connection Resource Type", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionWrapperProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + } + }, + "PrivateEndpointConnectionWrapperProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/ArmIdWrapper", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the private endpoint connection resource." + }, + "groupIds": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "All the Group ids." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties.", + "type": "object" + }, + "ArmIdWrapper": { + "description": "A wrapper for an ARM resource id", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true + } + } + }, + "ConnectivityCheckRequest": { + "description": "A request to perform the connectivity check operation on a API Management service.", + "type": "object", + "required": [ + "source", + "destination" + ], + "properties": { + "source": { + "description": "Definitions about the connectivity check origin.", + "type": "object", + "required": [ + "region" + ], + "properties": { + "region": { + "description": "The API Management service region from where to start the connectivity check operation.", + "type": "string", + "example": "westus" + }, + "instance": { + "description": "The particular VMSS instance from which to fire the request.", + "type": "integer", + "format": "int64" + } + } + }, + "destination": { + "description": "The connectivity check operation destination.", + "type": "object", + "required": [ + "address", + "port" + ], + "properties": { + "address": { + "description": "Destination address. Can either be an IP address or a FQDN.", + "type": "string", + "example": "microsoft.com" + }, + "port": { + "description": "Destination port.", + "type": "integer", + "format": "int64", + "example": 80 + } + } + }, + "preferredIPVersion": { + "description": "The IP version to be used. Only IPv4 is supported for now.", + "type": "string", + "enum": [ + "IPv4" + ], + "x-ms-enum": { + "name": "PreferredIPVersion", + "modelAsString": true + } + }, + "protocol": { + "description": "The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value.", + "type": "string", + "enum": [ + "TCP", + "HTTP", + "HTTPS" + ], + "x-ms-enum": { + "name": "ConnectivityCheckProtocol", + "modelAsString": true + } + }, + "protocolConfiguration": { + "description": "Protocol-specific configuration.", + "type": "object", + "properties": { + "HTTPConfiguration": { + "description": "Configuration for HTTP or HTTPS requests.", + "type": "object", + "properties": { + "method": { + "description": "The HTTP method to be used.", + "type": "string", + "enum": [ + "GET", + "POST" + ], + "x-ms-enum": { + "name": "Method", + "modelAsString": true + } + }, + "validStatusCodes": { + "type": "array", + "description": "List of HTTP status codes considered valid for the request response.", + "items": { + "type": "integer", + "format": "int64" + } + }, + "headers": { + "type": "array", + "description": "List of headers to be included in the request.", + "items": { + "$ref": "#/definitions/HTTPHeader" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + } + } + } + } + }, + "HTTPHeader": { + "description": "HTTP header and it's value.", + "type": "object", + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "Header name." + }, + "value": { + "type": "string", + "description": "Header value." + } + } + }, + "ConnectivityCheckResponse": { + "description": "Information on the connectivity status.", + "type": "object", + "properties": { + "hops": { + "readOnly": true, + "type": "array", + "description": "List of hops between the source and the destination.", + "items": { + "$ref": "#/definitions/ConnectivityHop" + } + }, + "connectionStatus": { + "readOnly": true, + "type": "string", + "enum": [ + "Unknown", + "Connected", + "Disconnected", + "Degraded" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + }, + "description": "The connection status." + }, + "avgLatencyInMs": { + "description": "Average latency in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int64" + }, + "minLatencyInMs": { + "description": "Minimum latency in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int64" + }, + "maxLatencyInMs": { + "description": "Maximum latency in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int64" + }, + "probesSent": { + "description": "Total number of probes sent.", + "readOnly": true, + "type": "integer", + "format": "int64" + }, + "probesFailed": { + "description": "Number of failed probes.", + "readOnly": true, + "type": "integer", + "format": "int64" + } + } + }, + "ConnectivityHop": { + "description": "Information about a hop between the source and the destination.", + "type": "object", + "properties": { + "type": { + "description": "The type of the hop.", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The ID of the hop.", + "readOnly": true, + "type": "string" + }, + "address": { + "description": "The IP address of the hop.", + "readOnly": true, + "type": "string" + }, + "resourceId": { + "description": "The ID of the resource corresponding to this hop.", + "readOnly": true, + "type": "string" + }, + "nextHopIds": { + "readOnly": true, + "type": "array", + "description": "List of next hop identifiers.", + "items": { + "type": "string" + } + }, + "issues": { + "readOnly": true, + "type": "array", + "description": "List of issues.", + "items": { + "$ref": "#/definitions/ConnectivityIssue" + }, + "x-ms-identifiers": [] + } + } + }, + "ConnectivityIssue": { + "description": "Information about an issue encountered in the process of checking for connectivity.", + "type": "object", + "properties": { + "origin": { + "readOnly": true, + "type": "string", + "enum": [ + "Local", + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true + }, + "description": "The origin of the issue." + }, + "severity": { + "readOnly": true, + "type": "string", + "enum": [ + "Error", + "Warning" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + }, + "description": "The severity of the issue." + }, + "type": { + "readOnly": true, + "type": "string", + "enum": [ + "Unknown", + "AgentStopped", + "GuestFirewall", + "DnsResolution", + "SocketBind", + "NetworkSecurityRule", + "UserDefinedRoute", + "PortThrottled", + "Platform" + ], + "x-ms-enum": { + "name": "IssueType", + "modelAsString": true + }, + "description": "The type of issue." + }, + "context": { + "readOnly": true, + "type": "array", + "description": "Provides additional context on the issue.", + "items": { + "$ref": "#/definitions/IssueContext" + }, + "x-ms-identifiers": [] + } + } + }, + "IssueContext": { + "description": "A key-value pair that provides additional context on the issue.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "DocumentationContractProperties": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "documentation title." + }, + "content": { + "type": "string", + "description": "Markdown documentation content." + } + }, + "description": "Markdown documentation details." + }, + "DocumentationContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DocumentationContractProperties", + "description": "Markdown Documentation details." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Markdown documentation details." + }, + "DocumentationUpdateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DocumentationContractProperties", + "description": "Markdown Documentation details." + } + }, + "description": "Documentation update contract details." + }, + "WikiDocumentationContract": { + "type": "object", + "properties": { + "documentationId": { + "type": "string", + "description": "Documentation Identifier" + } + }, + "description": "Wiki documentation details." + }, + "WikiContractProperties": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Collection wiki documents included into this wiki.", + "items": { + "$ref": "#/definitions/WikiDocumentationContract" + }, + "x-ms-identifiers": [ + "documentationId" + ] + } + }, + "description": "Wiki contract details" + }, + "WikiContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WikiContractProperties", + "description": "Wiki details." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Wiki properties" + }, + "WikiUpdateContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WikiContractProperties", + "description": "Wiki details." + } + }, + "description": "Wiki update contract details." + }, + "WorkspaceCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged workspace list representation." + }, + "WorkspaceContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceContractProperties", + "description": "Workspace entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Workspace details." + }, + "WorkspaceContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Name of the workspace." + }, + "description": { + "type": "string", + "description": "Description of the workspace." + } + }, + "required": [ + "displayName" + ], + "description": "Workspace entity properties." + }, + "ProductApiLinkCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductApiLinkContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Product-API link list representation." + }, + "ProductApiLinkContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProductApiLinkContractProperties", + "description": "Product-API link entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Product-API link details." + }, + "ProductApiLinkContractProperties": { + "type": "object", + "properties": { + "apiId": { + "type": "string", + "description": "Full resource Id of an API." + } + }, + "required": [ + "apiId" + ], + "description": "Product-API link entity properties." + }, + "ProductGroupLinkCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductGroupLinkContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Product-group link list representation." + }, + "ProductGroupLinkContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProductGroupLinkContractProperties", + "description": "Product-group link entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Product-group link details." + }, + "ProductGroupLinkContractProperties": { + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "Full resource Id of a group." + } + }, + "required": [ + "groupId" + ], + "description": "Product-group link entity properties." + }, + "TagApiLinkCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagApiLinkContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Tag-API link list representation." + }, + "TagApiLinkContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagApiLinkContractProperties", + "description": "Tag-API link entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Tag-API link details." + }, + "TagApiLinkContractProperties": { + "type": "object", + "properties": { + "apiId": { + "type": "string", + "description": "Full resource Id of an API." + } + }, + "required": [ + "apiId" + ], + "description": "Tag-API link entity properties." + }, + "TagOperationLinkCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagOperationLinkContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Tag-operation link list representation." + }, + "TagOperationLinkContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagOperationLinkContractProperties", + "description": "Tag-API link entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Tag-operation link details." + }, + "TagOperationLinkContractProperties": { + "type": "object", + "properties": { + "operationId": { + "type": "string", + "description": "Full resource Id of an API operation." + } + }, + "required": [ + "operationId" + ], + "description": "Tag-operation link entity properties." + }, + "TagProductLinkCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagProductLinkContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Tag-product link list representation." + }, + "TagProductLinkContract": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagProductLinkContractProperties", + "description": "Tag-API link entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Tag-product link details." + }, + "TagProductLinkContractProperties": { + "type": "object", + "properties": { + "productId": { + "type": "string", + "description": "Full resource Id of a product." + } + }, + "required": [ + "productId" + ], + "description": "Tag-product link entity properties." + }, + "GatewayListDebugCredentialsContract": { + "type": "object", + "properties": { + "credentialsExpireAfter": { + "type": "string", + "format": "duration", + "description": "Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used." + }, + "purposes": { + "type": "array", + "description": "Purposes of debug credential.", + "items": { + "type": "string", + "description": "Purpose of debug credential.", + "enum": [ + "tracing" + ], + "x-ms-enum": { + "name": "GatewayListDebugCredentialsContractPurpose", + "modelAsString": true, + "values": [ + { + "value": "tracing", + "description": "The tracing purpose." + } + ] + } + } + }, + "apiId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ApiManagement/service/apis" + }, + { + "type": "Microsoft.ApiManagement/service/workspaces/apis" + } + ] + }, + "description": "Full resource Id of an API." + } + }, + "required": [ + "purposes", + "apiId" + ], + "description": "List debug credentials properties." + }, + "GatewayDebugCredentialsContract": { + "type": "object", + "properties": { + "token": { + "type": "string", + "x-ms-secret": true, + "description": "Gateway debug token." + } + }, + "description": "Gateway debug credentials." + }, + "GatewayListTraceContract": { + "type": "object", + "properties": { + "traceId": { + "type": "string", + "description": "Trace id." + } + }, + "description": "List trace properties." + }, + "GatewayTraceContract": { + "type": "object", + "properties": {}, + "additionalProperties": true, + "description": "Trace collected in gateway." + } + }, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementAllPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementAllPolicies.json new file mode 100644 index 000000000000..3477bd1d64a8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementAllPolicies.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/allpolicies/allpolicies1", + "type": "Microsoft.ApiManagement/service/allpolicies", + "name": "allpolicies1", + "properties": { + "referencePolicyId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/policies/policy", + "complianceState": "Compliant" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementApplyNetworkConfigurationUpdates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementApplyNetworkConfigurationUpdates.json new file mode 100644 index 000000000000..3766d8fc6c31 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementApplyNetworkConfigurationUpdates.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "location": "west us" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "UID": "52ed5986-717b-45b4-b17c-3df8db372cff" + }, + "location": "East Asia", + "etag": "AAAAAAAXX6Y=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2015-09-22T01:50:34.7921566Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "207.46.155.24" + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/eastUsVirtualNetwork/subnets/apimSubnet" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json new file mode 100644 index 000000000000..c9f0e04e674b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "privateEndpointConnectionRequest": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName", + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "The Private Endpoint Connection is approved." + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + }, + "200": { + "body": { + "name": "privateEndpointConnectionName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Succeeded", + "description": "The request has been approved." + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementAuthorizationServerListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementAuthorizationServerListSecrets.json new file mode 100644 index 000000000000..059b1762e949 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementAuthorizationServerListSecrets.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authsid": "newauthServer2" + }, + "responses": { + "200": { + "body": { + "clientSecret": "2", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackendReconnect.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackendReconnect.json new file mode 100644 index 000000000000..b612f9410b4c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackendReconnect.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "backendId": "proxybackend", + "parameters": { + "properties": { + "after": "PT3S" + } + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackupWithAccessKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackupWithAccessKey.json new file mode 100644 index 000000000000..8f21ea81e68b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackupWithAccessKey.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "storageAccount": "teststorageaccount", + "containerName": "backupContainer", + "backupName": "apimService1backup_2017_03_19", + "accessType": "AccessKey", + "accessKey": "**************************************************" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "West US", + "etag": "AAAAAAACXok=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2019-12-18T06:26:20.3348609Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false + }, + { + "type": "Proxy", + "hostName": "gateway1.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": true + }, + { + "type": "Management", + "hostName": "mgmt.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + }, + { + "type": "Portal", + "hostName": "portal1.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + }, + { + "type": "ConfigurationApi", + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + } + ], + "publicIPAddresses": [ + "13.91.32.113" + ], + "additionalLocations": [ + { + "location": "East US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "23.101.138.153" + ], + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "disableGateway": true + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + } + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackupWithSystemManagedIdentity.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackupWithSystemManagedIdentity.json new file mode 100644 index 000000000000..dea14c8b2b26 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackupWithSystemManagedIdentity.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "storageAccount": "contosorpstorage", + "containerName": "apim-backups", + "backupName": "backup5", + "accessType": "SystemAssignedManagedIdentity" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "Owner": "apimService1" + }, + "location": "Central US EUAP", + "etag": "AAAAAAAQM8o=", + "properties": { + "publisherEmail": "apimService1@corp.microsoft.com", + "publisherName": "MS", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2020-04-23T16:26:47.8637967Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-centraluseuap-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "publicIPAddresses": [ + "52.XXXX.160.66" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "publicNetworkAccess": "Enabled", + "platformVersion": "stv1" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-5fb4-4916-95d4-64b306f9d924", + "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": { + "principalId": "00000000-a100-4478-0000-d65d98118ba0", + "clientId": "00000000-a154-4830-0000-46a12da1a1e2" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": { + "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3", + "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf" + } + } + }, + "systemData": { + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-30T06:24:57.0008037Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json new file mode 100644 index 000000000000..48d2fb31164b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "storageAccount": "contosorpstorage", + "containerName": "apim-backups", + "backupName": "backup5", + "accessType": "UserAssignedManagedIdentity", + "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "Owner": "apimService1" + }, + "location": "Central US EUAP", + "etag": "AAAAAAAQM8o=", + "properties": { + "publisherEmail": "apimService1@corp.microsoft.com", + "publisherName": "MS", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2020-04-23T16:26:47.8637967Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-centraluseuap-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "publicIPAddresses": [ + "52.XXXX.160.66" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "publicNetworkAccess": "Enabled", + "platformVersion": "stv1" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-5fb4-4916-95d4-64b306f9d924", + "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": { + "principalId": "00000000-a100-4478-0000-d65d98118ba0", + "clientId": "00000000-a154-4830-0000-46a12da1a1e2" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": { + "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3", + "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf" + } + } + }, + "systemData": { + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-30T06:24:57.0008037Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAILogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAILogger.json new file mode 100644 index 000000000000..e031c7baeb7b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAILogger.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "loggerId": "loggerId", + "parameters": { + "properties": { + "loggerType": "applicationInsights", + "description": "adding a new logger", + "credentials": { + "instrumentationKey": "11................a1" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "loggerId", + "properties": { + "loggerType": "applicationInsights", + "description": null, + "credentials": { + "instrumentationKey": "{{5a.......2a}}" + }, + "isBuffered": false, + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.insights/components/airesource" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "loggerId", + "properties": { + "loggerType": "applicationInsights", + "description": null, + "credentials": { + "instrumentationKey": "{{5a.......2a}}" + }, + "isBuffered": false + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApi.json new file mode 100644 index 000000000000..e5c016be8fe9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApi.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "tempgroup", + "parameters": { + "properties": { + "description": "apidescription5200", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "displayName": "apiname1463", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "https", + "http" + ] + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "http", + "https" + ], + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "http", + "https" + ], + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiClone.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiClone.json new file mode 100644 index 000000000000..6fe017bb96bb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiClone.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "echo-api2", + "parameters": { + "properties": { + "displayName": "Echo API2", + "description": "Copy of Existing Echo Api including Operations.", + "subscriptionRequired": true, + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo2", + "protocols": [ + "http", + "https" + ], + "isCurrent": true, + "sourceApiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58a4aeac497000007d040001" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapi2", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echoapi2", + "properties": { + "displayName": "Echo API2", + "apiRevision": "1", + "description": "Copy of Existing Echo Api including Operations.", + "subscriptionRequired": true, + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo2", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapi2", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echoapi2", + "properties": { + "displayName": "Echo API2", + "apiRevision": "1", + "description": "Copy of Existing Echo Api including Operations.", + "subscriptionRequired": true, + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo2", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiDiagnostic.json new file mode 100644 index 000000000000..c899261f0dda --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiDiagnostic.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiIssue.json new file mode 100644 index 000000000000..33d97a6632ac --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiIssue.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiIssueAttachment.json new file mode 100644 index 000000000000..6899790371c1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiIssueAttachment.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "attachmentId": "57d2ef278aa04f0888cba3f3", + "parameters": { + "properties": { + "title": "Issue attachment.", + "contentFormat": "image/jpeg", + "content": "IEJhc2U2NA==" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "name": "57d2ef278aa04f0888cba3f3", + "properties": { + "title": "Issue attachment.", + "contentFormat": "link", + "content": "https://.../image.jpg" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "name": "57d2ef278aa04f0888cba3f3", + "properties": { + "title": "Issue attachment.", + "contentFormat": "link", + "content": "https://.../image.jpg" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiIssueComment.json new file mode 100644 index 000000000000..569907498b23 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiIssueComment.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "commentId": "599e29ab193c3c0bd0b3e2fb", + "parameters": { + "properties": { + "text": "Issue comment.", + "createdDate": "2018-02-01T22:21:20.467Z", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "name": "599e29ab193c3c0bd0b3e2fb", + "properties": { + "text": "Issue comment.", + "createdDate": "2018-02-01T22:21:20.467Z", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "name": "599e29ab193c3c0bd0b3e2fb", + "properties": { + "text": "Issue comment.", + "createdDate": "2018-02-01T22:21:20.467Z", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiNewVersionUsingExistingApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiNewVersionUsingExistingApi.json new file mode 100644 index 000000000000..ddf4c5c719b1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiNewVersionUsingExistingApi.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "echoapiv3", + "parameters": { + "properties": { + "displayName": "Echo API2", + "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.", + "subscriptionRequired": true, + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo2", + "protocols": [ + "http", + "https" + ], + "isCurrent": true, + "apiVersion": "v4", + "sourceApiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoPath", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapiv3", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echoapiv3", + "properties": { + "displayName": "Echo API2", + "apiRevision": "1", + "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.", + "subscriptionRequired": true, + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo2", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "apiVersion": "v4", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "apiVersionSet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "name": "Echo API2", + "versioningScheme": "Segment" + }, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapiv3", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echoapiv3", + "properties": { + "displayName": "Echo API2", + "apiRevision": "1", + "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.", + "subscriptionRequired": true, + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo2", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "apiVersion": "v4", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "apiVersionSet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "name": "Echo API2", + "versioningScheme": "Segment" + }, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiOperation.json new file mode 100644 index 000000000000..5d7baa967041 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiOperation.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "PetStoreTemplate2", + "operationId": "newoperations", + "parameters": { + "properties": { + "displayName": "createUser2", + "method": "POST", + "urlTemplate": "/user1", + "templateParameters": [], + "description": "This can only be done by the logged in user.", + "request": { + "description": "Created user object", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "successful operation", + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "headers": [] + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "newoperations", + "properties": { + "displayName": "createUser2", + "method": "POST", + "urlTemplate": "/user1", + "templateParameters": [], + "description": "This can only be done by the logged in user.", + "request": { + "description": "Created user object", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "successful operation", + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "headers": [] + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "newoperations", + "properties": { + "displayName": "createUser2", + "method": "POST", + "urlTemplate": "/user1", + "templateParameters": [], + "description": "This can only be done by the logged in user.", + "request": { + "description": "Created user object", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "successful operation", + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "headers": [] + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiOperationPolicy.json new file mode 100644 index 000000000000..72838cddb92f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiOperationPolicy.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5600b57e7e8880006a040001", + "operationId": "5600b57e7e8880006a080001", + "policyId": "policy", + "If-Match": "*", + "parameters": { + "properties": { + "format": "xml", + "value": " " + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiOperationTag.json new file mode 100644 index 000000000000..0063c26b884e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiOperationTag.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5931a75ae4bbd512a88c680b", + "operationId": "5931a75ae4bbd512a88c680a", + "tagId": "tagId1" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiPolicy.json new file mode 100644 index 000000000000..93663a23362b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiPolicy.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5600b57e7e8880006a040001", + "policyId": "policy", + "If-Match": "*", + "parameters": { + "properties": { + "format": "xml", + "value": " " + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json new file mode 100644 index 000000000000..3355a7ba993f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5600b57e7e8880006a040001", + "policyId": "policy", + "If-Match": "*", + "parameters": { + "properties": { + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n ", + "format": "rawxml" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/4c1a3bc6-89f9-46fe-a175-5d8984b25095/resourcegroups/Api-DF-West-US/providers/Microsoft.ApiManagement/service/samirmsiservice2/apis/echo-api/operations/create-resource/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/4c1a3bc6-89f9-46fe-a175-5d8984b25095/resourcegroups/Api-DF-West-US/providers/Microsoft.ApiManagement/service/samirmsiservice2/apis/echo-api/operations/create-resource/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiRelease.json new file mode 100644 index 000000000000..bdb879307ac0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiRelease.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "a1", + "releaseId": "testrev", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "notes": "yahooagain" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", + "type": "Microsoft.ApiManagement/service/apis/releases", + "name": "testrev", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "createdDateTime": "2018-02-08T20:52:00.65Z", + "updatedDateTime": "2018-02-08T20:52:00.65Z", + "notes": "yahooagain" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", + "type": "Microsoft.ApiManagement/service/apis/releases", + "name": "testrev", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "createdDateTime": "2018-02-08T20:52:00.65Z", + "updatedDateTime": "2018-02-08T20:52:00.65Z", + "notes": "yahooagain" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiRevisionFromExistingApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiRevisionFromExistingApi.json new file mode 100644 index 000000000000..808abf4bac36 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiRevisionFromExistingApi.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "echo-api;rev=3", + "parameters": { + "properties": { + "path": "echo", + "serviceUrl": "http://echoapi.cloudapp.net/apiv3", + "sourceApiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", + "apiRevisionDescription": "Creating a Revision of an existing API" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api;rev=3", + "properties": { + "displayName": "Echo API", + "apiRevision": "3", + "subscriptionRequired": true, + "serviceUrl": "http://echoapi.cloudapp.net/apiv3", + "path": "echo", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "apiRevisionDescription": "Creating a Revision of an existing API", + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api;rev=3", + "properties": { + "displayName": "Echo API", + "apiRevision": "3", + "subscriptionRequired": true, + "serviceUrl": "http://echoapi.cloudapp.net/apiv3", + "path": "echo", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "apiRevisionDescription": "Creating a Revision of an existing API", + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiSchema.json new file mode 100644 index 000000000000..4f16fbcbdf81 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiSchema.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "parameters": { + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + }, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + }, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiTag.json new file mode 100644 index 000000000000..e4bd764ee416 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiTag.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5931a75ae4bbd512a88c680b", + "tagId": "tagId1" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiTagDescription.json new file mode 100644 index 000000000000..eda09ee993e8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiTagDescription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5931a75ae4bbd512a88c680b", + "tagDescriptionId": "tagId1", + "parameters": { + "properties": { + "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API", + "externalDocsUrl": "http://some.url/additionaldoc", + "externalDocsDescription": "Description of the external docs resource" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1", + "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", + "name": "tagId1", + "properties": { + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "displayName": "tag1", + "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API", + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1", + "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", + "name": "tagId1", + "properties": { + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "displayName": "tag1", + "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API", + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingImportOverrideServiceUrl.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingImportOverrideServiceUrl.json new file mode 100644 index 000000000000..289f30bcef2a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingImportOverrideServiceUrl.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "apidocs", + "parameters": { + "properties": { + "format": "swagger-link", + "value": "http://apimpimportviaurl.azurewebsites.net/api/apidocs/", + "path": "petstoreapi123", + "serviceUrl": "http://petstore.swagger.wordnik.com/api" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apidocs", + "properties": { + "displayName": "Swagger Sample App", + "apiRevision": "1", + "description": "This is a sample server Petstore server. You can find out more about Swagger \n at http://swagger.wordnik.com or on irc.freenode.net, #swagger. For this sample,\n you can use the api key \"special-key\" to test the authorization filters", + "serviceUrl": "http://petstore.swagger.wordnik.com/api", + "path": "petstoreapi123", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apidocs", + "properties": { + "displayName": "Swagger Sample App", + "apiRevision": "1", + "description": "This is a sample server Petstore server. You can find out more about Swagger \n at http://swagger.wordnik.com or on irc.freenode.net, #swagger. For this sample,\n you can use the api key \"special-key\" to test the authorization filters", + "serviceUrl": "http://petstore.swagger.wordnik.com/api", + "path": "petstoreapi123", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingOai3Import.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingOai3Import.json new file mode 100644 index 000000000000..12c97078b54c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingOai3Import.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "petstore", + "parameters": { + "properties": { + "format": "openapi-link", + "value": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml", + "path": "petstore" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "petstoreapi", + "properties": { + "displayName": "Swagger Petstore", + "apiRevision": "1", + "serviceUrl": "http://petstore.swagger.io/v1", + "path": "petstore", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "petstoreapi", + "properties": { + "displayName": "Swagger Petstore", + "apiRevision": "1", + "serviceUrl": "http://petstore.swagger.io/v1", + "path": "petstore", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json new file mode 100644 index 000000000000..cf9ef4b46626 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "petstore", + "parameters": { + "properties": { + "format": "openapi-link", + "value": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml", + "path": "petstore", + "translateRequiredQueryParameters": "template" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "petstoreapi", + "properties": { + "displayName": "Swagger Petstore", + "apiRevision": "1", + "serviceUrl": "http://petstore.swagger.io/v1", + "path": "petstore", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "petstoreapi", + "properties": { + "displayName": "Swagger Petstore", + "apiRevision": "1", + "serviceUrl": "http://petstore.swagger.io/v1", + "path": "petstore", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingSwaggerImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingSwaggerImport.json new file mode 100644 index 000000000000..c9d08c662b1c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingSwaggerImport.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "petstore", + "parameters": { + "properties": { + "format": "swagger-link-json", + "value": "http://petstore.swagger.io/v2/swagger.json", + "path": "petstore" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "petstoreapi", + "properties": { + "displayName": "Swagger Petstore", + "apiRevision": "1", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "serviceUrl": "http://petstore.swagger.io/v2", + "path": "petstore", + "protocols": [ + "http" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "petstoreapi", + "properties": { + "displayName": "Swagger Petstore", + "apiRevision": "1", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "serviceUrl": "http://petstore.swagger.io/v2", + "path": "petstore", + "protocols": [ + "http" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingWadlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingWadlImport.json new file mode 100644 index 000000000000..714adf45d32d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiUsingWadlImport.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "petstore", + "parameters": { + "properties": { + "format": "wadl-link-json", + "value": "https://developer.cisco.com/media/wae-release-6-2-api-reference/wae-collector-rest-api/application.wadl", + "path": "collector" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl", + "type": "Microsoft.ApiManagement/service/apis", + "name": "collectorwadl", + "properties": { + "displayName": "http://localhost:8080/collector-northbound", + "apiRevision": "1", + "description": "", + "serviceUrl": "http://localhost:8080/collector-northbound", + "path": "collector", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl", + "type": "Microsoft.ApiManagement/service/apis", + "name": "collectorwadl", + "properties": { + "displayName": "http://localhost:8080/collector-northbound", + "apiRevision": "1", + "description": "", + "serviceUrl": "http://localhost:8080/collector-northbound", + "path": "collector", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiVersionSet.json new file mode 100644 index 000000000000..a127406bf70d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiVersionSet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "api1", + "parameters": { + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "name": "api1", + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "name": "api1", + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWiki.json new file mode 100644 index 000000000000..e9233f0d1d58 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWiki.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "name": "default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "name": "default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWithMultipleAuthServers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWithMultipleAuthServers.json new file mode 100644 index 000000000000..4ea701ff9d8d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWithMultipleAuthServers.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "tempgroup", + "parameters": { + "properties": { + "description": "apidescription5200", + "authenticationSettings": { + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "displayName": "apiname1463", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "https", + "http" + ] + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "http", + "https" + ], + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json new file mode 100644 index 000000000000..0f4f76459f65 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "tempgroup", + "parameters": { + "properties": { + "description": "apidescription5200", + "authenticationSettings": { + "openidAuthenticationSettings": [ + { + "openidProviderId": "openidProviderId2283", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + }, + { + "openidProviderId": "openidProviderId2284", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "displayName": "apiname1463", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "https", + "http" + ] + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "http", + "https" + ], + "authenticationSettings": { + "openid": { + "openidProviderId": "openidProviderId2283", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + }, + "openidAuthenticationSettings": [ + { + "openidProviderId": "openidProviderId2283", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + }, + { + "openidProviderId": "openidProviderId2284", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWithOpenIdConnect.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWithOpenIdConnect.json new file mode 100644 index 000000000000..1be4563b4452 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateApiWithOpenIdConnect.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "tempgroup", + "parameters": { + "properties": { + "displayName": "Swagger Petstore", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "serviceUrl": "http://petstore.swagger.io/v2", + "path": "petstore", + "protocols": [ + "https" + ], + "authenticationSettings": { + "openid": { + "openidProviderId": "testopenid", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + } + }, + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58da4c4ccdae970a08121230", + "type": "Microsoft.ApiManagement/service/apis", + "name": "58da4c4ccdae970a08121230", + "properties": { + "displayName": "Swagger Petstore", + "apiRevision": "1", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "serviceUrl": "http://petstore.swagger.io/v2", + "path": "petstore", + "protocols": [ + "https" + ], + "authenticationSettings": { + "openid": { + "openidProviderId": "testopenid", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + } + }, + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58da4c4ccdae970a08121230", + "type": "Microsoft.ApiManagement/service/apis", + "name": "58da4c4ccdae970a08121230", + "properties": { + "displayName": "Swagger Petstore", + "apiRevision": "1", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "serviceUrl": "http://petstore.swagger.io/v2", + "path": "petstore", + "protocols": [ + "https" + ], + "authenticationSettings": { + "openid": { + "openidProviderId": "testopenid", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + } + }, + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationAADAuthCode.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationAADAuthCode.json new file mode 100644 index 000000000000..e9457b2fb8c2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationAADAuthCode.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "authorizationId": "authz2", + "parameters": { + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "AuthorizationCode" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "name": "authz2", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "AuthorizationCode", + "status": "Error", + "error": { + "code": "Unauthenticated", + "message": "This connection is not authenticated." + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "name": "authz2", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "AuthorizationCode", + "status": "Error", + "error": { + "code": "Unauthenticated", + "message": "This connection is not authenticated." + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationAADClientCred.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationAADClientCred.json new file mode 100644 index 000000000000..61adbd2e8213 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationAADClientCred.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithclientcred", + "authorizationId": "authz1", + "parameters": { + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "AuthorizationCode", + "parameters": { + "clientId": "clientsecretid", + "clientSecret": "clientsecretvalue" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "name": "authz1", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "ClientCredentials", + "parameters": { + "clientId": "clientsecretid" + }, + "status": "Connected" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "name": "authz1", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "ClientCredentials", + "parameters": { + "clientId": "clientsecretid" + }, + "status": "Connected" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationAccessPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationAccessPolicy.json new file mode 100644 index 000000000000..924e5e6fecc8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationAccessPolicy.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "authorizationId": "authz1", + "authorizationAccessPolicyId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "parameters": { + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderAADAuthCode.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderAADAuthCode.json new file mode 100644 index 000000000000..9bd681ba41a6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderAADAuthCode.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "parameters": { + "properties": { + "displayName": "aadwithauthcode", + "identityProvider": "aad", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "clientsecretid", + "clientSecret": "clientsecretvalue", + "scopes": "User.Read.All Group.Read.All", + "resourceUri": "https://graph.microsoft.com" + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "aadwithauthcode", + "properties": { + "displayName": "aadwithauthcode", + "identityProvider": "aad", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", + "scopes": "User.Read.All Group.Read.All", + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "tenantId": "common" + } + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "aadwithauthcode", + "properties": { + "displayName": "aadwithauthcode", + "identityProvider": "aad", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", + "scopes": "User.Read.All Group.Read.All", + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "tenantId": "common" + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderAADClientCred.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderAADClientCred.json new file mode 100644 index 000000000000..04435ec0bbaf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderAADClientCred.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithclientcred", + "parameters": { + "properties": { + "displayName": "aadwithclientcred", + "identityProvider": "aad", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "scopes": "User.Read.All Group.Read.All", + "resourceUri": "https://graph.microsoft.com" + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "aadwithclientcred", + "properties": { + "displayName": "aadwithclientcred", + "identityProvider": "aad", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "clientCredentials": { + "scopes": "User.Read.All Group.Read.All", + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "tenantId": "common" + } + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "aadwithclientcred", + "properties": { + "displayName": "aadwithclientcred", + "identityProvider": "aad", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "clientCredentials": { + "scopes": "User.Read.All Group.Read.All", + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "tenantId": "common" + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderGenericOAuth2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderGenericOAuth2.json new file mode 100644 index 000000000000..0c0a1e08a6aa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderGenericOAuth2.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "eventbrite", + "parameters": { + "properties": { + "displayName": "eventbrite", + "identityProvider": "oauth2", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "clientid", + "clientSecret": "clientsecretvalue", + "scopes": null, + "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", + "refreshUrl": "https://www.eventbrite.com/oauth/token", + "tokenUrl": "https://www.eventbrite.com/oauth/token" + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "eventbrite", + "properties": { + "displayName": "eventbrite", + "identityProvider": "oauth2", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "clientid", + "scopes": null, + "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", + "refreshUrl": "https://www.eventbrite.com/oauth/token", + "tokenUrl": "https://www.eventbrite.com/oauth/token" + } + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "eventbrite", + "properties": { + "displayName": "eventbrite", + "identityProvider": "oauth2", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "clientid", + "scopes": null, + "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", + "refreshUrl": "https://www.eventbrite.com/oauth/token", + "tokenUrl": "https://www.eventbrite.com/oauth/token" + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderOOBGoogle.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderOOBGoogle.json new file mode 100644 index 000000000000..e796cd8d84bc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationProviderOOBGoogle.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "google", + "parameters": { + "properties": { + "displayName": "google", + "identityProvider": "google", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com", + "clientSecret": "clientsecretvalue", + "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email" + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "google", + "properties": { + "displayName": "google", + "identityProvider": "google", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com", + "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email" + } + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "google", + "properties": { + "displayName": "google", + "identityProvider": "google", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com", + "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email" + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationServer.json new file mode 100644 index 000000000000..12e24e4ebfb0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateAuthorizationServer.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authsid": "newauthServer", + "parameters": { + "properties": { + "displayName": "test2", + "useInTestConsole": false, + "useInApiDocumentation": true, + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientSecret": "2", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "name": "newauthServer", + "properties": { + "displayName": "test2", + "useInTestConsole": false, + "useInApiDocumentation": true, + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "name": "newauthServer", + "properties": { + "displayName": "test2", + "useInTestConsole": false, + "useInApiDocumentation": true, + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateBackendProxyBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateBackendProxyBackend.json new file mode 100644 index 000000000000..139b09f9b042 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateBackendProxyBackend.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "backendId": "proxybackend", + "parameters": { + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "tls": { + "validateCertificateChain": true, + "validateCertificateName": true + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "" + }, + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "proxybackend", + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "proxybackend", + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateBackendServiceFabric.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateBackendServiceFabric.json new file mode 100644 index 000000000000..3a6e6a402585 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateBackendServiceFabric.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "backendId": "sfbackend", + "parameters": { + "properties": { + "description": "Service Fabric Test App 1", + "protocol": "http", + "url": "fabric:/mytestapp/mytestservice", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateCache.json new file mode 100644 index 000000000000..ac2790efa599 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateCache.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "cacheId": "c1", + "parameters": { + "properties": { + "connectionString": "apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False", + "description": "Redis cache instances in West India", + "useFromLocation": "default", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", + "type": "Microsoft.ApiManagement/service/caches", + "name": "c1", + "properties": { + "useFromLocation": "default", + "description": "Redis cache instances in West India", + "connectionString": "{{5f7fbca77a891a2200f3db38}}", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", + "type": "Microsoft.ApiManagement/service/caches", + "name": "c1", + "properties": { + "useFromLocation": "default", + "description": "Redis cache instances in West India", + "connectionString": "{{5f7fbca77a891a2200f3db38}}", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateCertificate.json new file mode 100644 index 000000000000..77249c0e482e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateCertificate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "certificateId": "tempcert", + "parameters": { + "properties": { + "data": "****************Base 64 Encoded Certificate *******************************", + "password": "****Certificate Password******" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "tempcert", + "properties": { + "subject": "CN=contoso.com", + "thumbprint": "*******************3", + "expirationDate": "2018-03-17T21:55:07+00:00" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "tempcert", + "properties": { + "subject": "CN=contoso.com", + "thumbprint": "*******************3", + "expirationDate": "2018-03-17T21:55:07+00:00" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateCertificateWithKeyVault.json new file mode 100644 index 000000000000..92ae0bc8b90e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateCertificateWithKeyVault.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "certificateId": "templateCertkv", + "parameters": { + "properties": { + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "templateCertkv", + "properties": { + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690", + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "templateCertkv", + "properties": { + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690", + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateContentType.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateContentType.json new file mode 100644 index 000000000000..9f76a0ae26e6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateContentType.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "contentTypeId": "page", + "parameters": { + "properties": { + "name": "Page", + "description": "A regular page", + "schema": { + "properties": { + "en_us": { + "type": "object", + "properties": { + "title": { + "title": "Title", + "description": "Page title. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "description": { + "title": "Description", + "description": "Page description. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "keywords": { + "title": "Keywords", + "description": "Page keywords. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "permalink": { + "title": "Permalink", + "description": "Page permalink, e.g. '/about'.", + "type": "string", + "indexed": true + }, + "documentId": { + "title": "Document ID", + "description": "Reference to page content document.", + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "title", + "permalink", + "documentId" + ] + } + }, + "additionalProperties": false + }, + "version": "1.0.0" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/contentTypes/page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "name": "page", + "properties": { + "name": "Page", + "description": "A regular page", + "schema": { + "properties": { + "en_us": { + "type": "object", + "properties": { + "title": { + "title": "Title", + "description": "Page title. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "description": { + "title": "Description", + "description": "Page description. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "keywords": { + "title": "Keywords", + "description": "Page keywords. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "permalink": { + "title": "Permalink", + "description": "Page permalink, e.g. '/about'.", + "type": "string", + "indexed": true + }, + "documentId": { + "title": "Document ID", + "description": "Reference to page content document.", + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "title", + "permalink", + "documentId" + ] + } + }, + "additionalProperties": false + }, + "version": "1.0.0" + } + } + }, + "201": { + "body": { + "id": "/contentTypes/page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "name": "page", + "properties": { + "name": "Page", + "description": "A regular page", + "schema": { + "properties": { + "en_us": { + "type": "object", + "properties": { + "title": { + "title": "Title", + "description": "Page title. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "description": { + "title": "Description", + "description": "Page description. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "keywords": { + "title": "Keywords", + "description": "Page keywords. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "permalink": { + "title": "Permalink", + "description": "Page permalink, e.g. '/about'.", + "type": "string", + "indexed": true + }, + "documentId": { + "title": "Document ID", + "description": "Reference to page content document.", + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "title", + "permalink", + "documentId" + ] + } + }, + "additionalProperties": false + }, + "version": "1.0.0" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateContentTypeContentItem.json new file mode 100644 index 000000000000..a94cd38605a5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateContentTypeContentItem.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "contentTypeId": "page", + "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "parameters": { + "properties": { + "en_us": { + "title": "About", + "description": "Short story about the company.", + "keywords": "company, about", + "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "permalink": "/about" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "properties": { + "en_us": { + "title": "About", + "description": "Short story about the company.", + "keywords": "company, about", + "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "permalink": "/about" + } + } + } + }, + "201": { + "body": { + "id": "/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "properties": { + "en_us": { + "title": "About", + "description": "Short story about the company.", + "keywords": "company, about", + "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "permalink": "/about" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateDiagnostic.json new file mode 100644 index 000000000000..dcb45df06c87 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateDiagnostic.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "diagnosticId": "applicationinsights", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/azuremonitor", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/azuremonitor", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateDocumentation.json new file mode 100644 index 000000000000..b622b7a8da55 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateDocumentation.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "documentationId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "title": "Title", + "content": "content" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "name": "57d1f7558aa04f15146d9d8a", + "properties": { + "title": "Title", + "content": "content" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "name": "57d1f7558aa04f15146d9d8a", + "properties": { + "title": "Title", + "content": "content" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateEHLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateEHLogger.json new file mode 100644 index 000000000000..7b324f34ecc8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateEHLogger.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "loggerId": "eh1", + "parameters": { + "properties": { + "loggerType": "azureEventHub", + "description": "adding a new logger", + "credentials": { + "name": "hydraeventhub", + "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********=" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "eh1", + "properties": { + "loggerType": "azureEventHub", + "description": "adding a new logger", + "credentials": { + "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" + }, + "isBuffered": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "eh1", + "properties": { + "loggerType": "azureEventHub", + "description": "adding a new logger", + "credentials": { + "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" + }, + "isBuffered": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGateway.json new file mode 100644 index 000000000000..ee6b3e750dc4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGateway.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "parameters": { + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", + "type": "Microsoft.ApiManagement/service/gateways", + "name": "a1", + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", + "type": "Microsoft.ApiManagement/service/gateways", + "name": "a1", + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayApi.json new file mode 100644 index 000000000000..31569c4fe80b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayApi.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "apiId": "echo-api", + "parameters": { + "properties": { + "provisioningState": "created" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api", + "type": "Microsoft.ApiManagement/service/gateways/apis", + "name": "echo-api", + "properties": { + "displayName": "EchoApi", + "apiRevision": "1", + "serviceUrl": "https://contoso.com/apis/echo", + "path": "", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api", + "type": "Microsoft.ApiManagement/service/gateways/apis", + "name": "echo-api", + "properties": { + "displayName": "EchoApi", + "apiRevision": "1", + "serviceUrl": "https://contoso.com/apis/echo", + "path": "", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayCertificateAuthority.json new file mode 100644 index 000000000000..43404dbd390f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayCertificateAuthority.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "certificateId": "cert1", + "parameters": { + "properties": { + "isTrusted": false + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "name": "cert1", + "properties": { + "isTrusted": false + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "name": "cert1", + "properties": { + "isTrusted": false + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayConfigConnection.json new file mode 100644 index 000000000000..3b6f6775f34e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayConfigConnection.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayName": "standard-gw-01", + "configConnectionName": "gcc-01", + "parameters": { + "properties": { + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", + "name": "gcc-1", + "type": "Microsoft.ApiManagement/gateways/configConnections", + "etag": "AAAAAAAWN/4=", + "properties": { + "provisioningState": "Succeeded", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001", + "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", + "name": "gcc-1", + "type": "Microsoft.ApiManagement/gateways/configConnections", + "etag": "AAAAAAAWN/4=", + "properties": { + "provisioningState": "Succeeded", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001", + "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayHostnameConfiguration.json new file mode 100644 index 000000000000..7c991695c3ee --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGatewayHostnameConfiguration.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "hcId": "default", + "parameters": { + "properties": { + "hostname": "*", + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "negotiateClientCertificate": false, + "tls10Enabled": false, + "tls11Enabled": false, + "http2Enabled": true + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "name": "default", + "properties": { + "hostname": "*", + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "negotiateClientCertificate": false, + "tls10Enabled": false, + "tls11Enabled": false, + "http2Enabled": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "name": "default", + "properties": { + "hostname": "*", + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "negotiateClientCertificate": false, + "tls10Enabled": false, + "tls11Enabled": false, + "http2Enabled": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGlobalSchema1.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGlobalSchema1.json new file mode 100644 index 000000000000..76e005755b88 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGlobalSchema1.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "schemaId": "schema1", + "parameters": { + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "name": "schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n", + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "name": "schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n", + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGlobalSchema2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGlobalSchema2.json new file mode 100644 index 000000000000..75b05f004d8e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGlobalSchema2.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "schemaId": "schema1", + "parameters": { + "properties": { + "description": "sample schema description", + "schemaType": "json", + "document": { + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Person", + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + }, + "age": { + "description": "Age in years which must be equal to or greater than zero.", + "type": "integer", + "minimum": 0 + } + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "name": "schema1", + "properties": { + "description": "sample schema description", + "schemaType": "json", + "document": { + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Person", + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + }, + "age": { + "description": "Age in years which must be equal to or greater than zero.", + "type": "integer", + "minimum": 0 + } + } + }, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "name": "schema1", + "properties": { + "description": "sample schema description", + "schemaType": "json", + "document": { + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Person", + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + }, + "age": { + "description": "Age in years which must be equal to or greater than zero.", + "type": "integer", + "minimum": 0 + } + } + }, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGraphQLApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGraphQLApi.json new file mode 100644 index 000000000000..082df7bd0f08 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGraphQLApi.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "tempgroup", + "parameters": { + "properties": { + "description": "apidescription5200", + "displayName": "apiname1463", + "type": "graphql", + "serviceUrl": "https://api.spacex.land/graphql", + "path": "graphql-api", + "protocols": [ + "http", + "https" + ] + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "https://api.spacex.land/graphql", + "type": "graphql", + "path": "graphql-api", + "protocols": [ + "https", + "https" + ], + "authenticationSettings": null, + "subscriptionKeyParameterNames": null, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "https://api.spacex.land/graphql", + "type": "graphql", + "path": "graphql-api", + "protocols": [ + "http", + "https" + ], + "authenticationSettings": null, + "subscriptionKeyParameterNames": null, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGraphQLApiResolver.json new file mode 100644 index 000000000000..ef4b193736f2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGraphQLApiResolver.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "someAPI", + "resolverId": "newResolver", + "parameters": { + "properties": { + "displayName": "Query Users", + "path": "Query/users", + "description": "A GraphQL Resolver example" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/someAPI/resolvers/newResolver", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "name": "newResolver", + "properties": { + "displayName": "Query Users", + "path": "Query/users", + "description": "A GraphQL Resolver example" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/someAPI/resolvers/newResolver", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "name": "newResolver", + "properties": { + "displayName": "Query Users", + "path": "Query/users", + "description": "A GraphQL Resolver example" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGraphQLApiResolverPolicy.json new file mode 100644 index 000000000000..771d149a0fa6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGraphQLApiResolverPolicy.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5600b57e7e8880006a040001", + "resolverId": "5600b57e7e8880006a080001", + "policyId": "policy", + "If-Match": "*", + "parameters": { + "properties": { + "format": "xml", + "value": "GET/api/users" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/resolvers/5600b57e7e8880006a080001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n GET\r\n\r\n/api/users\r\n\r\n" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/resolvers/5600b57e7e8880006a080001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n GET\r\n\r\n/api/users\r\n\r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGroup.json new file mode 100644 index 000000000000..31f7ac352ef7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "tempgroup", + "parameters": { + "properties": { + "displayName": "temp group" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", + "type": "Microsoft.ApiManagement/service/groups", + "name": "tempgroup", + "properties": { + "displayName": "temp group", + "type": "custom" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", + "type": "Microsoft.ApiManagement/service/groups", + "name": "tempgroup", + "properties": { + "displayName": "temp group", + "type": "custom" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGroupExternal.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGroupExternal.json new file mode 100644 index 000000000000..92991dc8d3e8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGroupExternal.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "aadGroup", + "parameters": { + "properties": { + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "description": "new group to test", + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup", + "type": "Microsoft.ApiManagement/service/groups", + "name": "aadGroup", + "properties": { + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "description": "new group to test", + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup", + "type": "Microsoft.ApiManagement/service/groups", + "name": "aadGroup", + "properties": { + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "description": "new group to test", + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGroupUser.json new file mode 100644 index 000000000000..5d91816bc80f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGroupUser.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "tempgroup", + "userId": "59307d350af58404d8a26300" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/groups/users", + "name": "59307d350af58404d8a26300", + "properties": { + "firstName": "test", + "lastName": "user", + "email": "testuser1@live.com", + "state": "active", + "registrationDate": "2017-06-01T20:46:45.437Z", + "groups": [], + "identities": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/groups/users", + "name": "59307d350af58404d8a26300", + "properties": { + "firstName": "test", + "lastName": "user", + "email": "testuser1@live.com", + "state": "active", + "registrationDate": "2017-06-01T20:46:45.437Z", + "groups": [], + "identities": [] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGrpcApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGrpcApi.json new file mode 100644 index 000000000000..14424894bc26 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateGrpcApi.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "tempgroup", + "parameters": { + "properties": { + "description": "apidescription5200", + "displayName": "apiname1463", + "type": "grpc", + "serviceUrl": "https://your-api-hostname/samples", + "path": "grpc-api", + "protocols": [ + "https" + ], + "format": "grpc-link", + "value": "https://raw.githubusercontent.com/kedacore/keda/main/pkg/scalers/externalscaler/externalscaler.proto" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "https://your-api-hostname/samples", + "type": "grpc", + "path": "grpc-api", + "protocols": [ + "https" + ], + "authenticationSettings": null, + "subscriptionKeyParameterNames": null, + "isCurrent": true, + "isOnline": true + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "https://your-api-hostname/samples", + "type": "grpc", + "path": "grpc-api", + "protocols": [ + "https" + ], + "authenticationSettings": null, + "subscriptionKeyParameterNames": null, + "isCurrent": true, + "isOnline": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateIdentityProvider.json new file mode 100644 index 000000000000..24fa857b8818 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateIdentityProvider.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "identityProviderName": "facebook", + "parameters": { + "properties": { + "clientId": "facebookid", + "clientSecret": "facebookapplicationsecret" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "Facebook", + "properties": { + "clientId": "facebookid", + "type": "facebook" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "Facebook", + "properties": { + "clientId": "facebookid", + "type": "facebook" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json new file mode 100644 index 000000000000..a94d4f42ae57 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json @@ -0,0 +1,280 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "gateway1.msitesting.net", + "encodedCertificate": "****** Base 64 Encoded Certificate ************", + "certificatePassword": "Password", + "defaultSslBinding": true + }, + { + "type": "Management", + "hostName": "mgmt.msitesting.net", + "encodedCertificate": "****** Base 64 Encoded Certificate ************", + "certificatePassword": "Password" + }, + { + "type": "Portal", + "hostName": "portal1.msitesting.net", + "encodedCertificate": "****** Base 64 Encoded Certificate ************", + "certificatePassword": "Password" + }, + { + "type": "ConfigurationApi", + "hostName": "configuration-api.msitesting.net", + "encodedCertificate": "****** Base 64 Encoded Certificate ************", + "certificatePassword": "Password" + } + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "additionalLocations": [ + { + "location": "East US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "disableGateway": true + } + ], + "virtualNetworkType": "None", + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + } + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "West US", + "etag": "AAAAAAACXoo=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2019-12-18T08:04:26.9492661Z", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false + }, + { + "type": "Proxy", + "hostName": "gateway1.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": true + }, + { + "type": "Management", + "hostName": "mgmt.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + }, + { + "type": "Portal", + "hostName": "portal1.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + }, + { + "type": "ConfigurationApi", + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + } + ], + "additionalLocations": [ + { + "location": "East US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "disableGateway": true + } + ], + "virtualNetworkType": "None", + "disableGateway": false, + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + } + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "West US", + "etag": "AAAAAAACXok=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2019-12-18T06:26:20.3348609Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false + }, + { + "type": "Proxy", + "hostName": "gateway1.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": true + }, + { + "type": "Management", + "hostName": "mgmt.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + }, + { + "type": "Portal", + "hostName": "portal1.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + }, + { + "type": "ConfigurationApi", + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + } + ], + "publicIPAddresses": [ + "13.91.32.113" + ], + "additionalLocations": [ + { + "location": "East US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "23.101.138.153" + ], + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "disableGateway": true + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + } + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNamedValue.json new file mode 100644 index 000000000000..a22faa513038 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNamedValue.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "namedValueId": "testprop2", + "parameters": { + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": false + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", + "type": "Microsoft.ApiManagement/service/namedValues", + "name": "testprop2", + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": false, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", + "type": "Microsoft.ApiManagement/service/namedValues", + "name": "testprop2", + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": false, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNamedValueWithKeyVault.json new file mode 100644 index 000000000000..7c29a57de904 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNamedValueWithKeyVault.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "namedValueId": "testprop6", + "parameters": { + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" + }, + "tags": [ + "foo", + "bar" + ], + "secret": true + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "name": "testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + } + }, + "tags": [ + "foo", + "bar" + ], + "secret": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "name": "testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + } + }, + "tags": [ + "foo", + "bar" + ], + "secret": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNotification.json new file mode 100644 index 000000000000..5f7a8db3c9c3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNotification.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "notificationName": "RequestPublisherNotificationMessage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "RequestPublisherNotificationMessage", + "properties": { + "title": "Subscription requests (requiring approval)", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNotificationRecipientEmail.json new file mode 100644 index 000000000000..8244fd7eef56 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNotificationRecipientEmail.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "notificationName": "RequestPublisherNotificationMessage", + "email": "foobar@live.com" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "name": "foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "name": "foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNotificationRecipientUser.json new file mode 100644 index 000000000000..fb7ffeb22d9c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateNotificationRecipientUser.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "notificationName": "RequestPublisherNotificationMessage", + "userId": "576823d0a40f7e74ec07d642" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", + "name": "576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", + "name": "576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateODataApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateODataApi.json new file mode 100644 index 000000000000..373268361974 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateODataApi.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "tempgroup", + "parameters": { + "properties": { + "description": "apidescription5200", + "displayName": "apiname1463", + "type": "odata", + "serviceUrl": "https://services.odata.org/TripPinWebApiService", + "path": "odata-api", + "protocols": [ + "http", + "https" + ], + "format": "odata-link", + "value": "https://services.odata.org/TripPinWebApiService/$metadata" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "https://services.odata.org/TripPinWebApiService", + "type": "odata", + "path": "odata-api", + "protocols": [ + "http", + "https" + ], + "authenticationSettings": null, + "subscriptionKeyParameterNames": null, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "https://services.odata.org/TripPinWebApiService", + "type": "odata", + "path": "odata-api", + "protocols": [ + "http", + "https" + ], + "authenticationSettings": null, + "subscriptionKeyParameterNames": null, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json new file mode 100644 index 000000000000..02dbf67232d4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "opid": "templateOpenIdConnect3", + "parameters": { + "properties": { + "displayName": "templateoidprovider3", + "metadataEndpoint": "https://oidprovider-template3.net", + "clientId": "oidprovidertemplate3", + "clientSecret": "x", + "useInTestConsole": false, + "useInApiDocumentation": true + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "name": "templateOpenIdConnect3", + "properties": { + "displayName": "templateoidprovider3", + "metadataEndpoint": "https://oidprovider-template3.net", + "clientId": "oidprovidertemplate3", + "useInTestConsole": false, + "useInApiDocumentation": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "name": "templateOpenIdConnect3", + "properties": { + "displayName": "templateoidprovider3", + "metadataEndpoint": "https://oidprovider-template3.net", + "clientId": "oidprovidertemplate3", + "useInTestConsole": false, + "useInApiDocumentation": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePolicy.json new file mode 100644 index 000000000000..2b9c6be315cf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePolicy.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyId": "policy", + "parameters": { + "properties": { + "format": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePolicyFragment.json new file mode 100644 index 000000000000..a8329b1c1f3d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePolicyFragment.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "id": "policyFragment1", + "parameters": { + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "name": "policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "", + "provisioningState": "InProgress" + } + } + }, + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "name": "policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "", + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePolicyRestriction.json new file mode 100644 index 000000000000..9600475b673f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePolicyRestriction.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyRestrictionId": "policyRestriction1", + "If-Match": "*", + "parameters": { + "properties": { + "scope": "Sample Path to the policy document.", + "requireBase": "true" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "name": "policyRestrictions1", + "properties": { + "scope": "Sample Path to the policy document.", + "requireBase": "true" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "name": "policyRestrictions2", + "properties": { + "scope": "Sample Path to the policy document.", + "requireBase": "true" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePortalConfig.json new file mode 100644 index 000000000000..789781ed01cb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePortalConfig.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "portalConfigId": "default", + "If-Match": "*", + "parameters": { + "properties": { + "enableBasicAuth": true, + "signin": { + "require": false + }, + "signup": { + "termsOfService": { + "text": "I agree to the service terms and conditions.", + "requireConsent": false + } + }, + "delegation": { + "delegateRegistration": false, + "delegateSubscription": false, + "delegationUrl": null, + "validationKey": null + }, + "csp": { + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ], + "allowedSources": [ + "*.contoso.com" + ] + }, + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", + "type": "Microsoft.ApiManagement/service/portalconfigs", + "name": "default", + "properties": { + "enableBasicAuth": true, + "signin": { + "require": false + }, + "signup": { + "termsOfService": { + "text": "I agree to the service terms and conditions.", + "requireConsent": false + } + }, + "delegation": { + "delegateRegistration": false, + "delegateSubscription": false, + "delegationUrl": null, + "validationKey": null + }, + "csp": { + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ], + "allowedSources": [ + "*.contoso.com" + ] + }, + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePortalRevision.json new file mode 100644 index 000000000000..2de2fab277c0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreatePortalRevision.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "portalRevisionId": "20201112101010", + "parameters": { + "properties": { + "description": "portal revision 1", + "isCurrent": true + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2023-09-01-preview&asyncId=5faf089b1d9a026694220e0c&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5faf089b1d9a026694220e0c?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "name": "20201112101010", + "properties": { + "description": "portal revision 1", + "statusDetails": null, + "status": "completed", + "isCurrent": true, + "createdDateTime": "2020-11-13T22:28:43.657Z", + "updatedDateTime": "2020-11-13T22:29:22.68Z", + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProduct.json new file mode 100644 index 000000000000..53e11fe49891 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProduct.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "parameters": { + "properties": { + "displayName": "Test Template ProductName 4" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", + "type": "Microsoft.ApiManagement/service/products", + "name": "testproduct", + "properties": { + "displayName": "Test Template ProductName 4", + "subscriptionRequired": true, + "approvalRequired": false, + "state": "notPublished" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", + "type": "Microsoft.ApiManagement/service/products", + "name": "testproduct", + "properties": { + "displayName": "Test Template ProductName 4", + "subscriptionRequired": true, + "approvalRequired": false, + "state": "notPublished" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductApi.json new file mode 100644 index 000000000000..615b27bd2804 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductApi.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "apiId": "echo-api" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/apis", + "name": "5931a75ae4bbd512a88c680b", + "properties": { + "displayName": "EchoApi", + "apiRevision": "1", + "serviceUrl": "https://contoso.com/apis/echo", + "path": "", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/apis", + "name": "5931a75ae4bbd512a88c680b", + "properties": { + "displayName": "EchoApi", + "apiRevision": "1", + "serviceUrl": "https://contoso.com/apis/echo", + "path": "", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductApiLink.json new file mode 100644 index 000000000000..24ef5e2530a8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductApiLink.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "apiLinkId": "link1", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductGroup.json new file mode 100644 index 000000000000..a186d39cb4da --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "groupId": "templateGroup" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup", + "type": "Microsoft.ApiManagement/service/products/groups", + "name": "templateGroup", + "properties": { + "displayName": "Template Group", + "description": "group created via Template", + "builtIn": false, + "type": "custom" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup", + "type": "Microsoft.ApiManagement/service/products/groups", + "name": "templateGroup", + "properties": { + "displayName": "Template Group", + "description": "group created via Template", + "builtIn": false, + "type": "custom" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductGroupLink.json new file mode 100644 index 000000000000..aed8bac39231 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductGroupLink.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "groupLinkId": "link1", + "parameters": { + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinkId/link1", + "type": "Microsoft.ApiManagement/service/products/groupLinkId", + "name": "link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinkId/link1", + "type": "Microsoft.ApiManagement/service/products/groupLinkId", + "name": "link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductPolicy.json new file mode 100644 index 000000000000..313c4cbbe9b8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductPolicy.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "5702e97e5157a50f48dce801", + "policyId": "policy", + "parameters": { + "properties": { + "format": "xml", + "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5702e97e5157a50f48dce801/policies/policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5702e97e5157a50f48dce801/policies/policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductTag.json new file mode 100644 index 000000000000..f031a580e84d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductTag.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "5931a75ae4bbd512a88c680b", + "tagId": "tagId1" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductWiki.json new file mode 100644 index 000000000000..f5ae2a081663 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateProductWiki.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "name": "default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "name": "default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateService.json new file mode 100644 index 000000000000..6e40a4f29d8c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateService.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "publisherEmail": "foo@contoso.com", + "publisherName": "foo" + }, + "sku": { + "name": "Developer", + "capacity": 1 + }, + "location": "South Central US", + "tags": { + "Name": "Contoso", + "Test": "User" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "api-version": "2023-09-01-preview" + }, + "location": "East US", + "etag": "AAAAAAAmRAM=", + "properties": { + "publisherEmail": "samir@microsoft.com", + "publisherName": "foo", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "virtualNetworkType": "None", + "disableGateway": false, + "publicNetworkAccess": "Enabled", + "platformVersion": "undetermined" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "user@contoso.com", + "createdByType": "User", + "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "api-version": "2023-09-01-preview" + }, + "location": "East US", + "etag": "AAAAAAAmREI=", + "properties": { + "publisherEmail": "samir@microsoft.com", + "publisherName": "foo", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "publicIPAddresses": [ + "13.90.229.33" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "publicNetworkAccess": "Enabled", + "platformVersion": "stv1" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "user@contoso.com", + "createdByType": "User", + "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceHavingMsi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceHavingMsi.json new file mode 100644 index 000000000000..438af98dbac0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceHavingMsi.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "identity": { + "type": "SystemAssigned" + }, + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "West US", + "etag": "AAAAAAAAWiE=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2019-04-11T16:29:29.9711098Z", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true + } + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "identity": { + "type": "SystemAssigned", + "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4", + "tenantId": "00000000-86f1-41af-91ab-2d7cd011db47" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "West US", + "etag": "AAAAAAAAWiU=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2019-04-11T16:29:29.9711098Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "virtualNetworkType": "None", + "enableClientCertificate": false, + "platformVersion": "mtv1" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "identity": { + "type": "SystemAssigned", + "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4", + "tenantId": "00000000-86f1-41af-91ab-2d7cd011db47" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceInVnetWithPublicIP.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceInVnetWithPublicIP.json new file mode 100644 index 000000000000..8595ee7cf2c8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceInVnetWithPublicIP.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant" + }, + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet", + "virtualNetworkType": "External" + }, + "sku": { + "name": "Premium", + "capacity": 2 + }, + "zones": [ + "1", + "2" + ], + "location": "East US 2 EUAP", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "East US 2 EUAP", + "etag": "AAAAAAAiXto=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2020-07-28T23:18:14.6562474Z", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant" + }, + "virtualNetworkType": "External", + "disableGateway": false, + "platformVersion": "stv2.1" + }, + "sku": { + "name": "Premium", + "capacity": 2 + }, + "zones": [ + "1", + "2" + ], + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "East US 2 EUAP", + "etag": "AAAAAAAGTAs=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-02-22T06:53:46.6409875Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-eastus2euap-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true + } + ], + "publicIPAddresses": [ + "20.47.137.XXX" + ], + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant" + }, + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "External", + "disableGateway": false, + "platformVersion": "stv2" + }, + "sku": { + "name": "Premium", + "capacity": 2 + }, + "zones": [ + "1", + "2" + ], + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceInZones.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceInZones.json new file mode 100644 index 000000000000..cc15e6f2f90d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceInZones.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" + }, + "sku": { + "name": "Premium", + "capacity": 2 + }, + "zones": [ + "1", + "2" + ], + "location": "North europe", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "North Europe", + "etag": "AAAAAAAiXto=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2020-07-28T23:18:14.6562474Z", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "virtualNetworkType": "None", + "disableGateway": false, + "platformVersion": "stv2" + }, + "sku": { + "name": "Premium", + "capacity": 2 + }, + "zones": [ + "1", + "2" + ], + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "North Europe", + "etag": "AAAAAAAiXvE=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2020-07-28T23:18:14.6562474Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true + } + ], + "publicIPAddresses": [ + "20.54.34.66" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "platformVersion": "stv2" + }, + "sku": { + "name": "Premium", + "capacity": 2 + }, + "zones": [ + "1", + "2" + ], + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceSkuv2Service.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceSkuv2Service.json new file mode 100644 index 000000000000..91e768c75cc7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceSkuv2Service.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" + }, + "sku": { + "name": "StandardV2", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned" + }, + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "East US", + "etag": "AAAAAAA3h2Q=", + "properties": { + "publisherEmail": "apim@contoso.com", + "publisherName": "apimgmt-skuv2", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Activating", + "targetProvisioningState": "Activating", + "createdAtUtc": "2023-08-11T18:24:14.7662749Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "natGatewayState": "Unsupported", + "publicNetworkAccess": "Enabled", + "platformVersion": "undetermined", + "legacyPortalStatus": "Disabled", + "developerPortalStatus": "Disabled" + }, + "sku": { + "name": "StandardV2", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned", + "principalId": "de161222-0000-0000-0000-1caa5d9f0b0e", + "tenantId": "72f988bf-0000-0000-0000-2d7cd011db47" + }, + "zones": null, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2023-08-11T18:24:13.7820033Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-11T18:24:13.7820033Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "East US", + "etag": "AAAAAAA3fHM=", + "properties": { + "publisherEmail": "apim@contoso.com", + "publisherName": "apimgmt-skuv2", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2023-08-10T18:50:52.5509471Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "natGatewayState": "Unsupported", + "publicNetworkAccess": "Enabled", + "platformVersion": "undetermined" + }, + "sku": { + "name": "StandardV2", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned", + "principalId": "de161222-0000-0000-0000-1caa5d9f0b0e", + "tenantId": "72f988bf-0000-0000-0000-2d7cd011db47" + }, + "zones": null, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2023-08-10T18:50:51.539583Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-10T18:50:51.539583Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithCustomHostnameKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithCustomHostnameKeyVault.json new file mode 100644 index 000000000000..b20783fd5433 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithCustomHostnameKeyVault.json @@ -0,0 +1,306 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "gateway1.msitesting.net", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "defaultSslBinding": true + }, + { + "type": "Management", + "hostName": "mgmt.msitesting.net", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468" + }, + { + "type": "Portal", + "hostName": "portal1.msitesting.net", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468" + }, + { + "type": "ConfigurationApi", + "hostName": "configuration-api.msitesting.net", + "encodedCertificate": "****** Base 64 Encoded Certificate ************", + "certificatePassword": "Password" + } + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "virtualNetworkType": "None", + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + } + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "North Europe", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "North Europe", + "etag": "AAAAAAAigi8=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2020-09-13T22:30:20.7759747Z", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificateSource": "BuiltIn" + }, + { + "type": "Proxy", + "hostName": "gateway1.msitesting.net", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2037-01-01T07:00:00+00:00", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": true, + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "certificateSource": "KeyVault" + }, + { + "type": "Management", + "hostName": "mgmt.msitesting.net", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2037-01-01T07:00:00+00:00", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false, + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "certificateSource": "KeyVault" + }, + { + "type": "Portal", + "hostName": "portal1.msitesting.net", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2037-01-01T07:00:00+00:00", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false, + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "certificateSource": "KeyVault" + }, + { + "type": "ConfigurationApi", + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + } + ], + "virtualNetworkType": "None", + "disableGateway": false, + "platformVersion": "stv2", + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + } + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "North Europe", + "etag": "AAAAAAAigjU=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2020-09-13T22:30:20.7759747Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificateSource": "BuiltIn" + }, + { + "type": "Proxy", + "hostName": "gateway1.msitesting.net", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2037-01-01T07:00:00+00:00", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": true, + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "certificateSource": "KeyVault" + }, + { + "type": "Management", + "hostName": "mgmt.msitesting.net", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2037-01-01T07:00:00+00:00", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false, + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "certificateSource": "KeyVault" + }, + { + "type": "Portal", + "hostName": "portal1.msitesting.net", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2037-01-01T07:00:00+00:00", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false, + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "certificateSource": "KeyVault" + }, + { + "type": "ConfigurationApi", + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + } + ], + "publicIPAddresses": [ + "40.112.74.192" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "platformVersion": "stv2", + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + } + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "identity": { + "type": "UserAssigned", + "tenantId": "f686d426-8d16-0000-0000-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "15e769b2-0000-0000-0000-3fd9a923ac3a", + "clientId": "329419bc-adec-4dce-9568-25a6d486e468" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithDeveloperPortal.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithDeveloperPortal.json new file mode 100644 index 000000000000..0094e7526935 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithDeveloperPortal.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "publisherEmail": "foo@contoso.com", + "publisherName": "foo", + "developerPortalStatus": "Enabled" + }, + "sku": { + "name": "Developer", + "capacity": 1 + }, + "location": "South Central US", + "tags": { + "Name": "Contoso", + "Test": "User" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "api-version": "2023-09-01-preview" + }, + "location": "East US", + "etag": "AAAAAAAmRAM=", + "properties": { + "publisherEmail": "samir@microsoft.com", + "publisherName": "foo", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "virtualNetworkType": "None", + "disableGateway": false, + "publicNetworkAccess": "Enabled", + "platformVersion": "undetermined", + "legacyPortalStatus": "Disabled", + "developerPortalStatus": "Enabled" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "user@contoso.com", + "createdByType": "User", + "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "api-version": "2023-09-01-preview" + }, + "location": "East US", + "etag": "AAAAAAAmREI=", + "properties": { + "publisherEmail": "samir@microsoft.com", + "publisherName": "foo", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "publicIPAddresses": [ + "13.90.229.33" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "publicNetworkAccess": "Enabled", + "platformVersion": "stv1" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "user@contoso.com", + "createdByType": "User", + "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithNatGatewayEnabled.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithNatGatewayEnabled.json new file mode 100644 index 000000000000..dab6d6f560fd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithNatGatewayEnabled.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "natGatewayState": "Enabled" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "location": "East US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "api-version": "2023-09-01-preview" + }, + "location": "East US", + "etag": "AAAAAAAmRAM=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "privateIPAddresses": null, + "additionalLocations": null, + "virtualNetworkConfiguration": null, + "virtualNetworkType": "None", + "certificates": null, + "disableGateway": false, + "natGatewayState": "Enabled", + "apiVersionConstraint": { + "minApiVersion": null + }, + "publicIpAddressId": null, + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": null, + "platformVersion": "stv2" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "identity": null, + "zones": null, + "systemData": { + "createdBy": "user@contoso.com", + "createdByType": "User", + "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "api-version": "2023-09-01-preview" + }, + "location": "East US", + "etag": "AAAAAAAmREI=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2022-07-26T18:41:01.2506031Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "publicIPAddresses": [ + "13.90.229.33" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "natGatewayState": "Enabled", + "outboundPublicIPAddresses": [ + "60.0.0.0/31" + ], + "apiVersionConstraint": { + "minApiVersion": null + }, + "publicNetworkAccess": "Enabled", + "platformVersion": "stv2" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "systemData": { + "createdBy": "user@contoso.com", + "createdByType": "User", + "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithSystemCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithSystemCertificates.json new file mode 100644 index 000000000000..e4def3e4095c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithSystemCertificates.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "certificates": [ + { + "encodedCertificate": "*******Base64 encoded Certificate******************", + "certificatePassword": "Password", + "storeName": "CertificateAuthority" + } + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "location": "Central US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "Central US", + "etag": "AAAAAAAp3TM=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2019-12-18T06:33:28.0906918Z", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true + } + ], + "virtualNetworkType": "None", + "certificates": [ + { + "storeName": "CertificateAuthority", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + } + } + ], + "disableGateway": false, + "platformVersion": "stv2", + "apiVersionConstraint": {} + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "Central US", + "etag": "AAAAAAAp3UM=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2019-12-18T06:33:28.0906918Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-centralus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "publicIPAddresses": [ + "40.113.223.117" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "certificates": [ + { + "storeName": "CertificateAuthority", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + } + } + ], + "disableGateway": false, + "platformVersion": "stv2", + "apiVersionConstraint": {} + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithUserAssignedIdentity.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithUserAssignedIdentity.json new file mode 100644 index 000000000000..02f8f01f3758 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithUserAssignedIdentity.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {} + } + }, + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "West US", + "etag": "AAAAAAAFzyQ=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2020-03-12T01:05:33.4573398Z", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "virtualNetworkType": "None", + "platformVersion": "mtv1" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {} + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "West US", + "etag": "AAAAAAAFzyk=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2020-03-12T01:05:33.4573398Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "platformVersion": "mtv1" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "identity": { + "type": "UserAssigned", + "tenantId": "00000000-86f1-41af-0000-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": { + "principalId": "00000000-6e62-4649-9f54-a119fc1ba85e", + "clientId": "5a2c6b8e-0905-0000-a772-993c9418137f" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json new file mode 100644 index 000000000000..24375d123e4a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "configurationApi": { + "legacyApi": "Disabled" + } + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "location": "Central US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "Central US", + "etag": "AAAAAAAp3TM=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2019-12-18T06:33:28.0906918Z", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true + } + ], + "virtualNetworkType": "None", + "certificates": [], + "disableGateway": false, + "configurationApi": { + "legacyApi": "Disabled" + }, + "platformVersion": "stv2", + "apiVersionConstraint": {} + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "Central US", + "etag": "AAAAAAAp3UM=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2019-12-18T06:33:28.0906918Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-centralus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "publicIPAddresses": [ + "40.113.223.117" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "certificates": [], + "disableGateway": false, + "configurationApi": { + "legacyApi": "Disabled" + }, + "platformVersion": "stv2", + "apiVersionConstraint": {} + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json new file mode 100644 index 000000000000..32568098b201 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "soapApi", + "parameters": { + "properties": { + "format": "wsdl-link", + "value": "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL", + "path": "currency", + "apiType": "soap", + "wsdlSelector": { + "wsdlServiceName": "CurrencyConvertor", + "wsdlEndpointName": "CurrencyConvertorSoap" + } + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "soapApi", + "properties": { + "displayName": "CurrencyConvertor", + "apiRevision": "1", + "serviceUrl": "http://www.webservicex.net", + "path": "currency", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "type": "soap", + "isCurrent": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "soapApi", + "properties": { + "displayName": "CurrencyConvertor", + "apiRevision": "1", + "serviceUrl": "http://www.webservicex.net", + "path": "currency", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "type": "soap", + "isCurrent": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json new file mode 100644 index 000000000000..fd8c8ddf7f1c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "soapApi", + "parameters": { + "properties": { + "format": "wsdl-link", + "value": "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL", + "path": "currency", + "wsdlSelector": { + "wsdlServiceName": "CurrencyConvertor", + "wsdlEndpointName": "CurrencyConvertorSoap" + } + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "soapApi", + "properties": { + "displayName": "CurrencyConvertor", + "apiRevision": "1", + "serviceUrl": "http://www.webservicex.net", + "path": "currency", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "soapApi", + "properties": { + "displayName": "CurrencyConvertor", + "apiRevision": "1", + "serviceUrl": "http://www.webservicex.net", + "path": "currency", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateStandardGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateStandardGateway.json new file mode 100644 index 000000000000..38c2066910ef --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateStandardGateway.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "gatewayName": "apimGateway1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + } + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "location": "South Central US", + "tags": { + "Name": "Contoso", + "Test": "User" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", + "name": "apimGateway1", + "type": "Microsoft.ApiManagement/gateway", + "tags": { + "api-version": "2023-09-01-preview" + }, + "location": "East US", + "etag": "AAAAAAAmRAM=", + "properties": { + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + } + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "user@contoso.com", + "createdByType": "User", + "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", + "name": "apimGateway1", + "type": "Microsoft.ApiManagement/gateways", + "tags": { + "api-version": "2023-09-01-preview" + }, + "location": "East US", + "etag": "AAAAAAAmREI=", + "properties": { + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "frontend": { + "defaultHostname": "apimGateway1.eastus.gateway.azure-api.net" + }, + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "configurationApi": { + "hostname": "apimGateway1.eastus.configuration.gateway.azure-api.net" + } + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "user@contoso.com", + "createdByType": "User", + "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateSubscription.json new file mode 100644 index 000000000000..7c5985a10110 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateSubscription.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "sid": "testsub", + "parameters": { + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "displayName": "testsub" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "testsub", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "displayName": "testsub", + "state": "submitted", + "createdDate": "2017-06-02T23:34:03.1055076Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "testsub", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "displayName": "testsub", + "state": "submitted", + "createdDate": "2017-06-02T23:34:03.1055076Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTag.json new file mode 100644 index 000000000000..8fa8aacf09db --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTag.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tagId1", + "parameters": { + "properties": { + "displayName": "tag1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTagApiLink.json new file mode 100644 index 000000000000..47523b182b40 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTagApiLink.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "apiLinkId": "link1", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTagOperationLink.json new file mode 100644 index 000000000000..c49af881cfb2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTagOperationLink.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "operationLinkId": "link1", + "parameters": { + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "name": "link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "name": "link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTagProductLink.json new file mode 100644 index 000000000000..50cd2806f863 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTagProductLink.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "productLinkId": "link1", + "parameters": { + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "name": "link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "name": "link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTemplate.json new file mode 100644 index 000000000000..392aedceec6d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTemplate.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage", + "parameters": { + "properties": { + "subject": "Your request for $IssueName was successfully received." + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "name": "NewIssueNotificationMessage", + "properties": { + "subject": "Your request for $IssueName was successfully received.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "title": "New issue received", + "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "isDefault": false, + "parameters": [ + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "IssueId", + "title": "Issue id" + }, + { + "name": "IssueName", + "title": "Issue name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "name": "NewIssueNotificationMessage", + "properties": { + "subject": "Your request for $IssueName was successfully received.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "title": "New issue received", + "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "isDefault": false, + "parameters": [ + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "IssueId", + "title": "Issue id" + }, + { + "name": "IssueName", + "title": "Issue name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTenantAccess.json new file mode 100644 index 000000000000..91945c7d7c41 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateTenantAccess.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "If-Match": "*", + "accessName": "access", + "parameters": { + "properties": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", + "type": "Microsoft.ApiManagement/service/tenant", + "name": "access", + "properties": { + "enabled": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateUser.json new file mode 100644 index 000000000000..5d1a1d10dd27 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateUser.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b", + "parameters": { + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com", + "confirmation": "signup" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b", + "type": "Microsoft.ApiManagement/service/users", + "name": "5931a75ae4bbd512288c680b", + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com", + "state": "active", + "registrationDate": "2018-01-07T21:21:29.16Z", + "groups": [], + "identities": [ + { + "provider": "Basic", + "id": "foobar@outlook.com" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b", + "type": "Microsoft.ApiManagement/service/users", + "name": "5931a75ae4bbd512288c680b", + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com", + "state": "active", + "registrationDate": "2018-01-07T21:21:29.16Z", + "groups": [], + "identities": [ + { + "provider": "Basic", + "id": "foobar@outlook.com" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWebsocketApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWebsocketApi.json new file mode 100644 index 000000000000..c7c6de51cd55 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWebsocketApi.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "tempgroup", + "parameters": { + "properties": { + "description": "apidescription5200", + "displayName": "apiname1463", + "type": "websocket", + "serviceUrl": "wss://echo.websocket.org", + "path": "newapiPath", + "protocols": [ + "wss", + "ws" + ] + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "wss://echo.websocket.org", + "type": "websocket", + "path": "newapiPath", + "protocols": [ + "ws", + "wss" + ], + "authenticationSettings": null, + "subscriptionKeyParameterNames": null, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "wss://echo.websocket.org", + "type": "websocket", + "path": "newapiPath", + "protocols": [ + "ws", + "wss" + ], + "authenticationSettings": null, + "subscriptionKeyParameterNames": null, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspace.json new file mode 100644 index 000000000000..9d008d92a1e1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspace.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "parameters": { + "properties": { + "displayName": "my workspace", + "description": "workspace 1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "name": "wks1", + "properties": { + "description": "workspace 1", + "displayName": "my workspace" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "name": "wks1", + "properties": { + "description": "workspace 1", + "displayName": "my workspace" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceAILogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceAILogger.json new file mode 100644 index 000000000000..9c7308a09f97 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceAILogger.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "loggerId": "loggerId", + "parameters": { + "properties": { + "loggerType": "applicationInsights", + "description": "adding a new logger", + "credentials": { + "instrumentationKey": "11................a1" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "name": "loggerId", + "properties": { + "loggerType": "applicationInsights", + "description": null, + "credentials": { + "instrumentationKey": "{{5a.......2a}}" + }, + "isBuffered": false, + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.insights/components/airesource" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "name": "loggerId", + "properties": { + "loggerType": "applicationInsights", + "description": null, + "credentials": { + "instrumentationKey": "{{5a.......2a}}" + }, + "isBuffered": false + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApi.json new file mode 100644 index 000000000000..de3f8c24e382 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApi.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "tempgroup", + "parameters": { + "properties": { + "description": "apidescription5200", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "displayName": "apiname1463", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "https", + "http" + ] + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "http", + "https" + ], + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "http", + "https" + ], + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "isCurrent": true, + "isOnline": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiDiagnostic.json new file mode 100644 index 000000000000..6e7939fc2260 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiDiagnostic.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiOperation.json new file mode 100644 index 000000000000..3c58faabb4ea --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiOperation.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "PetStoreTemplate2", + "operationId": "newoperations", + "parameters": { + "properties": { + "displayName": "createUser2", + "method": "POST", + "urlTemplate": "/user1", + "templateParameters": [], + "description": "This can only be done by the logged in user.", + "request": { + "description": "Created user object", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "successful operation", + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "headers": [] + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "name": "newoperations", + "properties": { + "displayName": "createUser2", + "method": "POST", + "urlTemplate": "/user1", + "templateParameters": [], + "description": "This can only be done by the logged in user.", + "request": { + "description": "Created user object", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "successful operation", + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "headers": [] + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "name": "newoperations", + "properties": { + "displayName": "createUser2", + "method": "POST", + "urlTemplate": "/user1", + "templateParameters": [], + "description": "This can only be done by the logged in user.", + "request": { + "description": "Created user object", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "successful operation", + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "headers": [] + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiOperationPolicy.json new file mode 100644 index 000000000000..b160db4a5b77 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiOperationPolicy.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "5600b57e7e8880006a040001", + "operationId": "5600b57e7e8880006a080001", + "policyId": "policy", + "If-Match": "*", + "parameters": { + "properties": { + "format": "xml", + "value": " " + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiPolicy.json new file mode 100644 index 000000000000..6af780542a7c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiPolicy.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "5600b57e7e8880006a040001", + "policyId": "policy", + "If-Match": "*", + "parameters": { + "properties": { + "format": "xml", + "value": " " + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiRelease.json new file mode 100644 index 000000000000..8c67be19caa5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiRelease.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "a1", + "releaseId": "testrev", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "notes": "yahooagain" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/testrev", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "name": "testrev", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "createdDateTime": "2018-02-08T20:52:00.65Z", + "updatedDateTime": "2018-02-08T20:52:00.65Z", + "notes": "yahooagain" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/testrev", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "name": "testrev", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "createdDateTime": "2018-02-08T20:52:00.65Z", + "updatedDateTime": "2018-02-08T20:52:00.65Z", + "notes": "yahooagain" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiSchema.json new file mode 100644 index 000000000000..ef1e0da42232 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiSchema.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "parameters": { + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + }, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + }, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiVersionSet.json new file mode 100644 index 000000000000..5156b8bd87a4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceApiVersionSet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "versionSetId": "api1", + "parameters": { + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/api1", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "name": "api1", + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/api1", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "name": "api1", + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceBackendProxyBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceBackendProxyBackend.json new file mode 100644 index 000000000000..f308e3be060c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceBackendProxyBackend.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "backendId": "proxybackend", + "parameters": { + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "tls": { + "validateCertificateChain": true, + "validateCertificateName": true + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "" + }, + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "name": "proxybackend", + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "name": "proxybackend", + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceBackendServiceFabric.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceBackendServiceFabric.json new file mode 100644 index 000000000000..2c2d3298d481 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceBackendServiceFabric.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "backendId": "sfbackend", + "parameters": { + "properties": { + "description": "Service Fabric Test App 1", + "protocol": "http", + "url": "fabric:/mytestapp/mytestservice", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceCertificate.json new file mode 100644 index 000000000000..c40749ad04ac --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceCertificate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "certificateId": "tempcert", + "parameters": { + "properties": { + "data": "****************Base 64 Encoded Certificate *******************************", + "password": "****Certificate Password******" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/tempcert", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "name": "tempcert", + "properties": { + "subject": "CN=contoso.com", + "thumbprint": "*******************3", + "expirationDate": "2018-03-17T21:55:07+00:00" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/tempcert", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "name": "tempcert", + "properties": { + "subject": "CN=contoso.com", + "thumbprint": "*******************3", + "expirationDate": "2018-03-17T21:55:07+00:00" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceCertificateWithKeyVault.json new file mode 100644 index 000000000000..cc207b2e1165 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceCertificateWithKeyVault.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "certificateId": "templateCertkv", + "parameters": { + "properties": { + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "name": "templateCertkv", + "properties": { + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690", + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "name": "templateCertkv", + "properties": { + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690", + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceDiagnostic.json new file mode 100644 index 000000000000..3c684c487b4e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceDiagnostic.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "diagnosticId": "applicationinsights", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/workspaces/wks1/loggers/azuremonitor", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/workspaces/wks1/loggers/azuremonitor", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceEHLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceEHLogger.json new file mode 100644 index 000000000000..0bf92aa65b9d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceEHLogger.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "loggerId": "eh1", + "parameters": { + "properties": { + "loggerType": "azureEventHub", + "description": "adding a new logger", + "credentials": { + "name": "hydraeventhub", + "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********=" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "name": "eh1", + "properties": { + "loggerType": "azureEventHub", + "description": "adding a new logger", + "credentials": { + "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" + }, + "isBuffered": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "name": "eh1", + "properties": { + "loggerType": "azureEventHub", + "description": "adding a new logger", + "credentials": { + "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" + }, + "isBuffered": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceGroup.json new file mode 100644 index 000000000000..fcd32f6c2605 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "groupId": "tempgroup", + "parameters": { + "properties": { + "displayName": "temp group" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "name": "tempgroup", + "properties": { + "displayName": "temp group", + "type": "custom" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "name": "tempgroup", + "properties": { + "displayName": "temp group", + "type": "custom" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceGroupExternal.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceGroupExternal.json new file mode 100644 index 000000000000..12a2a199588b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceGroupExternal.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "groupId": "aadGroup", + "parameters": { + "properties": { + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "description": "new group to test", + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/aadGroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "name": "aadGroup", + "properties": { + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "description": "new group to test", + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/aadGroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "name": "aadGroup", + "properties": { + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "description": "new group to test", + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceGroupUser.json new file mode 100644 index 000000000000..f61a6e139f65 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceGroupUser.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "groupId": "tempgroup", + "userId": "59307d350af58404d8a26300" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/workspaces/groups/users", + "name": "59307d350af58404d8a26300", + "properties": { + "firstName": "test", + "lastName": "user", + "email": "testuser1@live.com", + "state": "active", + "registrationDate": "2017-06-01T20:46:45.437Z", + "groups": [], + "identities": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/workspaces/groups/users", + "name": "59307d350af58404d8a26300", + "properties": { + "firstName": "test", + "lastName": "user", + "email": "testuser1@live.com", + "state": "active", + "registrationDate": "2017-06-01T20:46:45.437Z", + "groups": [], + "identities": [] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNamedValue.json new file mode 100644 index 000000000000..a5aa48d53250 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNamedValue.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "namedValueId": "testprop2", + "parameters": { + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": false + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "name": "testprop2", + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": false, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "name": "testprop2", + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": false, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json new file mode 100644 index 000000000000..ef127e5e2486 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "namedValueId": "testprop6", + "parameters": { + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" + }, + "tags": [ + "foo", + "bar" + ], + "secret": true + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "name": "testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + } + }, + "tags": [ + "foo", + "bar" + ], + "secret": true, + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "name": "testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + } + }, + "tags": [ + "foo", + "bar" + ], + "secret": true, + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNotification.json new file mode 100644 index 000000000000..c6c76b23e0d9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNotification.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "notificationName": "RequestPublisherNotificationMessage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/workspaces/notifications", + "name": "RequestPublisherNotificationMessage", + "properties": { + "title": "Subscription requests (requiring approval)", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientEmail.json new file mode 100644 index 000000000000..aa6613b8ab51 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientEmail.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "notificationName": "RequestPublisherNotificationMessage", + "email": "foobar@live.com" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "name": "foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "name": "foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientUser.json new file mode 100644 index 000000000000..656ef6951d01 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientUser.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "notificationName": "RequestPublisherNotificationMessage", + "userId": "576823d0a40f7e74ec07d642" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers", + "name": "576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers", + "name": "576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePolicy.json new file mode 100644 index 000000000000..cd7962e25c7d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePolicy.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "policyId": "policy", + "If-Match": "*", + "parameters": { + "properties": { + "format": "xml", + "value": " " + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePolicyFragment.json new file mode 100644 index 000000000000..0ba23580dd52 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePolicyFragment.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "id": "policyFragment1", + "parameters": { + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "name": "policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "", + "provisioningState": "InProgress" + } + } + }, + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "name": "policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "", + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json new file mode 100644 index 000000000000..ab1139140cc5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "policyId": "policy", + "If-Match": "*", + "parameters": { + "properties": { + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n ", + "format": "rawxml" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePremiumGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePremiumGateway.json new file mode 100644 index 000000000000..22737f955006 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspacePremiumGateway.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "gatewayName": "apimGateway1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "WorkspaceGatewayPremium", + "capacity": 1 + }, + "location": "South Central US", + "tags": { + "Name": "Contoso", + "Test": "User" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", + "name": "apimGateway1", + "type": "Microsoft.ApiManagement/gateway", + "tags": { + "api-version": "2023-09-01-preview" + }, + "location": "East US", + "etag": "AAAAAAAmRAM=", + "properties": { + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "WorkspaceGatewayPremium", + "capacity": 1 + }, + "systemData": { + "createdBy": "user@contoso.com", + "createdByType": "User", + "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", + "name": "apimGateway1", + "type": "Microsoft.ApiManagement/gateways", + "tags": { + "api-version": "2023-09-01-preview" + }, + "location": "East US", + "etag": "AAAAAAAmREI=", + "properties": { + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "WorkspaceGatewayPremium", + "capacity": 1 + }, + "systemData": { + "createdBy": "user@contoso.com", + "createdByType": "User", + "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProduct.json new file mode 100644 index 000000000000..dea2a1932f75 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProduct.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "testproduct", + "parameters": { + "properties": { + "displayName": "Test Template ProductName 4" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "name": "testproduct", + "properties": { + "displayName": "Test Template ProductName 4", + "subscriptionRequired": true, + "approvalRequired": false, + "state": "notPublished" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "name": "testproduct", + "properties": { + "displayName": "Test Template ProductName 4", + "subscriptionRequired": true, + "approvalRequired": false, + "state": "notPublished" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProductApiLink.json new file mode 100644 index 000000000000..f86990996d23 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProductApiLink.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "testproduct", + "apiLinkId": "link1", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProductGroupLink.json new file mode 100644 index 000000000000..769ad032219b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProductGroupLink.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "testproduct", + "groupLinkId": "link1", + "parameters": { + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/groupLinkId/link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/groupLinkId", + "name": "link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/groupLinkId/link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/groupLinkId", + "name": "link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProductPolicy.json new file mode 100644 index 000000000000..851251dbcc1e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceProductPolicy.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "5702e97e5157a50f48dce801", + "policyId": "policy", + "parameters": { + "properties": { + "format": "xml", + "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5702e97e5157a50f48dce801/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/products/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5702e97e5157a50f48dce801/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/products/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceSchema.json new file mode 100644 index 000000000000..7fa63ccd2ba5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceSchema.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "schemaId": "schema1", + "parameters": { + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "name": "schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n", + "provisioningState": "InProgress" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "name": "schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n", + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceSubscription.json new file mode 100644 index 000000000000..016aaec7fbce --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceSubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "sid": "testsub", + "parameters": { + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", + "displayName": "testsub" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub", + "type": "Microsoft.ApiManagement/service/workspaces.subscriptions", + "name": "testsub", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", + "displayName": "testsub", + "state": "submitted", + "createdDate": "2017-06-02T23:34:03.1055076Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub", + "type": "Microsoft.ApiManagement/service/workspaces.subscriptions", + "name": "testsub", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", + "displayName": "testsub", + "state": "submitted", + "createdDate": "2017-06-02T23:34:03.1055076Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTag.json new file mode 100644 index 000000000000..9a1392e56cc8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTag.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tagId1", + "parameters": { + "properties": { + "displayName": "tag1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTagApiLink.json new file mode 100644 index 000000000000..9005796f155d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTagApiLink.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tag1", + "apiLinkId": "link1", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTagOperationLink.json new file mode 100644 index 000000000000..b29f5dce3e9a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTagOperationLink.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tag1", + "operationLinkId": "link1", + "parameters": { + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", + "name": "link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", + "name": "link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTagProductLink.json new file mode 100644 index 000000000000..177a292cb1d7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementCreateWorkspaceTagProductLink.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tag1", + "productLinkId": "link1", + "parameters": { + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", + "name": "link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", + "name": "link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApi.json new file mode 100644 index 000000000000..37c01644488d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApi.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "echo-api", + "If-Match": "*" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512288c680b?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=204", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiDiagnostic.json new file mode 100644 index 000000000000..f562cee25b1f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiDiagnostic.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a", + "If-Match": "*" + }, + "responses": { + "204": {}, + "200": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiIssue.json new file mode 100644 index 000000000000..2993d95eafcf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiIssue.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiIssueAttachment.json new file mode 100644 index 000000000000..8af7a13d5255 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiIssueAttachment.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "attachmentId": "57d2ef278aa04f0888cba3f3", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiIssueComment.json new file mode 100644 index 000000000000..434111bc15eb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiIssueComment.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "commentId": "599e29ab193c3c0bd0b3e2fb", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiOperation.json new file mode 100644 index 000000000000..11eabbc49932 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiOperation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0ad01d6cdc", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiOperationPolicy.json new file mode 100644 index 000000000000..b071a2be8882 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiOperationPolicy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "testapi", + "operationId": "testoperation", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiOperationTag.json new file mode 100644 index 000000000000..07c4474c69ae --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiOperationTag.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d5b28d1f7fab116c282650", + "operationId": "59d5b28d1f7fab116c282651", + "tagId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiPolicy.json new file mode 100644 index 000000000000..f9a9425e1449 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiPolicy.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "loggerId", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiRelease.json new file mode 100644 index 000000000000..a31d4c87b856 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiRelease.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5a5fcc09124a7fa9b89f2f1d", + "releaseId": "testrev", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiSchema.json new file mode 100644 index 000000000000..0e4d0ebdbb4d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiSchema.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d5b28d1f7fab116c282650", + "schemaId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiTag.json new file mode 100644 index 000000000000..ea94a78ced52 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiTag.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d5b28d1f7fab116c282650", + "tagId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiTagDescription.json new file mode 100644 index 000000000000..4ddb96ea3a7f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiTagDescription.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d5b28d1f7fab116c282650", + "tagDescriptionId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiVersionSet.json new file mode 100644 index 000000000000..77fb6e265fb8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiVersionSet.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "a1", + "If-Match": "*" + }, + "responses": { + "204": {}, + "200": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiWiki.json new file mode 100644 index 000000000000..5dd02aa80f73 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteApiWiki.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorization.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorization.json new file mode 100644 index 000000000000..f22025e74671 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorization.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "authorizationId": "authz1", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorizationAccessPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorizationAccessPolicy.json new file mode 100644 index 000000000000..ca3a10afbf62 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorizationAccessPolicy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "authorizationId": "authz1", + "authorizationAccessPolicyId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorizationProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorizationProvider.json new file mode 100644 index 000000000000..b630b278158c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorizationProvider.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorizationServer.json new file mode 100644 index 000000000000..167baa8e6fd5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteAuthorizationServer.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authsid": "newauthServer2", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteBackend.json new file mode 100644 index 000000000000..ca77a569161f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteBackend.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "backendId": "sfbackend", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteCache.json new file mode 100644 index 000000000000..015adef17325 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteCache.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "cacheId": "southindia", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteCertificate.json new file mode 100644 index 000000000000..38b1fd01fdac --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteCertificate.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "certificateId": "tempcert", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteContentType.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteContentType.json new file mode 100644 index 000000000000..548d5c45511e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteContentType.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "contentTypeId": "page", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteContentTypeContentItem.json new file mode 100644 index 000000000000..adf2ddc314ed --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteContentTypeContentItem.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "contentTypeId": "page", + "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteDiagnostic.json new file mode 100644 index 000000000000..d541b1deb01c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteDiagnostic.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "diagnosticId": "applicationinsights", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteDocumentation.json new file mode 100644 index 000000000000..0b0f73f3d0bd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteDocumentation.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "documentationId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGateway.json new file mode 100644 index 000000000000..f3ee6288e827 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGateway.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayApi.json new file mode 100644 index 000000000000..7da1f7922e44 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayApi.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "apiId": "echo-api", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayCertificateAuthority.json new file mode 100644 index 000000000000..0a484e2f87f4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayCertificateAuthority.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "certificateId": "default", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayConfigConnection.json new file mode 100644 index 000000000000..0d2ae34751c8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayConfigConnection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayName": "standard-gw-01", + "configConnectionName": "gcc-01", + "If-Match": "*" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-01?api-version=2023-09-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-01?api-version=2023-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayHostnameConfiguration.json new file mode 100644 index 000000000000..cf3fae646fbd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGatewayHostnameConfiguration.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "hcId": "default", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGlobalSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGlobalSchema.json new file mode 100644 index 000000000000..dc75379ccc0e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGlobalSchema.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "schemaId": "schema1", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGraphQLApiResolver.json new file mode 100644 index 000000000000..da0c0c61bef2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGraphQLApiResolver.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "resolverId": "57d2ef278aa04f0ad01d6cdc", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGraphQLApiResolverPolicy.json new file mode 100644 index 000000000000..2569a1ec6f31 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGraphQLApiResolverPolicy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "testapi", + "resolverId": "testResolver", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGroup.json new file mode 100644 index 000000000000..b1b03aec4c6b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGroup.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "aadGroup", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGroupUser.json new file mode 100644 index 000000000000..d6017d17e7ab --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteGroupUser.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "templategroup", + "userId": "59307d350af58404d8a26300", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteIdentityProvider.json new file mode 100644 index 000000000000..2487c7838c6e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteIdentityProvider.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "identityProviderName": "aad", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteLogger.json new file mode 100644 index 000000000000..54145fe3ea3b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteLogger.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "loggerId": "loggerId", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteNamedValue.json new file mode 100644 index 000000000000..88fea9365a43 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteNamedValue.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "namedValueId": "testprop2", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteNotificationRecipientEmail.json new file mode 100644 index 000000000000..881e17135cb6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteNotificationRecipientEmail.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "notificationName": "RequestPublisherNotificationMessage", + "email": "contoso@live.com" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteNotificationRecipientUser.json new file mode 100644 index 000000000000..80307967a157 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteNotificationRecipientUser.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "notificationName": "RequestPublisherNotificationMessage", + "userId": "576823d0a40f7e74ec07d642" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteOpenIdConnectProvider.json new file mode 100644 index 000000000000..1c33d92a6519 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteOpenIdConnectProvider.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "opid": "templateOpenIdConnect3", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePolicy.json new file mode 100644 index 000000000000..3937ee5f47dd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePolicy.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePolicyFragment.json new file mode 100644 index 000000000000..df5fa8d0d0c4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePolicyFragment.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "id": "policyFragment1", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePolicyRestriction.json new file mode 100644 index 000000000000..608802005129 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePolicyRestriction.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyRestrictionId": "policyRestriction1", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePrivateEndpointConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..71aa138fcfe9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletePrivateEndpointConnection.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "privateEndpointConnectionName": "privateEndpointConnectionName" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProduct.json new file mode 100644 index 000000000000..26d38948fca3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProduct.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "deleteSubscriptions": true, + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductApi.json new file mode 100644 index 000000000000..49a42a563865 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductApi.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "apiId": "echo-api", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductApiLink.json new file mode 100644 index 000000000000..b550b01a003c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductApiLink.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "apiLinkId": "link1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductGroup.json new file mode 100644 index 000000000000..299448ba9c01 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductGroup.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "groupId": "templateGroup", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductGroupLink.json new file mode 100644 index 000000000000..fe131a6a6330 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductGroupLink.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "groupLinkId": "link1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductPolicy.json new file mode 100644 index 000000000000..2620413c3f8f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductPolicy.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductTag.json new file mode 100644 index 000000000000..1796c744179c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductTag.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "59d5b28d1f7fab116c282650", + "tagId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductWiki.json new file mode 100644 index 000000000000..51851f47c1f3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteProductWiki.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "57d1f7558aa04f15146d9d8a", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteSubscription.json new file mode 100644 index 000000000000..f2cf0c15bdfe --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteSubscription.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "sid": "testsub", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTag.json new file mode 100644 index 000000000000..be17d9eb662c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTag.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tagId1", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTagApiLink.json new file mode 100644 index 000000000000..60c0af69e394 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTagApiLink.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "apiLinkId": "link1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTagOperationLink.json new file mode 100644 index 000000000000..e9d65c8954b7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTagOperationLink.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "operationLinkId": "link1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTagProductLink.json new file mode 100644 index 000000000000..0286f6e1e0ae --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTagProductLink.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "productLinkId": "link1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTemplate.json new file mode 100644 index 000000000000..80d89c8bb031 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteTemplate.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteUser.json new file mode 100644 index 000000000000..ce134d0bd5ea --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteUser.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b", + "If-Match": "*" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=204", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspace.json new file mode 100644 index 000000000000..8f0fc868a85c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspace.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApi.json new file mode 100644 index 000000000000..c46fc2ddfe75 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApi.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "echo-api", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiDiagnostic.json new file mode 100644 index 000000000000..bce6eada3926 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiDiagnostic.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a", + "If-Match": "*" + }, + "responses": { + "204": {}, + "200": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiOperation.json new file mode 100644 index 000000000000..3efda149b58c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiOperation.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0ad01d6cdc", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiOperationPolicy.json new file mode 100644 index 000000000000..4d143b126cbe --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiOperationPolicy.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "testapi", + "operationId": "testoperation", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiPolicy.json new file mode 100644 index 000000000000..a37555619c44 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiPolicy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "loggerId", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiRelease.json new file mode 100644 index 000000000000..c3c0bade2604 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiRelease.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "5a5fcc09124a7fa9b89f2f1d", + "releaseId": "testrev", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiSchema.json new file mode 100644 index 000000000000..0b41872dc95a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiSchema.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "59d5b28d1f7fab116c282650", + "schemaId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiVersionSet.json new file mode 100644 index 000000000000..931ba96ac630 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceApiVersionSet.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "versionSetId": "a1", + "If-Match": "*" + }, + "responses": { + "204": {}, + "200": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceBackend.json new file mode 100644 index 000000000000..e368719c7eb2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceBackend.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "backendId": "sfbackend", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceCertificate.json new file mode 100644 index 000000000000..e74aa0690936 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceCertificate.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "certificateId": "tempcert", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceDiagnostic.json new file mode 100644 index 000000000000..f3be7d49c021 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceDiagnostic.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "diagnosticId": "applicationinsights", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceGroup.json new file mode 100644 index 000000000000..a41e28909784 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceGroup.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "groupId": "aadGroup", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceGroupUser.json new file mode 100644 index 000000000000..0b4b5b86ff01 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceGroupUser.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "groupId": "templategroup", + "userId": "59307d350af58404d8a26300", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceLogger.json new file mode 100644 index 000000000000..14b505405091 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceLogger.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "loggerId": "loggerId", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceNamedValue.json new file mode 100644 index 000000000000..ab79a473d120 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceNamedValue.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "namedValueId": "testprop2", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json new file mode 100644 index 000000000000..09de3b43369b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "notificationName": "RequestPublisherNotificationMessage", + "email": "contoso@live.com" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientUser.json new file mode 100644 index 000000000000..3e92c37beff7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientUser.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "notificationName": "RequestPublisherNotificationMessage", + "userId": "576823d0a40f7e74ec07d642" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspacePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspacePolicy.json new file mode 100644 index 000000000000..c7149b716e8d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspacePolicy.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspacePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspacePolicyFragment.json new file mode 100644 index 000000000000..1de9f0f0593c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspacePolicyFragment.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "id": "policyFragment1", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProduct.json new file mode 100644 index 000000000000..92dbba219526 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProduct.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "testproduct", + "deleteSubscriptions": true, + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProductApiLink.json new file mode 100644 index 000000000000..ef6d251bebeb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProductApiLink.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "testproduct", + "apiLinkId": "link1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProductGroupLink.json new file mode 100644 index 000000000000..9674c9c50428 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProductGroupLink.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "testproduct", + "groupLinkId": "link1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProductPolicy.json new file mode 100644 index 000000000000..abfac71164df --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceProductPolicy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "testproduct", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceSchema.json new file mode 100644 index 000000000000..28d1a5dd3194 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceSchema.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "schemaId": "schema1", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceSubscription.json new file mode 100644 index 000000000000..8a689979cf0d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceSubscription.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "sid": "testsub", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTag.json new file mode 100644 index 000000000000..c06bd84f3555 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTag.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tagId1", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTagApiLink.json new file mode 100644 index 000000000000..89981617ac9b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTagApiLink.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tag1", + "apiLinkId": "link1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTagOperationLink.json new file mode 100644 index 000000000000..9b1ac73c468d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTagOperationLink.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tag1", + "operationLinkId": "link1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTagProductLink.json new file mode 100644 index 000000000000..714fb9569a5e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeleteWorkspaceTagProductLink.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tag1", + "productLinkId": "link1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletedServicesListBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletedServicesListBySubscription.json new file mode 100644 index 000000000000..9f94ee28b5d1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletedServicesListBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", + "name": "apimService3", + "type": "Microsoft.ApiManagement/deletedservices", + "location": "West US", + "properties": { + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3", + "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", + "deletionDate": "2017-05-27T15:33:55.5426123Z" + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus2/deletedservices/apimService", + "name": "apimService", + "type": "Microsoft.ApiManagement/deletedservices", + "location": "West US 2", + "properties": { + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService", + "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", + "deletionDate": "2017-05-27T15:33:55.5426123Z" + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletedServicesPurge.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletedServicesPurge.json new file mode 100644 index 000000000000..ec52df3ff2ee --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementDeletedServicesPurge.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService3", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", + "name": "apimService3", + "type": "Microsoft.ApiManagement/deletedservices", + "location": "West US", + "properties": { + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3", + "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", + "deletionDate": "2017-05-27T15:33:55.5426123Z" + } + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayDeleteGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayDeleteGateway.json new file mode 100644 index 000000000000..82c92639ec72 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayDeleteGateway.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "gatewayName": "example-gateway", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway", + "name": "example-gateway", + "type": "Microsoft.ApiManagement/gateway", + "tags": {}, + "location": "West US", + "etag": "AAAAAAFfhHY=", + "properties": { + "provisioningState": "Succeeded", + "targetProvisioningState": "Deleting", + "createdAtUtc": "2016-12-20T19:41:21.5823069Z", + "frontend": { + "defaultHostname": "example-gateway.westus.gateway.azure-api.net" + }, + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "configurationApi": { + "hostname": "example-gateway.westus.configuration.gateway.azure-api.net" + } + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + }, + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayGenerateToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayGenerateToken.json new file mode 100644 index 000000000000..2d187457749b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayGenerateToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "parameters": { + "keyType": "primary", + "expiry": "2020-04-21T00:44:24.2845269Z" + } + }, + "responses": { + "200": { + "body": { + "value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg==" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayGetGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayGetGateway.json new file mode 100644 index 000000000000..dd7d1d08ddcc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayGetGateway.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "gatewayName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway", + "name": "example-gateway", + "type": "Microsoft.ApiManagement/gateway", + "tags": { + "owner": "v-aswmoh", + "ReleaseName": "Z3" + }, + "location": "East US", + "etag": "AAAAAAAWN/4=", + "properties": { + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "frontend": { + "defaultHostname": "example-gateway.eastus.gateway.azure-api.net" + }, + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "configurationApi": { + "hostname": "example-gateway.eastus.configuration.gateway.azure-api.net" + } + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2021-06-16T09:40:00.7106733Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayInvalidateDebugCredentials.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayInvalidateDebugCredentials.json new file mode 100644 index 000000000000..9049054bc43f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayInvalidateDebugCredentials.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayListDebugCredentials.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayListDebugCredentials.json new file mode 100644 index 000000000000..ca138be77646 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayListDebugCredentials.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "parameters": { + "credentialsExpireAfter": "PT1H", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "purposes": [ + "tracing" + ] + } + }, + "responses": { + "200": { + "body": { + "token": "p=tracing&aid=a1&ex=20230504000000&sn=ZdfxSJoCsOJE0/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/8LchGl7gu/Q==" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayListKeys.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayListKeys.json new file mode 100644 index 000000000000..b90b881ee54d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayListKeys.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1" + }, + "responses": { + "200": { + "body": { + "primary": "primary_key_value", + "secondary": "secondary_key_value" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayListTrace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayListTrace.json new file mode 100644 index 000000000000..06b7ff960ec2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayListTrace.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "parameters": { + "traceId": "CrDvXXXXXXXXXXXXXVU3ZA2-1" + } + }, + "responses": { + "200": { + "body": { + "serviceName": "apimService1", + "traceId": "1e0447d4-XXXX-XXXX-XXXX-dbdb8098a0d3", + "traceEntries": { + "inbound": [ + { + "source": "api-inspector", + "timestamp": "2023-05-03T12:03:04.6899436Z", + "elapsed": "00:00:00.2983315", + "data": { + "request": { + "method": "GET", + "url": "https://proxy.msitesting.net/6452XXXXXXXXXXXX9c2facb1/64524dXXXXXXXXXXXX2facb3?subscription-key=117313e70XXXXXXXXXXXX38ba4658ca3", + "headers": [ + { + "name": "Host", + "value": "proxy.msitesting.net" + } + ] + } + } + }, + { + "source": "api-inspector", + "timestamp": "2023-05-03T12:03:04.6969650Z", + "elapsed": "00:00:00.3046329", + "data": { + "configuration": { + "api": { + "from": "/6452XXXXXXXXXXXX9c2facb1", + "to": { + "scheme": "http", + "host": "msitesting.net", + "port": 80, + "path": "/", + "queryString": "", + "query": {}, + "isDefaultPort": true + }, + "version": null, + "revision": "1" + }, + "operation": { + "method": "GET", + "uriTemplate": "/64524dXXXXXXXXXXXX2facb3" + }, + "user": "-", + "product": "-" + } + } + }, + { + "source": "cors", + "timestamp": "2023-05-03T12:03:04.9901631Z", + "elapsed": "00:00:00.5972352", + "data": "Origin header was missing or empty and the request was classified as not cross-domain. CORS policy was not applied." + }, + { + "source": "set-status", + "timestamp": "2023-05-03T12:03:05.0031202Z", + "elapsed": "00:00:00.6107970", + "data": { + "message": [ + "Response status code was set to 200", + "Response status reason was set to 'OK'" + ] + } + }, + { + "source": "return-response", + "timestamp": "2023-05-03T12:03:05.0086543Z", + "elapsed": "00:00:00.6164228", + "data": { + "message": "Return response was applied", + "response": { + "status": { + "code": "OK", + "reason": "OK" + }, + "headers": [] + } + } + } + ], + "outbound": [ + { + "source": "transfer-response", + "timestamp": "2023-05-03T12:03:05.0438287Z", + "elapsed": "00:00:00.6510195", + "data": { + "message": "Response has been sent to the caller in full" + } + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayRegenerateKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayRegenerateKey.json new file mode 100644 index 000000000000..1d25a2ba8651 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGatewayRegenerateKey.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gwId", + "parameters": { + "keyType": "primary" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiContract.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiContract.json new file mode 100644 index 000000000000..ea4ab27ee98f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiContract.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/apis", + "name": "57d1f7558aa04f15146d9d8a", + "properties": { + "displayName": "Service", + "apiRevision": "1", + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "path": "schulte", + "protocols": [ + "https" + ], + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "type": "soap", + "isCurrent": true, + "isOnline": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiDiagnostic.json new file mode 100644 index 000000000000..70a39faf5bfd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiDiagnostic.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + }, + "frontend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + }, + "backend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiExportInOpenApi2dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiExportInOpenApi2dot0.json new file mode 100644 index 000000000000..349738a3b372 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiExportInOpenApi2dot0.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "echo-api", + "format": "swagger-link", + "export": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", + "format": "swagger-link-json", + "value": { + "link": "https://apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore Extensive.json?XXXXXXXX" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiExportInOpenApi3dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiExportInOpenApi3dot0.json new file mode 100644 index 000000000000..e4249d1b5c42 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiExportInOpenApi3dot0.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "aid9676", + "format": "openapi-link", + "export": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/aid9676", + "format": "openapi-link", + "value": { + "link": "https: //apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore.yaml?storage-sas-signatureXXXX" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiIssue.json new file mode 100644 index 000000000000..74531b378c22 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiIssue.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiIssueAttachment.json new file mode 100644 index 000000000000..25ebc34fccfb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiIssueAttachment.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "attachmentId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "name": "57d2ef278aa04f0888cba3f3", + "properties": { + "title": "Issue attachment.", + "contentFormat": "link", + "content": "https://.../image.jpg" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiIssueComment.json new file mode 100644 index 000000000000..3b8ba652c851 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiIssueComment.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "commentId": "599e29ab193c3c0bd0b3e2fb" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "name": "599e29ab193c3c0bd0b3e2fb", + "properties": { + "text": "Issue comment.", + "createdDate": "2018-02-01T22:21:20.467Z", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperation.json new file mode 100644 index 000000000000..be3712755967 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperation.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "displayName": "CancelOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "templateParameters": [], + "request": { + "description": "IFazioService_CancelOrder_InputMessage", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrder" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "IFazioService_CancelOrder_OutputMessage", + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrderResponse" + } + ], + "headers": [] + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationPetStore.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationPetStore.json new file mode 100644 index 000000000000..b11155acfa05 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationPetStore.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "swagger-petstore", + "operationId": "loginUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/swagger-petstore/operations/loginUser", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "loginUser", + "properties": { + "displayName": "Logs user into the system", + "method": "GET", + "urlTemplate": "/user/login?username={username}&password={password}", + "templateParameters": [ + { + "name": "username", + "description": "The user name for login", + "type": "string", + "required": true, + "values": [] + }, + { + "name": "password", + "description": "The password for login in clear text", + "type": "string", + "required": true, + "values": [] + } + ], + "description": "", + "request": { + "queryParameters": [], + "headers": [], + "representations": [] + }, + "responses": [ + { + "statusCode": 200, + "description": "successful operation", + "representations": [ + { + "contentType": "application/xml", + "schemaId": "5ba91a35f373b513a0bf31c6", + "typeName": "UserLoginGet200ApplicationXmlResponse" + }, + { + "contentType": "application/json", + "schemaId": "5ba91a35f373b513a0bf31c6", + "typeName": "UserLoginGet200ApplicationJsonResponse" + } + ], + "headers": [ + { + "name": "X-Rate-Limit", + "description": "calls per hour allowed by the user", + "type": "integer", + "values": [] + }, + { + "name": "X-Expires-After", + "description": "date in UTC when token expires", + "type": "string", + "values": [] + } + ] + }, + { + "statusCode": 400, + "description": "Invalid username/password supplied", + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "headers": [] + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationPolicy.json new file mode 100644 index 000000000000..9849b5b65197 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationPolicy.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5600b539c53f5b0062040001", + "operationId": "5600b53ac53f5b0062080006", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n This is a sample\r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationTag.json new file mode 100644 index 000000000000..066bacf9a0fc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiOperationTag.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "operationId": "59d6bb8f1f7fab13dc67ec9a", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiPolicy.json new file mode 100644 index 000000000000..231e577f53bc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiPolicy.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5600b59475ff190048040001", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRelease.json new file mode 100644 index 000000000000..42e80bbf5131 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRelease.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "a1", + "releaseId": "5a7cb545298324c53224a799" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/apis/releases", + "name": "5a7cb545298324c53224a799", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "createdDateTime": "2018-02-08T20:38:29.173Z", + "updatedDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRevision.json new file mode 100644 index 000000000000..aaac0d655a04 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiRevision.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "echo-api;rev=3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api;rev=3", + "properties": { + "displayName": "Service", + "apiRevision": "3", + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "path": "schulte", + "protocols": [ + "https" + ], + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "apiRevisionDescription": "fixed bug in contract" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiSchema.json new file mode 100644 index 000000000000..48846cfacaba --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiSchema.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTag.json new file mode 100644 index 000000000000..3ebc6b9f08f5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTag.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTagDescription.json new file mode 100644 index 000000000000..18f9839115a8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiTagDescription.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagDescriptionId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/tagDescriptions/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "displayName": "tag1", + "description": null, + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiVersionSet.json new file mode 100644 index 000000000000..bec4cb30047b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiVersionSet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "vs1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "name": "vs1", + "properties": { + "displayName": "Version Set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiWiki.json new file mode 100644 index 000000000000..47306235837c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetApiWiki.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "name": "default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorization.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorization.json new file mode 100644 index 000000000000..c9f3dcf188d8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorization.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "authorizationId": "authz1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "name": "authz1", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "AuthorizationCode", + "status": "Connected" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationAccessPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationAccessPolicy.json new file mode 100644 index 000000000000..830e8a3d349b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationAccessPolicy.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "authorizationId": "authz1", + "authorizationAccessPolicyId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationLoginRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationLoginRequest.json new file mode 100644 index 000000000000..71aab04d8668 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationLoginRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "authorizationId": "authz1", + "parameters": { + "postLoginRedirectUrl": "https://www.bing.com/" + } + }, + "responses": { + "200": { + "body": { + "loginLink": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1/login?data=eyJMb2dpbklkIjoiY2YtODNmYzQ5N2YyZWYxNDA4MzlmNDdjZDU3YWY3MmZmODctYW5nYW50aS1wcmV2aWV3X2FhZC1hdXRoY29kZV9vYXV0aDItY29kZV90b2tlbiIsIlNlc3Npb25JZCI6IiIsIkxvZ0Nvbm5lY3Rpb25JZCI6ImF1dGh6MiIsIkxvZ0Nvbm5lY3RvcklkIjoiYWFkLWF1dGhjb2RlIiwiTG9nRW52aXJvbm1lbnRJZCI6ImFuZ2FudGktcHJld" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationProvider.json new file mode 100644 index 000000000000..4848c41e70ce --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationProvider.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "aadwithauthcode", + "properties": { + "displayName": "aadwithauthcode", + "identityProvider": "aad", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", + "scopes": "User.Read.All Group.Read.All", + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "tenantId": "common" + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationServer.json new file mode 100644 index 000000000000..bfc481adb31c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetAuthorizationServer.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authsid": "newauthServer2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "name": "newauthServer2", + "properties": { + "displayName": "test3", + "useInTestConsole": false, + "useInApiDocumentation": true, + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "clientAuthenticationMethod": [ + "Basic" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetBackend.json new file mode 100644 index 000000000000..eb1f97c1b23f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetBackend.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "backendId": "sfbackend" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCache.json new file mode 100644 index 000000000000..2d6e41e63c19 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCache.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "cacheId": "c1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", + "type": "Microsoft.ApiManagement/service/caches", + "name": "c1", + "properties": { + "useFromLocation": "default", + "description": "Redis cache instances in West India", + "connectionString": "{{5f7fbca77a891a2200f3db38}}", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificate.json new file mode 100644 index 000000000000..1d90cf8fecb5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificate.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "certificateId": "templateCert1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert1", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "templateCert1", + "properties": { + "subject": "CN=mutual-authcert", + "thumbprint": "EBA**********************8594A6", + "expirationDate": "2017-04-23T17:03:41Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificateWithKeyVault.json new file mode 100644 index 000000000000..ef67ddb8bdad --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetCertificateWithKeyVault.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "certificateId": "templateCertkv" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "templateCertkv", + "properties": { + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690", + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentType.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentType.json new file mode 100644 index 000000000000..6140bb9ead43 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentType.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "contentTypeId": "page" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/contentTypes/page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "name": "page", + "properties": { + "name": "Page", + "description": "A regular page", + "schema": { + "properties": { + "en_us": { + "type": "object", + "properties": { + "title": { + "title": "Title", + "description": "Page title. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "description": { + "title": "Description", + "description": "Page description. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "keywords": { + "title": "Keywords", + "description": "Page keywords. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "permalink": { + "title": "Permalink", + "description": "Page permalink, e.g. '/about'.", + "type": "string", + "indexed": true + }, + "documentId": { + "title": "Document ID", + "description": "Reference to page content document.", + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "title", + "permalink", + "documentId" + ] + } + }, + "additionalProperties": false + }, + "version": "1.0.0" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentTypeContentItem.json new file mode 100644 index 000000000000..1096a810d80e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetContentTypeContentItem.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "contentTypeId": "page", + "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8" + }, + "responses": { + "200": { + "body": { + "id": "/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "properties": { + "en_us": { + "title": "About", + "description": "Short story about the company.", + "keywords": "company, about", + "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "permalink": "/about" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDeletedServiceByName.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDeletedServiceByName.json new file mode 100644 index 000000000000..338bd9938e55 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDeletedServiceByName.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService3", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", + "name": "apimService3", + "type": "Microsoft.ApiManagement/deletedservices", + "location": "West US", + "properties": { + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3", + "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", + "deletionDate": "2017-05-27T15:33:55.5426123Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDiagnostic.json new file mode 100644 index 000000000000..17e9c397ad7f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDiagnostic.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "diagnosticId": "applicationinsights" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + }, + "frontend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + }, + "backend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDocumentation.json new file mode 100644 index 000000000000..c948fe608faa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetDocumentation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "documentationId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "name": "57d1f7558aa04f15146d9d8a", + "properties": { + "title": "Title", + "content": "content" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGateway.json new file mode 100644 index 000000000000..46db91e995db --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGateway.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", + "type": "Microsoft.ApiManagement/service/gateways", + "name": "a1", + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayCertificateAuthority.json new file mode 100644 index 000000000000..e0a045885e00 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayCertificateAuthority.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "certificateId": "cert1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "name": "cert1", + "properties": { + "isTrusted": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayConfigConnection.json new file mode 100644 index 000000000000..5f3dec635217 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayConfigConnection.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayName": "standard-gw-01", + "configConnectionName": "gcc-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", + "name": "gcc-1", + "type": "Microsoft.ApiManagement/gateways/configConnections", + "etag": "AAAAAAAWN/4=", + "properties": { + "provisioningState": "Succeeded", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001", + "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayHostnameConfiguration.json new file mode 100644 index 000000000000..5490fa0081e9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGatewayHostnameConfiguration.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "hcId": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "name": "default", + "properties": { + "hostname": "*", + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "negotiateClientCertificate": false + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema1.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema1.json new file mode 100644 index 000000000000..40212becc172 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema1.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "schemaId": "schema1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "name": "schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema2.json new file mode 100644 index 000000000000..9df63055f4ab --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGlobalSchema2.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "schemaId": "schema2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema2", + "type": "Microsoft.ApiManagement/service/schemas", + "name": "schema2", + "properties": { + "description": "sample schema description", + "schemaType": "json", + "document": { + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Person", + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + }, + "age": { + "description": "Age in years which must be equal to or greater than zero.", + "type": "integer", + "minimum": 0 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolver.json new file mode 100644 index 000000000000..64b8de6aac0c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolver.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "resolverId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "displayName": "Query Users", + "path": "Query/users", + "description": "A GraphQL Resolver example" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolverPolicy.json new file mode 100644 index 000000000000..63d263d5117d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGraphQLApiResolverPolicy.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5600b539c53f5b0062040001", + "resolverId": "5600b53ac53f5b0062080006", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/resolvers/5600b53ac53f5b0062080006/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n GET\r\n\r\n/api/users\r\n\r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGroup.json new file mode 100644 index 000000000000..81b6a62d753c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetGroup.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/groups", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "description": "awesome group of people", + "builtIn": false, + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIdentityProvider.json new file mode 100644 index 000000000000..ef225e74b78e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIdentityProvider.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "identityProviderName": "aadB2C" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "AadB2C", + "properties": { + "clientId": "f02dafe2-b8b8-48ec-a38e-27e5c16c51e5", + "type": "aadB2C", + "authority": "login.microsoftonline.com", + "signinTenant": "contosoaadb2c.onmicrosoft.com", + "allowedTenants": [ + "contosoaadb2c.onmicrosoft.com", + "contoso2aadb2c.onmicrosoft.com" + ], + "signupPolicyName": "B2C_1_policy-signup", + "signinPolicyName": "B2C_1_policy-signin" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIssue.json new file mode 100644 index 000000000000..4942290a5318 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetIssue.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "issueId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetLogger.json new file mode 100644 index 000000000000..e85d7752985a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetLogger.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "loggerId": "templateLogger" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/kloudapilogger1", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "kloudapilogger1", + "properties": { + "loggerType": "azureEventHub", + "description": "testeventhub3again", + "credentials": { + "name": "testeventhub4", + "connectionString": "Endpoint=sb://eventhubapim.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=************" + }, + "isBuffered": true, + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/eventhubapim" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValue.json new file mode 100644 index 000000000000..18a63dffd478 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValue.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "namedValueId": "testarmTemplateproperties2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testarmTemplateproperties2", + "type": "Microsoft.ApiManagement/service/namedValues", + "name": "testarmTemplateproperties2", + "properties": { + "displayName": "propName", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": false + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValueWithKeyVault.json new file mode 100644 index 000000000000..4a9ba5318ca1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNamedValueWithKeyVault.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "namedValueId": "testprop6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "name": "testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + } + }, + "tags": [ + "foo", + "bar" + ], + "secret": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNotification.json new file mode 100644 index 000000000000..5f7a8db3c9c3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetNotification.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "notificationName": "RequestPublisherNotificationMessage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "RequestPublisherNotificationMessage", + "properties": { + "title": "Subscription requests (requiring approval)", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json new file mode 100644 index 000000000000..3f9362d7490f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "opid": "templateOpenIdConnect2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "name": "templateOpenIdConnect2", + "properties": { + "displayName": "templateoidprovider2", + "description": "open id provider template2", + "metadataEndpoint": "https://oidprovider-template2.net", + "clientId": "oidprovidertemplate2", + "useInTestConsole": false, + "useInApiDocumentation": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationResult.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationResult.json new file mode 100644 index 000000000000..73a5971641c7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationResult.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "operationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "location": "westus2" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ApiManagement/locations/westus2/operationResults/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?api-version=2023-09-01-preview" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationStatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationStatus.json new file mode 100644 index 000000000000..8b5602cda538 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetOperationStatus.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "operationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "location": "testLocation" + }, + "responses": { + "200": { + "body": { + "status": "InProgress" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicy.json new file mode 100644 index 000000000000..47684433be3f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicy.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFormat.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFormat.json new file mode 100644 index 000000000000..1f55da178ca7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFormat.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyId": "policy", + "format": "rawxml" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "format": "rawxml", + "value": "\r\n\r\n\t\r\n\t\t\r\n\t\t\t@{\n var guidBinary = new byte[16];\n Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);\n long time = DateTime.Now.Ticks;\n byte[] bytes = new byte[6];\n unchecked\n {\n bytes[5] = (byte)(time >> 40);\n bytes[4] = (byte)(time >> 32);\n bytes[3] = (byte)(time >> 24);\n bytes[2] = (byte)(time >> 16);\n bytes[1] = (byte)(time >> 8);\n bytes[0] = (byte)(time);\n }\n Array.Copy(bytes, 0, guidBinary, 10, 6);\n return new Guid(guidBinary).ToString();\n }\n \r\n\t\t\r\n\t\r\n\t\r\n\t\t\r\n\t\r\n\t\r\n\t\r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragment.json new file mode 100644 index 000000000000..8543fcfac121 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragment.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "id": "policyFragment1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "name": "policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragmentFormat.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragmentFormat.json new file mode 100644 index 000000000000..17b4e49aa007 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyFragmentFormat.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "id": "policyFragment1", + "format": "rawxml" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "name": "policyFragment1", + "properties": { + "format": "rawxml", + "description": "A policy fragment example", + "value": "\r\n\t\t\t@{\n var guidBinary = new byte[16];\n Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);\n long time = DateTime.Now.Ticks;\n byte[] bytes = new byte[6];\n unchecked\n {\n bytes[5] = (byte)(time >> 40);\n bytes[4] = (byte)(time >> 32);\n bytes[3] = (byte)(time >> 24);\n bytes[2] = (byte)(time >> 16);\n bytes[1] = (byte)(time >> 8);\n bytes[0] = (byte)(time);\n }\n Array.Copy(bytes, 0, guidBinary, 10, 6);\n return new Guid(guidBinary).ToString();\n }\n \r\n\t\t" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyRestriction.json new file mode 100644 index 000000000000..938225e138e8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPolicyRestriction.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyRestrictionId": "policyRestriction1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", + "type": "Microsoft.ApiManagement/service/policyRestrictions", + "name": "policyRestriction1", + "properties": { + "scope": "Sample Path to the policy document.", + "requireBase": "true" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPortalRevision.json new file mode 100644 index 000000000000..18e314d74e14 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPortalRevision.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "portalRevisionId": "20201112101010" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "name": "20201112101010", + "properties": { + "description": "portal revision 1", + "statusDetails": null, + "status": "completed", + "isCurrent": true, + "createdDateTime": "2020-11-12T22:51:36.47Z", + "updatedDateTime": "2020-11-12T22:52:00.097Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateEndpointConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..6723a957d4a6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "privateEndpointConnectionName": "privateEndpointConnectionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "name": "privateEndpointProxyName", + "properties": { + "provisioningState": "Pending", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request, thanks", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateLinkGroupResource.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateLinkGroupResource.json new file mode 100644 index 000000000000..46850aaabeca --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetPrivateLinkGroupResource.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "privateLinkSubResourceName": "privateLinkSubResourceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway", + "name": "Gateway", + "type": "Microsoft.ApiManagement/service/privateLinkResources", + "properties": { + "groupId": "Gateway", + "requiredMembers": [ + "Gateway" + ], + "requiredZoneNames": [ + "privateLink.azure-api.net" + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProduct.json new file mode 100644 index 000000000000..6209a155bff1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProduct.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "unlimited" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited", + "type": "Microsoft.ApiManagement/service/products", + "name": "unlimited", + "properties": { + "displayName": "Unlimited", + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "subscriptionRequired": true, + "approvalRequired": true, + "subscriptionsLimit": 1, + "state": "published" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductApiLink.json new file mode 100644 index 000000000000..5f18ccf67704 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductApiLink.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "apiLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductGroupLink.json new file mode 100644 index 000000000000..9b891be98a91 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductGroupLink.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "groupLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinks/link1", + "type": "Microsoft.ApiManagement/service/products/groupLinks", + "name": "link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductPolicy.json new file mode 100644 index 000000000000..ae20c0dd95c1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductPolicy.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "kjoshiarmTemplateProduct4", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmTemplateProduct4/policies/policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductTag.json new file mode 100644 index 000000000000..194e05406a1d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductTag.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductWiki.json new file mode 100644 index 000000000000..efe7d2a9efd4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetProductWiki.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "name": "default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeys.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeys.json new file mode 100644 index 000000000000..afbac20a311e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeys.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "quotaCounterKey": "ba" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "counterKey": "ba", + "periodKey": "0_P3Y6M4DT12H30M5S", + "periodStartTime": "2014-08-04T04:24:35Z", + "periodEndTime": "2018-02-08T16:54:40Z", + "value": { + "callsCount": 5, + "kbTransferred": 2.5830078125 + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json new file mode 100644 index 000000000000..0fb607af8fac --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "quotaCounterKey": "ba", + "quotaPeriodKey": "0_P3Y6M4DT12H30M5S" + }, + "responses": { + "200": { + "body": { + "counterKey": "ba", + "periodKey": "0_P3Y6M4DT12H30M5S", + "periodStartTime": "2014-08-04T04:24:35Z", + "periodEndTime": "2018-02-08T16:54:40Z", + "value": { + "callsCount": 0, + "kbTransferred": 2.5625 + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByApi.json new file mode 100644 index 000000000000..fdce8e383d6b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByApi.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Echo API", + "apiId": "/apis/5600b59475ff190048040001", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "httpbin", + "apiId": "/apis/57a03a13e4bbd5119c8b19e9", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByGeo.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByGeo.json new file mode 100644 index 000000000000..34d9b8183401 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByGeo.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "country": "US", + "region": "WA", + "zip": "98052", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByOperation.json new file mode 100644 index 000000000000..3063ebfb2484 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByOperation.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "get", + "apiId": "/apis/57a03a13e4bbd5119c8b19e9", + "operationId": "/apis/57a03a13e4bbd5119c8b19e9/operations/57a03a1dd8d14f0a780d7d14", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + }, + { + "name": "GetWeatherInformation", + "apiId": "/apis/57c999d1e4bbd50c988cb2c3", + "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93e", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "GetCityForecastByZIP", + "apiId": "/apis/57c999d1e4bbd50c988cb2c3", + "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93f", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByProduct.json new file mode 100644 index 000000000000..ba0854f61dd0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByProduct.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Starter", + "productId": "/products/5600b59475ff190048060001", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "Unlimited", + "productId": "/products/5600b59475ff190048060002", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByRequest.json new file mode 100644 index 000000000000..47f3c514f7f4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByRequest.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "apiId": "/apis/5931a75ae4bbd512a88c680b", + "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-", + "productId": "/products/-", + "userId": "/users/1", + "method": "GET", + "url": "https://apimService1.azure-api.net/echo/resource?param1=sample", + "ipAddress": "207.xx.155.xx", + "responseCode": 404, + "responseSize": 405, + "timestamp": "2017-06-03T00:17:00.1649134Z", + "cache": "none", + "apiTime": 221.1544, + "serviceTime": 0.0, + "apiRegion": "East Asia", + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "requestId": "63e7119c-26aa-433c-96d7-f6f3267ff52f", + "requestSize": 0 + }, + { + "apiId": "/apis/5931a75ae4bbd512a88c680b", + "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-", + "productId": "/products/-", + "userId": "/users/1", + "method": "POST", + "url": "https://apimService1.azure-api.net/echo/resource", + "ipAddress": "207.xx.155.xx", + "responseCode": 404, + "responseSize": 403, + "timestamp": "2017-06-03T00:17:20.5255131Z", + "cache": "none", + "apiTime": 6.6754000000000007, + "serviceTime": 0.0, + "apiRegion": "East Asia", + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "requestId": "e581b7f7-c9ec-4fc6-8ab9-3855d9b00b04", + "requestSize": 0 + } + ], + "count": 2 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsBySubscription.json new file mode 100644 index 000000000000..ee253698eca7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsBySubscription.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "userId": "/users/1", + "productId": "/products/5600b59475ff190048060001", + "subscriptionId": "/subscriptions/5600b59475ff190048070001", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "", + "userId": "/users/1", + "productId": "/products/5600b59475ff190048060002", + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + }, + { + "name": "", + "userId": "/users/1", + "productId": "/products/5702e97e5157a50f48dce801", + "subscriptionId": "/subscriptions/5702e97e5157a50a9c733303", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByTime.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByTime.json new file mode 100644 index 000000000000..c6b7f3967f9a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByTime.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", + "interval": "PT15M" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timestamp": "2017-06-03T00:15:00Z", + "interval": "PT15M", + "callCountSuccess": 4, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 4, + "bandwidth": 3243, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1337.46335, + "apiTimeMin": 885.0839000000001, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 1255.917425, + "serviceTimeMin": 882.8264, + "serviceTimeMax": 1697.3612 + }, + { + "timestamp": "2017-06-03T00:30:00Z", + "interval": "PT15M", + "callCountSuccess": 9, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 10, + "bandwidth": 7776, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 872.7818777777778, + "apiTimeMin": 330.3206, + "apiTimeMax": 1093.8407, + "serviceTimeAvg": 824.2847111111112, + "serviceTimeMin": 215.24, + "serviceTimeMax": 973.2262000000001 + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByUser.json new file mode 100644 index 000000000000..fb685c5fc7de --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetReportsByUser.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Administrator", + "userId": "/users/1", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + }, + { + "name": "Samir Solanki", + "userId": "/users/56eaec62baf08b06e46d27fd", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "Anonymous", + "userId": "/users/54c800b332965a0035030000", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetSubscription.json new file mode 100644 index 000000000000..bac62817ea72 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetSubscription.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "sid": "5931a769d8d14f0ad8ce13b8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "5931a769d8d14f0ad8ce13b8", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "displayName": "Unlimited", + "state": "submitted", + "createdDate": "2017-06-02T17:59:06.223Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTag.json new file mode 100644 index 000000000000..9172f41f4626 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTag.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagApiLink.json new file mode 100644 index 000000000000..11542720819a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagApiLink.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "apiLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagOperationLink.json new file mode 100644 index 000000000000..bb46ad66a0d8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagOperationLink.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "operationLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "name": "link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagProductLink.json new file mode 100644 index 000000000000..a59f4589c29d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTagProductLink.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "productLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "name": "link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTemplate.json new file mode 100644 index 000000000000..bcd129ab1045 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTemplate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "name": "NewIssueNotificationMessage", + "properties": { + "subject": "Your request $IssueName was received", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "title": "New issue received", + "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "isDefault": true, + "parameters": [ + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "IssueId", + "title": "Issue id" + }, + { + "name": "IssueName", + "title": "Issue name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTenantAccess.json new file mode 100644 index 000000000000..2d8a4414baac --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTenantAccess.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "accessName": "access" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", + "type": "Microsoft.ApiManagement/service/tenant", + "name": "access", + "properties": { + "enabled": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTenantGitAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTenantGitAccess.json new file mode 100644 index 000000000000..6278c8128414 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTenantGitAccess.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "accessName": "gitAccess" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/gitAccess", + "type": "Microsoft.ApiManagement/service/tenant", + "name": "gitAccess", + "properties": { + "principalId": "git", + "enabled": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTenantSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTenantSettings.json new file mode 100644 index 000000000000..4f804758ee3b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetTenantSettings.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "settingsType": "public" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/settings/public", + "type": "Microsoft.ApiManagement/service/settings", + "name": "public", + "properties": { + "settings": { + "CustomPortalSettings.UserRegistrationTerms": null, + "CustomPortalSettings.UserRegistrationTermsEnabled": "False", + "CustomPortalSettings.UserRegistrationTermsConsentRequired": "False", + "CustomPortalSettings.DelegationEnabled": "False", + "CustomPortalSettings.DelegationUrl": "", + "CustomPortalSettings.DelegatedSubscriptionEnabled": "False" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetUser.json new file mode 100644 index 000000000000..b35410f2643f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetUser.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512a88c680b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/users", + "name": "5931a75ae4bbd512a88c680b", + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com", + "state": "active", + "registrationDate": "2017-06-02T17:58:50.357Z", + "identities": [ + { + "provider": "Microsoft", + "id": "*************" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetUserSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetUserSubscription.json new file mode 100644 index 000000000000..c0650cd31f50 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetUserSubscription.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "1", + "sid": "5fa9b096f3df14003c070001" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1/subscriptions/5fa9b096f3df14003c070001", + "type": "Microsoft.ApiManagement/service/users/subscriptions", + "name": "5fa9b096f3df14003c070001", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter", + "state": "active", + "createdDate": "2020-11-09T21:11:50.58Z", + "allowTracing": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspace.json new file mode 100644 index 000000000000..4d49008a6a32 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspace.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "name": "wks1", + "properties": { + "description": "workspace 1", + "displayName": "my workspace" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiContract.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiContract.json new file mode 100644 index 000000000000..782904aab04b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiContract.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "name": "57d1f7558aa04f15146d9d8a", + "properties": { + "displayName": "Service", + "apiRevision": "1", + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "path": "schulte", + "protocols": [ + "https" + ], + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "type": "soap", + "isCurrent": true, + "isOnline": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiDiagnostic.json new file mode 100644 index 000000000000..41aea63eb128 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiDiagnostic.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + }, + "frontend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + }, + "backend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json new file mode 100644 index 000000000000..575c37733a5c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "echo-api", + "format": "swagger-link", + "export": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api", + "format": "swagger-link-json", + "value": { + "link": "https://apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore Extensive.json?storage-sas-signature" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json new file mode 100644 index 000000000000..a73390644290 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "aid9676", + "format": "openapi-link", + "export": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/aid9676", + "format": "openapi-link", + "value": { + "link": "https: //apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore.yaml?storage-sas-signature" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiOperation.json new file mode 100644 index 000000000000..2056885e1478 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiOperation.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "displayName": "CancelOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "templateParameters": [], + "request": { + "description": "IFazioService_CancelOrder_InputMessage", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrder" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "IFazioService_CancelOrder_OutputMessage", + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrderResponse" + } + ], + "headers": [] + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiOperationPolicy.json new file mode 100644 index 000000000000..3b28d5699e52 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiOperationPolicy.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "5600b539c53f5b0062040001", + "operationId": "5600b53ac53f5b0062080006", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n This is a sample\r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiPolicy.json new file mode 100644 index 000000000000..ce8ad469a3a1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiPolicy.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "5600b59475ff190048040001", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b59475ff190048040001/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiRelease.json new file mode 100644 index 000000000000..fcaf0e8d6691 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiRelease.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "a1", + "releaseId": "5a7cb545298324c53224a799" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "name": "5a7cb545298324c53224a799", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "createdDateTime": "2018-02-08T20:38:29.173Z", + "updatedDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiRevision.json new file mode 100644 index 000000000000..037f00577977 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiRevision.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "echo-api;rev=3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "name": "echo-api;rev=3", + "properties": { + "displayName": "Service", + "apiRevision": "3", + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "path": "schulte", + "protocols": [ + "https" + ], + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "apiRevisionDescription": "fixed bug in contract" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiSchema.json new file mode 100644 index 000000000000..9994dbae98f1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiSchema.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiVersionSet.json new file mode 100644 index 000000000000..931181a80ede --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceApiVersionSet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "versionSetId": "vs1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs1", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "name": "vs1", + "properties": { + "displayName": "Version Set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceBackend.json new file mode 100644 index 000000000000..564ee4993edc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceBackend.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "backendId": "sfbackend" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceCertificate.json new file mode 100644 index 000000000000..00de9bdc400e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceCertificate.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "certificateId": "templateCert1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service//workspaces/wks1/certificates/templateCert1", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "name": "templateCert1", + "properties": { + "subject": "CN=mutual-authcert", + "thumbprint": "EBA**********************8594A6", + "expirationDate": "2017-04-23T17:03:41Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceCertificateWithKeyVault.json new file mode 100644 index 000000000000..056c8b7def8c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceCertificateWithKeyVault.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "certificateId": "templateCertkv" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "name": "templateCertkv", + "properties": { + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690", + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceDiagnostic.json new file mode 100644 index 000000000000..d1b17d3d84fa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceDiagnostic.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "diagnosticId": "applicationinsights" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + }, + "frontend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + }, + "backend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceGroup.json new file mode 100644 index 000000000000..7c012bffa9f5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceGroup.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "groupId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "description": "awesome group of people", + "builtIn": false, + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceLink.json new file mode 100644 index 000000000000..9ef621681ade --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceLink.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "service1", + "workspaceId": "wk-1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-1", + "name": "wk-1", + "type": "Microsoft.ApiManagement/service/workspaceLinks", + "etag": "AAAAAAAWN/4=", + "properties": { + "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-1", + "gateways": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-1" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceLogger.json new file mode 100644 index 000000000000..ebd9b1a53269 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceLogger.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "loggerId": "templateLogger" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/kloudapilogger1", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "name": "kloudapilogger1", + "properties": { + "loggerType": "azureEventHub", + "description": "testeventhub3again", + "credentials": { + "name": "testeventhub4", + "connectionString": "Endpoint=sb://eventhubapim.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=************" + }, + "isBuffered": true, + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/eventhubapim" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceNamedValue.json new file mode 100644 index 000000000000..67383123bfd4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceNamedValue.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "namedValueId": "testarmTemplateproperties2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testarmTemplateproperties2", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "name": "testarmTemplateproperties2", + "properties": { + "displayName": "propName", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": false + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceNamedValueWithKeyVault.json new file mode 100644 index 000000000000..2cabe800634b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceNamedValueWithKeyVault.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "namedValueId": "testprop6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testarmTemplateproperties2", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "name": "testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + } + }, + "tags": [ + "foo", + "bar" + ], + "secret": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceNotification.json new file mode 100644 index 000000000000..c6c76b23e0d9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceNotification.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "notificationName": "RequestPublisherNotificationMessage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/workspaces/notifications", + "name": "RequestPublisherNotificationMessage", + "properties": { + "title": "Subscription requests (requiring approval)", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspacePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspacePolicy.json new file mode 100644 index 000000000000..703be3318f8c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspacePolicy.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspacePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspacePolicyFragment.json new file mode 100644 index 000000000000..7b746e885409 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspacePolicyFragment.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "id": "policyFragment1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "name": "policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspacePolicyFragmentFormat.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspacePolicyFragmentFormat.json new file mode 100644 index 000000000000..df7fa483eb94 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspacePolicyFragmentFormat.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "id": "policyFragment1", + "format": "rawxml" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "name": "policyFragment1", + "properties": { + "format": "rawxml", + "description": "A policy fragment example", + "value": "\r\n\t\t\t@{\n var guidBinary = new byte[16];\n Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);\n long time = DateTime.Now.Ticks;\n byte[] bytes = new byte[6];\n unchecked\n {\n bytes[5] = (byte)(time >> 40);\n bytes[4] = (byte)(time >> 32);\n bytes[3] = (byte)(time >> 24);\n bytes[2] = (byte)(time >> 16);\n bytes[1] = (byte)(time >> 8);\n bytes[0] = (byte)(time);\n }\n Array.Copy(bytes, 0, guidBinary, 10, 6);\n return new Guid(guidBinary).ToString();\n }\n \r\n\t\t" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProduct.json new file mode 100644 index 000000000000..1186d3d158d2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProduct.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "unlimited" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/unlimited", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "name": "unlimited", + "properties": { + "displayName": "Unlimited", + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "subscriptionRequired": true, + "approvalRequired": true, + "subscriptionsLimit": 1, + "state": "published" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProductApiLink.json new file mode 100644 index 000000000000..25028a49fca9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProductApiLink.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "testproduct", + "apiLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProductGroupLink.json new file mode 100644 index 000000000000..0602fd3421f6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProductGroupLink.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "testproduct", + "groupLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/groupLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/groupLinks", + "name": "link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProductPolicy.json new file mode 100644 index 000000000000..650d54d36b4e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceProductPolicy.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "kjoshiarmTemplateProduct4", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/kjoshiarmTemplateProduct4/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/products/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceSchema.json new file mode 100644 index 000000000000..b34493db4424 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceSchema.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "schemaId": "schema1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "name": "schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceSubscription.json new file mode 100644 index 000000000000..58a825e46bae --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceSubscription.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "sid": "5931a769d8d14f0ad8ce13b8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "name": "5931a769d8d14f0ad8ce13b8", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", + "displayName": "Unlimited", + "state": "submitted", + "createdDate": "2017-06-02T17:59:06.223Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTag.json new file mode 100644 index 000000000000..214afd3db5cd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTag.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTagApiLink.json new file mode 100644 index 000000000000..81e812b59fb1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTagApiLink.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tag1", + "apiLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTagOperationLink.json new file mode 100644 index 000000000000..74ff83e942aa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTagOperationLink.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tag1", + "operationLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", + "name": "link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTagProductLink.json new file mode 100644 index 000000000000..516607f1216b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementGetWorkspaceTagProductLink.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tag1", + "productLinkId": "link1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", + "name": "link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApi.json new file mode 100644 index 000000000000..aee6920166bf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApi.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiDiagnostic.json new file mode 100644 index 000000000000..01b84c54c0e4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiDiagnostic.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiIssue.json new file mode 100644 index 000000000000..c02309e2f67e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiIssue.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiIssueAttachment.json new file mode 100644 index 000000000000..abc287c40392 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiIssueAttachment.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "attachmentId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiIssueComment.json new file mode 100644 index 000000000000..30eac8248fee --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiIssueComment.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "commentId": "599e29ab193c3c0bd0b3e2fb" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiOperation.json new file mode 100644 index 000000000000..cad7e0f66928 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiOperationPolicy.json new file mode 100644 index 000000000000..72ec517131d8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiOperationPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5600b539c53f5b0062040001", + "operationId": "5600b53ac53f5b0062080006", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiOperationTag.json new file mode 100644 index 000000000000..d4c4d4e80cd3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiOperationTag.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "operationId": "59d6bb8f1f7fab13dc67ec9a", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiPolicy.json new file mode 100644 index 000000000000..a0fbfcb50d1e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiPolicy.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiRelease.json new file mode 100644 index 000000000000..5e3fd94fe74c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiRelease.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "a1", + "releaseId": "5a7cb545298324c53224a799" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiSchema.json new file mode 100644 index 000000000000..711786d3d85a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiSchema.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiTag.json new file mode 100644 index 000000000000..103a59bd5fbe --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiTag.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiTagDescription.json new file mode 100644 index 000000000000..314eac2023fc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiTagDescription.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagDescriptionId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiVersionSet.json new file mode 100644 index 000000000000..cbccd20ab40a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiVersionSet.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "vs1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiWiki.json new file mode 100644 index 000000000000..aee6920166bf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadApiWiki.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadAuthorizationServer.json new file mode 100644 index 000000000000..7b7beed33c33 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadAuthorizationServer.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authsid": "newauthServer2" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadBackend.json new file mode 100644 index 000000000000..4cf9d5477cfd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadBackend.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "backendId": "sfbackend" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadCache.json new file mode 100644 index 000000000000..2edd49a72a08 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadCache.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "cacheId": "default" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadCertificate.json new file mode 100644 index 000000000000..1777e133a2a6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadCertificate.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "certificateId": "templateCert1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadContentTypeContentItem.json new file mode 100644 index 000000000000..a6465971f6e6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadContentTypeContentItem.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "contentTypeId": "page", + "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadDelegationSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadDelegationSettings.json new file mode 100644 index 000000000000..b497f1fc5989 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadDelegationSettings.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadDiagnostic.json new file mode 100644 index 000000000000..7ccd4658ce35 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadDiagnostic.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "diagnosticId": "applicationinsights" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadDocumentation.json new file mode 100644 index 000000000000..3c778b49487b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadDocumentation.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "documentationId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadEmailTemplate.json new file mode 100644 index 000000000000..d2a58341ca39 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadEmailTemplate.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGateway.json new file mode 100644 index 000000000000..037ba8b65269 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGateway.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "mygateway" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGatewayApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGatewayApi.json new file mode 100644 index 000000000000..0baa62e44292 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGatewayApi.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "apiId": "api1" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGatewayCertificateAuthority.json new file mode 100644 index 000000000000..eea609567e97 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGatewayCertificateAuthority.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "certificateId": "cert1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGatewayHostnameConfiguration.json new file mode 100644 index 000000000000..e2a2c9c62074 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGatewayHostnameConfiguration.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "hcId": "default" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGlobalSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGlobalSchema.json new file mode 100644 index 000000000000..3207c5ef0476 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGlobalSchema.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "schemaId": "myschema" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGraphQLApiResolver.json new file mode 100644 index 000000000000..822b62b206b7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGraphQLApiResolver.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "resolverId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGraphQLApiResolverPolicy.json new file mode 100644 index 000000000000..39ac729fc2b8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGraphQLApiResolverPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5600b539c53f5b0062040001", + "resolverId": "5600b53ac53f5b0062080006", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGroup.json new file mode 100644 index 000000000000..34a06b18232d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGroup.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGroupUser.json new file mode 100644 index 000000000000..3c7a136d1a41 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadGroupUser.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "59306a29e4bbd510dc24e5f9", + "userId": "5931a75ae4bbd512a88c680b" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadIdentityProvider.json new file mode 100644 index 000000000000..3681c20a2533 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadIdentityProvider.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "identityProviderName": "aadB2C" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadLogger.json new file mode 100644 index 000000000000..95d04210a3c0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadLogger.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "loggerId": "templateLogger" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadNamedValue.json new file mode 100644 index 000000000000..54d4de9862b2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadNamedValue.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "namedValueId": "testarmTemplateproperties2" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadNotificationRecipientEmail.json new file mode 100644 index 000000000000..d567a2989f56 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadNotificationRecipientEmail.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "notificationName": "RequestPublisherNotificationMessage", + "email": "contoso@live.com" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadNotificationRecipientUser.json new file mode 100644 index 000000000000..0408b150b597 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadNotificationRecipientUser.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "notificationName": "RequestPublisherNotificationMessage", + "userId": "576823d0a40f7e74ec07d642" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadOpenIdConnectProvider.json new file mode 100644 index 000000000000..1a47a466efe2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadOpenIdConnectProvider.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "opid": "templateOpenIdConnect2" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPolicy.json new file mode 100644 index 000000000000..9c9de61a3dac --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPolicy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPolicyFragment.json new file mode 100644 index 000000000000..f952d0b5034d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPolicyFragment.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "id": "policyFragment1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPolicyRestriction.json new file mode 100644 index 000000000000..80bf4096328c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPolicyRestriction.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyRestrictionId": "policyRestriction1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPortalConfig.json new file mode 100644 index 000000000000..689b4a8c65cb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPortalConfig.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "portalConfigId": "default" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPortalRevision.json new file mode 100644 index 000000000000..1a63e6f5aaee --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadPortalRevision.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "portalRevisionId": "20201112101010" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProduct.json new file mode 100644 index 000000000000..f0c461588680 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProduct.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "unlimited" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductApi.json new file mode 100644 index 000000000000..5e932b10793a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductApi.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "5931a75ae4bbd512a88c680b", + "apiId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductGroup.json new file mode 100644 index 000000000000..3f50ca884192 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductGroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "5931a75ae4bbd512a88c680b", + "groupId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductPolicy.json new file mode 100644 index 000000000000..3eb8ddedc00c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductPolicy.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "unlimited", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductTag.json new file mode 100644 index 000000000000..205d92ea181b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductTag.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "59306a29e4bbd510dc24e5f8", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductWiki.json new file mode 100644 index 000000000000..4e1b57f24583 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadProductWiki.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadSignInSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadSignInSettings.json new file mode 100644 index 000000000000..b497f1fc5989 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadSignInSettings.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadSignUpSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadSignUpSettings.json new file mode 100644 index 000000000000..b497f1fc5989 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadSignUpSettings.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadSubscription.json new file mode 100644 index 000000000000..c9666ec3e8d1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadSubscription.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "sid": "5931a769d8d14f0ad8ce13b8" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadTag.json new file mode 100644 index 000000000000..b92c25dd4015 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadTag.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadTenantAccess.json new file mode 100644 index 000000000000..360500074853 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadTenantAccess.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "accessName": "access" + }, + "responses": { + "200": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadUser.json new file mode 100644 index 000000000000..b8bd3426f273 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadUser.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512a88c680b" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspace.json new file mode 100644 index 000000000000..4f9188ed49ce --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspace.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApi.json new file mode 100644 index 000000000000..f258e84ccbb7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApi.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiDiagnostic.json new file mode 100644 index 000000000000..43df72b77a6c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiDiagnostic.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiOperation.json new file mode 100644 index 000000000000..c37365ae6d29 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiOperation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiOperationPolicy.json new file mode 100644 index 000000000000..3af44c6da500 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiOperationPolicy.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "5600b539c53f5b0062040001", + "operationId": "5600b53ac53f5b0062080006", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiPolicy.json new file mode 100644 index 000000000000..1c546dec46f9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "57d1f7558aa04f15146d9d8a", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiRelease.json new file mode 100644 index 000000000000..2f5ba7a88bb1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiRelease.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "a1", + "releaseId": "5a7cb545298324c53224a799" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiSchema.json new file mode 100644 index 000000000000..57731be0932b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiSchema.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "57d1f7558aa04f15146d9d8a", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiVersionSet.json new file mode 100644 index 000000000000..9e4f11ed710a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceApiVersionSet.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "versionSetId": "vs1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceBackend.json new file mode 100644 index 000000000000..430fd4145b7b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceBackend.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "backendId": "sfbackend" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceCertificate.json new file mode 100644 index 000000000000..16f8ed04fb28 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceCertificate.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "certificateId": "templateCert1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceDiagnostic.json new file mode 100644 index 000000000000..1fb7e7c4f550 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceDiagnostic.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "diagnosticId": "applicationinsights" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceGroup.json new file mode 100644 index 000000000000..658c27af1996 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceGroup.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "groupId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceGroupUser.json new file mode 100644 index 000000000000..b33f38eac20d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceGroupUser.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "groupId": "59306a29e4bbd510dc24e5f9", + "userId": "5931a75ae4bbd512a88c680b" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceLogger.json new file mode 100644 index 000000000000..a5ae84bf0a9c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceLogger.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "loggerId": "templateLogger" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceNamedValue.json new file mode 100644 index 000000000000..6dc35c7948d7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceNamedValue.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "namedValueId": "testarmTemplateproperties2" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientEmail.json new file mode 100644 index 000000000000..450e74bc93f1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientEmail.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "notificationName": "RequestPublisherNotificationMessage", + "email": "contoso@live.com" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientUser.json new file mode 100644 index 000000000000..db6b6bde9668 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientUser.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "notificationName": "RequestPublisherNotificationMessage", + "userId": "576823d0a40f7e74ec07d642" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspacePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspacePolicy.json new file mode 100644 index 000000000000..98b474c84099 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspacePolicy.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspacePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspacePolicyFragment.json new file mode 100644 index 000000000000..87ce7b42ce48 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspacePolicyFragment.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "id": "policyFragment1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceProduct.json new file mode 100644 index 000000000000..1324401ebcac --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceProduct.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "unlimited" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceProductPolicy.json new file mode 100644 index 000000000000..9174fca64fd4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceProductPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "unlimited", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceSchema.json new file mode 100644 index 000000000000..6e789f847176 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceSchema.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "schemaId": "myschema" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceSubscription.json new file mode 100644 index 000000000000..e71e15eba752 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceSubscription.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "sid": "5931a769d8d14f0ad8ce13b8" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceTag.json new file mode 100644 index 000000000000..d2f79c86c3f8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementHeadWorkspaceTag.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementIdentityProviderListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementIdentityProviderListSecrets.json new file mode 100644 index 000000000000..faf1448a42ba --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementIdentityProviderListSecrets.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "identityProviderName": "aadB2C" + }, + "responses": { + "200": { + "body": { + "clientSecret": "XXXXXXX" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiDiagnostics.json new file mode 100644 index 000000000000..6c7bbd04be0b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiDiagnostics.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "echo-api" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + }, + "frontend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + }, + "backend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + } + } + } + ], + "count": 1 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiIssueAttachments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiIssueAttachments.json new file mode 100644 index 000000000000..1b974e9d87e2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiIssueAttachments.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a", + "issueId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "name": "57d2ef278aa04f0888cba3f3", + "properties": { + "title": "Issue attachment.", + "contentFormat": "link", + "content": "https://.../image.jpg" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiIssueComments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiIssueComments.json new file mode 100644 index 000000000000..ba53022afd6b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiIssueComments.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a", + "issueId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "name": "599e29ab193c3c0bd0b3e2fb", + "properties": { + "text": "Issue comment.", + "createdDate": "2018-02-01T22:21:20.467Z", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiIssues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiIssues.json new file mode 100644 index 000000000000..b0695206ab24 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiIssues.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperationPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperationPolicies.json new file mode 100644 index 000000000000..d1221d733823 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperationPolicies.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "599e2953193c3c0bd0b3e2fa", + "operationId": "599e29ab193c3c0bd0b3e2fb" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/599e2953193c3c0bd0b3e2fa/operations/599e29ab193c3c0bd0b3e2fb/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n xxx\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperationTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperationTags.json new file mode 100644 index 000000000000..23afd6ac701f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperationTags.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0888cba3f6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperations.json new file mode 100644 index 000000000000..25dd8f49cf22 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperations.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "displayName": "CancelOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cda", + "properties": { + "displayName": "GetMostRecentOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cd9", + "properties": { + "displayName": "GetOpenOrders", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cdb", + "properties": { + "displayName": "GetOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOrder" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cd8", + "properties": { + "displayName": "submitOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/submitOrder" + } + } + ], + "count": 5, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperationsByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperationsByTags.json new file mode 100644 index 000000000000..9c763c194f47 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiOperationsByTags.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "a1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tag": { + "id": "/tags/apitag123", + "name": "awesomeTag" + }, + "operation": { + "id": "/apis/echo-api/operations/create-resource", + "apiName": "Echo API", + "apiRevision": "1", + "name": "Create resource", + "method": "POST", + "urlTemplate": "/resource", + "description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend." + } + } + ], + "count": 1 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiPolicies.json new file mode 100644 index 000000000000..e5d038cdf6b6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiPolicies.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "5600b59475ff190048040001" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiProducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiProducts.json new file mode 100644 index 000000000000..3c49675782ab --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiProducts.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/apis/products", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "Unlimited", + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "subscriptionRequired": true, + "approvalRequired": true, + "subscriptionsLimit": 1, + "state": "published" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiReleases.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiReleases.json new file mode 100644 index 000000000000..9f8f046b33cc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiReleases.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "a1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/apis/releases", + "name": "5a7cb545298324c53224a799", + "properties": { + "createdDateTime": "2018-02-08T20:38:29.173Z", + "updatedDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiRevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiRevisions.json new file mode 100644 index 000000000000..b31d71c965dc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiRevisions.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1", + "apiRevision": "1", + "createdDateTime": "2018-02-01T22:21:20.467Z", + "updatedDateTime": "2018-02-01T22:21:20.467Z", + "isOnline": true, + "isCurrent": true + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiSchemas.json new file mode 100644 index 000000000000..dc414ffbe86f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiSchemas.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59d5b28d1f7fab116c282650" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "name": "59d5b28e1f7fab116402044e", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiTagDescriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiTagDescriptions.json new file mode 100644 index 000000000000..6d6b909697c0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiTagDescriptions.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tagDescriptions/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b539c53f5b0062060002", + "properties": { + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "displayName": "tag1", + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiTags.json new file mode 100644 index 000000000000..9e116aa4cec8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiTags.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiVersionSets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiVersionSets.json new file mode 100644 index 000000000000..6b41bf357634 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiVersionSets.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "name": "vs1", + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs2", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "name": "vs2", + "properties": { + "displayName": "api set 2", + "versioningScheme": "Query", + "description": "Version configuration 2" + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiWikis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiWikis.json new file mode 100644 index 000000000000..cca1dbff27a2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApiWikis.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "name": "default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApis.json new file mode 100644 index 000000000000..cda9f7748f21 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApis.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "type": "Microsoft.ApiManagement/service/apis", + "name": "a1", + "properties": { + "displayName": "api1", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "api1", + "protocols": [ + "https" + ], + "isCurrent": true, + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a73933b8f27f7cc82a2d533", + "type": "Microsoft.ApiManagement/service/apis", + "name": "5a73933b8f27f7cc82a2d533", + "properties": { + "displayName": "api1", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "api1", + "protocols": [ + "https" + ], + "isCurrent": true, + "apiVersion": "v1", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api", + "properties": { + "displayName": "Echo API", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo", + "protocols": [ + "https" + ], + "isCurrent": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a7390baa5816a110435aee0", + "type": "Microsoft.ApiManagement/service/apis", + "name": "5a7390baa5816a110435aee0", + "properties": { + "displayName": "Swagger Petstore Extensive", + "apiRevision": "1", + "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", + "serviceUrl": "http://petstore.swagger.wordnik.com/api", + "path": "vvv", + "protocols": [ + "https" + ], + "isCurrent": true + } + } + ], + "count": 4, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApisByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApisByTags.json new file mode 100644 index 000000000000..1997fcb990e3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListApisByTags.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tag": { + "id": "/tags/apitag123", + "name": "awesomeTag" + }, + "api": { + "id": "/apis/echo-api", + "name": "Echo API", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo", + "isCurrent": true + } + } + ], + "count": 1 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationAccessPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationAccessPolicies.json new file mode 100644 index 000000000000..a5f48ed211b9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationAccessPolicies.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "authorizationId": "authz1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "name": "5585d6cd-2289-42e9-ab9b-3e2e23d74b4a", + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", + "objectId": "5585d6cd-2289-42e9-ab9b-3e2e23d74b4a" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationProviders.json new file mode 100644 index 000000000000..438a1c2ac341 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationProviders.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "aadwithauthcode", + "properties": { + "displayName": "aadwithauthcode", + "identityProvider": "aad", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", + "scopes": "User.Read.All Group.Read.All", + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "tenantId": "common" + } + } + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "aadwithclientcred", + "properties": { + "displayName": "aadwithclientcred", + "identityProvider": "aad", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "clientCredentials": { + "scopes": "User.Read.All Group.Read.All", + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "tenantId": "common" + } + } + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "google", + "properties": { + "displayName": "google", + "identityProvider": "google", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com", + "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email" + } + } + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "name": "eventbrite", + "properties": { + "displayName": "eventbrite", + "identityProvider": "oauth2", + "oauth2": { + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", + "grantTypes": { + "authorizationCode": { + "clientId": "clientid", + "scopes": null, + "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", + "refreshUrl": "https://www.eventbrite.com/oauth/token", + "tokenUrl": "https://www.eventbrite.com/oauth/token" + } + } + } + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationServers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationServers.json new file mode 100644 index 000000000000..62518dcb8f4f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationServers.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "name": "newauthServer", + "properties": { + "displayName": "test2", + "useInTestConsole": true, + "useInApiDocumentation": false, + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "name": "newauthServer2", + "properties": { + "displayName": "test3", + "useInTestConsole": false, + "useInApiDocumentation": true, + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "clientAuthenticationMethod": [ + "Basic" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationsAuthCode.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationsAuthCode.json new file mode 100644 index 000000000000..75d519c128e3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationsAuthCode.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "name": "authz1", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "AuthorizationCode", + "status": "Connected" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "name": "authz2", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "AuthorizationCode", + "status": "Error", + "error": { + "code": "Unauthenticated", + "message": "This connection is not authenticated." + } + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationsClientCred.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationsClientCred.json new file mode 100644 index 000000000000..642734305248 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListAuthorizationsClientCred.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithclientcred" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "name": "authz1", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "ClientCredentials", + "parameters": { + "clientId": "clientsecretid" + }, + "status": "Connected" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz2", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "name": "authz2", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "ClientCredentials", + "parameters": { + "clientId": "clientsecretid" + }, + "status": "Error", + "error": { + "code": "Unauthorized", + "message": "Failed to acquire access token for service using client credentials flow: IdentityProvider=aadwithclientcred. Correlation Id=6299d09b-03b7-46ed-b355-0453451d7e49, UTC TimeStamp=5/14/2022 4:53:19 PM, Error: Failed to exchange client credentials for token. Response code=Unauthorized, Details:\r\n{\"error\":\"invalid_client\",\"error_description\":\"AADSTS7000215: Invalid client secret provided. Ensure the secret being sent in the request is the client secret value, not the client secret ID, for a secret added to app 'clientsecretid'.\\r\\nTrace ID: 4a18d3cd-9ad5-4664-b3eb-daaa2f435f00\\r\\nCorrelation ID: dde60c16-35cb-4572-8226-bfb4233af8d7\\r\\nTimestamp: 2022-05-14 16:53:19Z\",\"error_codes\":[7000215],\"timestamp\":\"2022-05-14 16:53:19Z\",\"trace_id\":\"4a18d3cd-9ad5-4664-b3eb-daaa2f435f00\",\"correlation_id\":\"dde60c16-35cb-4572-8226-bfb4233af8d7\",\"error_uri\":\"https://login.windows.net/error?code=7000215\"}" + } + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListBackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListBackends.json new file mode 100644 index 000000000000..27ef6e38149e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListBackends.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "proxybackend", + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListCaches.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListCaches.json new file mode 100644 index 000000000000..75f48f0ce327 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListCaches.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", + "type": "Microsoft.ApiManagement/service/caches", + "name": "c1", + "properties": { + "useFromLocation": "default", + "description": "Redis cache instances in West India", + "connectionString": "{{5f7fbca77a891a2200f3db38}}", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + } + } + ], + "count": 1 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListCertificates.json new file mode 100644 index 000000000000..63f2a6d7f06e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListCertificates.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/kjoshiarmtemplateCert1", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "templateCert1", + "properties": { + "subject": "CN=mutual-authcert", + "thumbprint": "EBA************************48594A6", + "expirationDate": "2017-04-23T17:03:41Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "templateCertkv", + "properties": { + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690", + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + } + } + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListContentTypeContentItems.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListContentTypeContentItems.json new file mode 100644 index 000000000000..7e5b86d43dba --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListContentTypeContentItems.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "contentTypeId": "page" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "properties": { + "en_us": { + "title": "About", + "description": "Short story about the company.", + "keywords": "company, about", + "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "permalink": "/about" + } + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListContentTypes.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListContentTypes.json new file mode 100644 index 000000000000..1d6489dc49a5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListContentTypes.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/contentTypes/page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "name": "page", + "properties": { + "name": "Page", + "description": "A regular page", + "schema": { + "properties": { + "en_us": { + "type": "object", + "properties": { + "title": { + "title": "Title", + "description": "Page title. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "description": { + "title": "Description", + "description": "Page description. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "keywords": { + "title": "Keywords", + "description": "Page keywords. This property gets included in SEO attributes.", + "type": "string", + "indexed": true + }, + "permalink": { + "title": "Permalink", + "description": "Page permalink, e.g. '/about'.", + "type": "string", + "indexed": true + }, + "documentId": { + "title": "Document ID", + "description": "Reference to page content document.", + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "title", + "permalink", + "documentId" + ] + } + }, + "additionalProperties": false + }, + "version": "1.0.0" + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListDiagnostics.json new file mode 100644 index 000000000000..0c04b5cfe6f5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListDiagnostics.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "verbosity": "information", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + }, + "frontend": { + "request": { + "headers": [], + "body": { + "bytes": 0 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 0 + } + } + }, + "backend": { + "request": { + "headers": [], + "body": { + "bytes": 0 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 0 + } + } + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/azuremonitor", + "type": "Microsoft.ApiManagement/service/diagnostics", + "name": "azuremonitor", + "properties": { + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + } + } + } + ], + "count": 1 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListDocumentations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListDocumentations.json new file mode 100644 index 000000000000..21315c7c6546 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListDocumentations.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test", + "type": "Microsoft.ApiManagement/service/documentations", + "name": "test", + "properties": { + "title": "test", + "content": "Test content " + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test2", + "type": "Microsoft.ApiManagement/service/documentations", + "name": "test2", + "properties": { + "title": "test", + "content": "Test content " + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test3", + "type": "Microsoft.ApiManagement/service/documentations", + "name": "test3", + "properties": { + "title": "test", + "content": "Test content " + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayApis.json new file mode 100644 index 000000000000..4ab0e1834907 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayApis.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/57681820a40f7eb6c49f6aca", + "type": "Microsoft.ApiManagement/service/gateways/apis", + "name": "57681820a40f7eb6c49f6aca", + "properties": { + "displayName": "api_57681820a40f7eb6c49f6acb", + "apiRevision": "1", + "description": "description_57681820a40f7eb6c49f6acc", + "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd", + "path": "suffix_57681820a40f7eb6c49f6ace", + "protocols": [ + "https" + ], + "isCurrent": true + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayCertificateAuthorities.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayCertificateAuthorities.json new file mode 100644 index 000000000000..5d004a529b0e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayCertificateAuthorities.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "name": "cert1", + "properties": { + "isTrusted": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert2", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "name": "cert2", + "properties": { + "isTrusted": true + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayConfigConnection.json new file mode 100644 index 000000000000..264ebe5f0bcd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayConfigConnection.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayName": "standard-gw-1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", + "name": "gcc-1", + "type": "Microsoft.ApiManagement/gateways/configConnections", + "etag": "AAAAAAAWN/4=", + "properties": { + "provisioningState": "Succeeded", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001", + "defaultHostname": "gcc-1-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net", + "hostnames": [ + "gcc1standard-gw-1.gateway.eastus.azure-api.net" + ] + } + }, + { + "etag": "AAAAAAAWKwo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-2", + "name": "gcc-2", + "properties": { + "provisioningState": "Succeeded", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-002", + "defaultHostname": "gcc-2-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net" + }, + "type": "Microsoft.ApiManagement/gateways/configConnetions" + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayHostnameConfigurations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayHostnameConfigurations.json new file mode 100644 index 000000000000..36b1dc2fe938 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewayHostnameConfigurations.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "name": "default", + "properties": { + "hostname": "*", + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "negotiateClientCertificate": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/hostname1", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "name": "default", + "properties": { + "hostname": "foo.bar.com", + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert2", + "negotiateClientCertificate": true + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGateways.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGateways.json new file mode 100644 index 000000000000..3b99cbd4b0f8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGateways.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", + "type": "Microsoft.ApiManagement/service/gateways", + "name": "a1", + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location 1" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw2", + "type": "Microsoft.ApiManagement/service/gateways", + "name": "5a73933b8f27f7cc82a2d533", + "properties": { + "description": "my gateway 2", + "locationData": { + "name": "my location 2" + } + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewaysBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewaysBySubscription.json new file mode 100644 index 000000000000..fc59e806eecf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewaysBySubscription.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1", + "name": "standard-gw-1", + "type": "Microsoft.ApiManagement/gateways", + "tags": { + "owner": "v-aswmoh", + "ReleaseName": "Z3" + }, + "location": "West US", + "etag": "AAAAAAAWN/4=", + "properties": { + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "frontend": { + "defaultHostname": "standard-gw-1.westus.gateway.azure-api.net" + }, + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "configurationApi": { + "hostname": "standard-gw-1.westus.configuration.gateway.azure-api.net" + } + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "bar@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T09:40:00.7106733Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg2/providers/Microsoft.ApiManagement/gateways/workspace-gw-2", + "name": "workspace-gw-2", + "type": "Microsoft.ApiManagement/gateways", + "tags": { + "Owner": "foo" + }, + "location": "East US", + "etag": "AAAAAAAWKwo=", + "properties": { + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-06-16T09:40:00.9453556Z" + }, + "sku": { + "name": "WorkspaceGatewayPremium", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json new file mode 100644 index 000000000000..981066ad0a32 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1", + "name": "standard-gw-1", + "type": "Microsoft.ApiManagement/gateways", + "tags": { + "owner": "v-aswmoh", + "ReleaseName": "Z3" + }, + "location": "West US", + "etag": "AAAAAAAWN/4=", + "properties": { + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "frontend": { + "defaultHostname": "standard-gw-1.westus.gateway.azure-api.net" + }, + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "configurationApi": { + "hostname": "standard-gw-1.westus.configuration.gateway.azure-api.net" + } + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "bar@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T09:40:00.7106733Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-2", + "name": "standard-gw-2", + "type": "Microsoft.ApiManagement/gateways", + "tags": { + "Owner": "vitaliik" + }, + "location": "East US", + "etag": "AAAAAAAWKwo=", + "properties": { + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "frontend": { + "defaultHostname": "standard-gw-2.eastus.gateway.azure-api.net" + }, + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn2/subnets/sn2" + } + }, + "configurationApi": { + "hostname": "standard-gw-2.eastus.configuration.gateway.azure-api.net" + } + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGlobalSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGlobalSchemas.json new file mode 100644 index 000000000000..65a86c870c50 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGlobalSchemas.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "name": "schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema2", + "type": "Microsoft.ApiManagement/service/schemas", + "name": "schema2", + "properties": { + "description": "sample schema description", + "schemaType": "json", + "document": { + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Person", + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + }, + "age": { + "description": "Age in years which must be equal to or greater than zero.", + "type": "integer", + "minimum": 0 + } + } + } + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGraphQLApiResolverPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGraphQLApiResolverPolicies.json new file mode 100644 index 000000000000..27b7ad34c9f4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGraphQLApiResolverPolicies.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "599e2953193c3c0bd0b3e2fa", + "resolverId": "599e29ab193c3c0bd0b3e2fb" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/599e2953193c3c0bd0b3e2fa/resolvers/599e29ab193c3c0bd0b3e2fb/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n GET\r\n\r\n/api/users \r\n \r\n \r\n \r\n \r\n \r\n { \"id\": \"{{body.id}}\" } \r\n" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGraphQLApiResolvers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGraphQLApiResolvers.json new file mode 100644 index 000000000000..dabfa9340450 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGraphQLApiResolvers.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d2ef278aa04f0888cba3f3", + "resolverId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "displayName": "Query Users", + "path": "Query/users", + "description": "A GraphQL Resolver example" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cda", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "name": "57d2ef278aa04f0ad01d6cda", + "properties": { + "displayName": "Mutation makeUser", + "path": "Mutation/makeUser", + "description": "A GraphQL Resolver example" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cd9", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "name": "57d2ef278aa04f0ad01d6cd9", + "properties": { + "displayName": "Query for User Id field", + "path": "User/id", + "description": "A GraphQL Resolver example" + } + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGroupUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGroupUsers.json new file mode 100644 index 000000000000..53caad0da33e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGroupUsers.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/kjoshiarmTemplateUser1", + "type": "Microsoft.ApiManagement/service/groups/users", + "name": "armTemplateUser1", + "properties": { + "firstName": "user1", + "lastName": "lastname1", + "email": "user1@live.com", + "state": "active", + "registrationDate": "2017-05-31T18:54:41.447Z", + "note": "note for user 1", + "identities": [ + { + "provider": "Basic", + "id": "user1@live.com" + } + ] + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGroups.json new file mode 100644 index 000000000000..79850ade0966 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListGroups.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/groups", + "name": "5600b59375ff190048020001", + "properties": { + "displayName": "Administrators", + "description": "Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group.", + "builtIn": true, + "type": "system" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/groups", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "description": "awesome group of people", + "builtIn": false, + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/groups", + "name": "5600b59375ff190048020002", + "properties": { + "displayName": "Developers", + "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.", + "builtIn": true, + "type": "system" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020003", + "type": "Microsoft.ApiManagement/service/groups", + "name": "5600b59375ff190048020003", + "properties": { + "displayName": "Guests", + "description": "Guests is a built-in group. Its membership is managed by the system. Unauthenticated users visiting the developer portal fall into this group.", + "builtIn": true, + "type": "system" + } + } + ], + "count": 4, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListIdentityProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListIdentityProviders.json new file mode 100644 index 000000000000..dff74042749b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListIdentityProviders.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Google", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "Google", + "properties": { + "clientId": "googleId", + "type": "google" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Aad", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "Aad", + "properties": { + "clientId": "aadapplicationid", + "type": "aad", + "allowedTenants": [ + "samiraad.onmicrosoft.com" + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "AadB2C", + "properties": { + "clientId": "aadb2clientId", + "type": "aadB2C", + "allowedTenants": [ + "samirtestbc.onmicrosoft.com" + ], + "signupPolicyName": "B2C_1_Signup_Default", + "signinPolicyName": "B2C_1_Signin_Default" + } + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListIssues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListIssues.json new file mode 100644 index 000000000000..142d7d182905 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListIssues.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListLoggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListLoggers.json new file mode 100644 index 000000000000..ee345bd446d9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListLoggers.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "azuremonitor", + "properties": { + "loggerType": "azureMonitor", + "isBuffered": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/vvktest", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "vvktest", + "properties": { + "loggerType": "applicationInsights", + "credentials": { + "instrumentationKey": "{{Logger-Credentials-5b1a17ef2b3f91153004b10d}}" + }, + "isBuffered": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/applicationinsights", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "applicationinsights", + "properties": { + "loggerType": "applicationInsights", + "description": "miaoappinsight", + "credentials": { + "instrumentationKey": "{{Logger-Credentials-5b2056062b3f911ae84a3069}}" + }, + "isBuffered": true + } + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNamedValues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNamedValues.json new file mode 100644 index 000000000000..9c5a83403201 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNamedValues.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/592f1174cc83890dc4f32686", + "type": "Microsoft.ApiManagement/service/namedValues", + "name": "592f1174cc83890dc4f32686", + "properties": { + "displayName": "Logger-Credentials-592f1174cc83890dc4f32687", + "value": "propValue", + "secret": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "name": "testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret", + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + } + }, + "tags": [ + "foo", + "bar" + ], + "secret": true + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNotificationRecipientEmails.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNotificationRecipientEmails.json new file mode 100644 index 000000000000..918705115d60 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNotificationRecipientEmails.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "notificationName": "RequestPublisherNotificationMessage" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "name": "contoso@live.com", + "properties": { + "email": "contoso@live.com" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "name": "foobar!live", + "properties": { + "email": "foobar!live" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "name": "foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNotificationRecipientUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNotificationRecipientUsers.json new file mode 100644 index 000000000000..b40b46d50f48 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNotificationRecipientUsers.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "notificationName": "RequestPublisherNotificationMessage" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", + "name": "576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNotifications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNotifications.json new file mode 100644 index 000000000000..2adea3effbff --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListNotifications.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "RequestPublisherNotificationMessage", + "properties": { + "title": "Subscription requests (requiring approval)", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/PurchasePublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "PurchasePublisherNotificationMessage", + "properties": { + "title": "New subscriptions", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + ] + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewApplicationNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "NewApplicationNotificationMessage", + "properties": { + "title": "Application gallery requests", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" + ], + "users": [] + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/BCC", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "BCC", + "properties": { + "title": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers.", + "recipients": { + "emails": [], + "users": [] + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewIssuePublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "NewIssuePublisherNotificationMessage", + "properties": { + "title": "New issue or comment", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.", + "recipients": { + "emails": [], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + ] + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/AccountClosedPublisher", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "AccountClosedPublisher", + "properties": { + "title": "Close account message", + "description": "The following email recipients and users will receive email notifications when developer closes his account", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" + ], + "users": [] + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/QuotaLimitApproachingPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "properties": { + "title": "Approaching subscription quota limit", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.", + "recipients": { + "emails": [], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + ] + } + } + } + ], + "count": 7, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListOpenIdConnectProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListOpenIdConnectProviders.json new file mode 100644 index 000000000000..e60ec7c403ad --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListOpenIdConnectProviders.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "name": "templateOpenIdConnect2", + "properties": { + "displayName": "templateoidprovider2", + "description": "open id provider template2", + "metadataEndpoint": "https://oidprovider-template2.net", + "clientId": "oidprovidertemplate2", + "useInTestConsole": false, + "useInApiDocumentation": true + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListOperations.json new file mode 100644 index 000000000000..438f98792b17 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListOperations.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ApiManagement/service/write", + "display": { + "provider": "Microsoft API Management", + "resource": "Service", + "operation": "Create a new instance of API Management Service", + "description": "Create a new instance of API Management Service" + } + }, + { + "name": "Microsoft.ApiManagement/service/read", + "display": { + "provider": "Microsoft API Management", + "resource": "Service", + "operation": "Read metadata for an API Management Service instance", + "description": "Read metadata for an API Management Service instance" + } + }, + { + "name": "Microsoft.ApiManagement/service/delete", + "display": { + "provider": "Microsoft API Management", + "resource": "Service", + "operation": "Delete API Management Service instance", + "description": "Delete API Management Service instance" + } + }, + { + "origin": "system", + "name": "Microsoft.ApiManagement/service/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft API Management", + "resource": "Service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for API Management service" + } + }, + { + "name": "Microsoft.ApiManagement/service/tenant/operationResults/read", + "display": { + "provider": "Microsoft API Management", + "resource": "Results of async operations", + "operation": "Get operation results or Get operation result", + "description": "Get list of operation results or Get result of a specific operation" + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicies.json new file mode 100644 index 000000000000..b6d8bc230403 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicies.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyDescriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyDescriptions.json new file mode 100644 index 000000000000..65362f1af115 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyDescriptions.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "Api" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-basic", + "type": "Microsoft.ApiManagement/service/policyDescriptions", + "name": "authentication-basic", + "properties": { + "description": "Authenticate with the backend service using Basic authentication. Use in the inbound section at API scope.", + "scope": 268435471 + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-certificate", + "type": "Microsoft.ApiManagement/service/policyDescriptions", + "name": "authentication-certificate", + "properties": { + "description": "Authenticate with the backend service using a client certificate. Use in the inbound section at API scope.", + "scope": 268435471 + } + } + ], + "count": 2 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyFragmentReferences.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyFragmentReferences.json new file mode 100644 index 000000000000..2163d24644b9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyFragmentReferences.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "id": "policyFragment1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy" + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyFragments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyFragments.json new file mode 100644 index 000000000000..649b52644e66 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyFragments.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "name": "policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyRestrictions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyRestrictions.json new file mode 100644 index 000000000000..e7461add9495 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPolicyRestrictions.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", + "type": "Microsoft.ApiManagement/service/policyRestrictions", + "name": "policyRestriction1", + "properties": { + "scope": "Sample Path to the policy document.", + "requireBase": "true" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPortalConfig.json new file mode 100644 index 000000000000..e288a91a7bfc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPortalConfig.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", + "type": "Microsoft.ApiManagement/service/portalconfigs", + "name": "default", + "properties": { + "enableBasicAuth": true, + "signin": { + "require": false + }, + "signup": { + "termsOfService": { + "text": "I agree to the service terms and conditions.", + "requireConsent": false + } + }, + "delegation": { + "delegateRegistration": false, + "delegateSubscription": false, + "delegationUrl": null, + "validationKey": null + }, + "csp": { + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ], + "allowedSources": [ + "*.contoso.com" + ] + }, + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] + } + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPortalRevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPortalRevisions.json new file mode 100644 index 000000000000..da2b69c6a49e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPortalRevisions.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112000000", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "name": "20201112000000", + "properties": { + "description": "portal revision", + "statusDetails": null, + "status": "completed", + "isCurrent": false, + "createdDateTime": "2020-11-12T22:10:09.673Z", + "updatedDateTime": "2020-11-12T22:12:41.46Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "name": "20201112101010", + "properties": { + "description": "portal revision 1", + "statusDetails": null, + "status": "completed", + "isCurrent": true, + "createdDateTime": "2020-11-12T22:51:36.47Z", + "updatedDateTime": "2020-11-12T22:52:00.097Z" + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPortalSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPortalSettings.json new file mode 100644 index 000000000000..7d8f7cb31690 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPortalSettings.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "delegation", + "properties": { + "subscriptions": { + "enabled": false + }, + "userRegistration": { + "enabled": false + }, + "enabled": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "signin", + "properties": { + "enabled": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "signup", + "properties": { + "enabled": true, + "termsOfService": { + "text": "Terms of service", + "enabled": false, + "consentRequired": false + } + } + } + ], + "count": 3 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPrivateEndpointConnections.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPrivateEndpointConnections.json new file mode 100644 index 000000000000..207a165c7514 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPrivateEndpointConnections.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "name": "privateEndpointProxyName", + "properties": { + "provisioningState": "Pending", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request, thanks", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName2", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "name": "privateEndpointProxyName2", + "properties": { + "provisioningState": "Pending", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName2" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request, thanks", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPrivateLinkGroupResources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPrivateLinkGroupResources.json new file mode 100644 index 000000000000..24c3ab4131e2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListPrivateLinkGroupResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway", + "name": "Gateway", + "type": "Microsoft.ApiManagement/service/privateLinkResources", + "properties": { + "groupId": "Gateway", + "requiredMembers": [ + "Gateway" + ], + "requiredZoneNames": [ + "privateLink.azure-api.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductApiLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductApiLinks.json new file mode 100644 index 000000000000..6315efddd140 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductApiLinks.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "product1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductApis.json new file mode 100644 index 000000000000..6e68af5f36da --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductApis.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "5768181ea40f7eb6c49f6ac7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis/57681820a40f7eb6c49f6aca", + "type": "Microsoft.ApiManagement/service/products/apis", + "name": "57681820a40f7eb6c49f6aca", + "properties": { + "displayName": "api_57681820a40f7eb6c49f6acb", + "apiRevision": "1", + "description": "description_57681820a40f7eb6c49f6acc", + "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd", + "path": "suffix_57681820a40f7eb6c49f6ace", + "protocols": [ + "https" + ], + "isCurrent": true + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductGroupLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductGroupLinks.json new file mode 100644 index 000000000000..41449ac98010 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductGroupLinks.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "product1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1/groupLinks/link1", + "type": "Microsoft.ApiManagement/service/products/groupLinks", + "name": "link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductGroups.json new file mode 100644 index 000000000000..edb2155fcbac --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductGroups.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "5600b57e7e8880006a060002" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020001", + "type": "Microsoft.ApiManagement/service/products/groups", + "name": "5600b57e7e8880006a020001", + "properties": { + "displayName": "Administrators", + "description": "Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group.", + "builtIn": true, + "type": "system" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020002", + "type": "Microsoft.ApiManagement/service/products/groups", + "name": "5600b57e7e8880006a020002", + "properties": { + "displayName": "Developers", + "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.", + "builtIn": true, + "type": "system" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020003", + "type": "Microsoft.ApiManagement/service/products/groups", + "name": "5600b57e7e8880006a020003", + "properties": { + "displayName": "Guests", + "description": "Guests is a built-in group. Its membership is managed by the system. Unauthenticated users visiting the developer portal fall into this group.", + "builtIn": true, + "type": "system" + } + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductPolicies.json new file mode 100644 index 000000000000..a6279841b1b6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductPolicies.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "armTemplateProduct4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/armTemplateProduct4/policies/policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductSubscriptions.json new file mode 100644 index 000000000000..f63a56d3b47f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductSubscriptions.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "5600b57e7e8880006a060002" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions/5600b57e7e8880006a070002", + "type": "Microsoft.ApiManagement/service/products/subscriptions", + "name": "5600b57e7e8880006a070002", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002", + "state": "active", + "createdDate": "2015-09-22T01:57:18.723Z" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductTags.json new file mode 100644 index 000000000000..5829b9fd90f4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductTags.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "57d2ef278aa04f0888cba3f1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductWikis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductWikis.json new file mode 100644 index 000000000000..9445af383279 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductWikis.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "name": "default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProducts.json new file mode 100644 index 000000000000..c94750d7d56b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProducts.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmtemplateCert1", + "type": "Microsoft.ApiManagement/service/products", + "name": "kjoshiarmtemplateCert1", + "properties": { + "displayName": "Dev", + "description": "Development Product", + "subscriptionRequired": false, + "state": "published" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter", + "type": "Microsoft.ApiManagement/service/products", + "name": "starter", + "properties": { + "displayName": "Starter", + "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", + "terms": "", + "subscriptionRequired": true, + "approvalRequired": false, + "subscriptionsLimit": 1, + "state": "published" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited", + "type": "Microsoft.ApiManagement/service/products", + "name": "unlimited", + "properties": { + "displayName": "Unlimited", + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "subscriptionRequired": true, + "approvalRequired": true, + "subscriptionsLimit": 1, + "state": "published" + } + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductsByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductsByTags.json new file mode 100644 index 000000000000..c17ab1830171 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListProductsByTags.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tag": { + "id": "/tags/apitag123", + "name": "awesomeTag" + }, + "product": { + "id": "/products/starter", + "name": "Starter", + "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", + "terms": "", + "subscriptionRequired": true, + "approvalRequired": false, + "subscriptionsLimit": 1, + "state": "published" + } + } + ], + "count": 1 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListRegions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListRegions.json new file mode 100644 index 000000000000..81db4ad0bee4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListRegions.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "West US", + "isMasterRegion": true, + "isDeleted": false + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSKUs-Consumption.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSKUs-Consumption.json new file mode 100644 index 000000000000..645f4b34ce2c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSKUs-Consumption.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-09-01-preview", + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Consumption" + }, + "capacity": null + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSKUs-Dedicated.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSKUs-Dedicated.json new file mode 100644 index 000000000000..434ceccb05b0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSKUs-Dedicated.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2023-09-01-preview", + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Developer" + }, + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "none" + } + }, + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Basic" + }, + "capacity": { + "minimum": 1, + "maximum": 2, + "default": 1, + "scaleType": "manual" + } + }, + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 4, + "default": 1, + "scaleType": "automatic" + } + }, + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Premium" + }, + "capacity": { + "minimum": 1, + "maximum": 10, + "default": 1, + "scaleType": "automatic" + } + }, + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Isolated" + }, + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "automatic" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSKUs-Gateways.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSKUs-Gateways.json new file mode 100644 index 000000000000..cbb3fc3fe61a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSKUs-Gateways.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-09-01-preview", + "gatewayName": "apimService1", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.ApiManagement/gateways", + "sku": { + "name": "WorkspaceGatewayStandard" + }, + "capacity": { + "minimum": 1, + "maximum": 4, + "default": 1, + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.ApiManagement/gateways", + "sku": { + "name": "WorkspaceGatewayPremium" + }, + "capacity": { + "minimum": 1, + "maximum": 12, + "default": 1, + "scaleType": "Manual" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSecretsPortalSettingsValidationKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSecretsPortalSettingsValidationKey.json new file mode 100644 index 000000000000..25398bbc0cd8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSecretsPortalSettingsValidationKey.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "validationKey": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSecretsTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSecretsTenantAccess.json new file mode 100644 index 000000000000..42d9f422f239 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSecretsTenantAccess.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "accessName": "access" + }, + "responses": { + "200": { + "body": { + "id": "5600b59375ff190048030003", + "primaryKey": "", + "secondaryKey": "", + "enabled": true + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListServiceBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListServiceBySubscription.json new file mode 100644 index 000000000000..97e673f5a8ae --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListServiceBySubscription.json @@ -0,0 +1,377 @@ +{ + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium", + "name": "OGF-Z3-06162021-Premium", + "type": "Microsoft.ApiManagement/service", + "tags": { + "owner": "v-aswmoh", + "ReleaseName": "Z3" + }, + "location": "East US", + "etag": "AAAAAAAWN/4=", + "properties": { + "publisherEmail": "bar@contoso.com", + "publisherName": "Test Premium", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net", + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net", + "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net", + "developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net", + "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net", + "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "ogf-z3-06162021-premium.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificateSource": "BuiltIn" + }, + { + "type": "Proxy", + "hostName": "gateway.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": true, + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + }, + "defaultSslBinding": true, + "certificateSource": "Custom" + }, + { + "type": "DeveloperPortal", + "hostName": "developer.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + }, + "defaultSslBinding": false, + "certificateSource": "Custom" + }, + { + "type": "Management", + "hostName": "mgmt.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + }, + "defaultSslBinding": false, + "certificateSource": "Custom" + }, + { + "type": "ConfigurationApi", + "hostName": "configuration-api.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + }, + "defaultSslBinding": false, + "certificateSource": "Custom" + } + ], + "publicIPAddresses": [ + "13.92.130.49" + ], + "additionalLocations": [ + { + "location": "East US 2", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "zones": [], + "publicIPAddresses": [ + "40.70.24.106" + ], + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net", + "disableGateway": false + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" + }, + "virtualNetworkType": "None", + "certificates": [], + "disableGateway": false, + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "configurationApi": { + "legacyApi": "Enabled" + }, + "publicNetworkAccess": "Enabled" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d", + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789" + } + } + }, + "systemData": { + "createdBy": "bar@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T09:40:00.7106733Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/vvktestcons", + "name": "vvktestcons", + "type": "Microsoft.ApiManagement/service", + "tags": { + "Owner": "vitaliik" + }, + "location": "East US", + "etag": "AAAAAAAWKwo=", + "properties": { + "publisherEmail": "bar@contoso.com", + "publisherName": "vvktestcons", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2020-08-10T18:07:23.4565211Z", + "gatewayUrl": "https://vvktestcons.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "vvktestcons.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "enableClientCertificate": false, + "disableGateway": false, + "publicNetworkAccess": "Enabled" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Standard", + "name": "OGF-Z3-06162021-Standard", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "East US", + "etag": "AAAAAAAWF7M=", + "properties": { + "publisherEmail": "bar@contoso.com", + "publisherName": "Test Standard", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-06-16T09:39:58.6555759Z", + "gatewayUrl": "https://ogf-z3-06162021-standard.azure-api.net", + "gatewayRegionalUrl": "https://ogf-z3-06162021-standard-eastus-01.regional.azure-api.net", + "portalUrl": "https://ogf-z3-06162021-standard.portal.azure-api.net", + "developerPortalUrl": "https://ogf-z3-06162021-standard.developer.azure-api.net", + "managementApiUrl": "https://ogf-z3-06162021-standard.management.azure-api.net", + "scmUrl": "https://ogf-z3-06162021-standard.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "ogf-z3-06162021-standard.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "publicIPAddresses": [ + "13.82.208.32" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA": "true", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "configurationApi": { + "legacyApi": "Enabled" + }, + "publicNetworkAccess": "Enabled" + }, + "sku": { + "name": "Standard", + "capacity": 2 + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "347a5800-ca99-475a-9202-fe38ca79ee41", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d", + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789" + } + } + }, + "systemData": { + "createdBy": "bar@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T09:39:58.4591834Z", + "lastModifiedBy": "bar@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-17T15:05:13.5494721Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/ogf-dev-060921", + "name": "ogf-dev-060921", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "East US", + "etag": "AAAAAAAWEFg=", + "properties": { + "publisherEmail": "v-ssaiprasan@microsoft.com", + "publisherName": "TechM", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-06-09T10:06:22.2133978Z", + "gatewayUrl": "https://ogf-dev-060921.azure-api.net", + "gatewayRegionalUrl": "https://ogf-dev-060921-eastus-01.regional.azure-api.net", + "portalUrl": "https://ogf-dev-060921.portal.azure-api.net", + "developerPortalUrl": "https://ogf-dev-060921.developer.azure-api.net", + "managementApiUrl": "https://ogf-dev-060921.management.azure-api.net", + "scmUrl": "https://ogf-dev-060921.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "ogf-dev-060921.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "publicIPAddresses": [ + "168.62.39.172" + ], + "additionalLocations": [ + { + "location": "South Central US", + "sku": { + "name": "Premium", + "capacity": 9 + }, + "zones": [], + "publicIPAddresses": [ + "13.84.208.29" + ], + "gatewayRegionalUrl": "https://ogf-dev-060921-southcentralus-01.regional.azure-api.net", + "disableGateway": false + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" + }, + "virtualNetworkType": "None", + "certificates": [ + { + "storeName": "Root", + "certificate": { + "expiry": "2021-11-25T22:51:47+00:00", + "thumbprint": "4E8234312EC69245D1AE296C4882D46FB84076A3", + "subject": "CN=*.apim.net" + } + } + ], + "disableGateway": false, + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "configurationApi": { + "legacyApi": "Enabled" + }, + "publicNetworkAccess": "Enabled" + }, + "sku": { + "name": "Premium", + "capacity": 3 + }, + "identity": { + "type": "SystemAssigned", + "principalId": "c9bd4c05-205e-4431-b232-112cf2e9e0aa", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + }, + "systemData": { + "createdBy": "v-ssaiprasan@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-09T10:06:21.7336597Z", + "lastModifiedBy": "v-ssaiprasan@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-10T14:27:05.546816Z" + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json new file mode 100644 index 000000000000..c0672df0d7eb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json @@ -0,0 +1,369 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium", + "name": "OGF-Z3-06162021-Premium", + "type": "Microsoft.ApiManagement/service", + "tags": { + "owner": "v-aswmoh", + "ReleaseName": "Z3" + }, + "location": "East US", + "etag": "AAAAAAAWN/4=", + "properties": { + "publisherEmail": "bar@contoso.com", + "publisherName": "Test Premium", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net", + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net", + "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net", + "developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net", + "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net", + "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "ogf-z3-06162021-premium.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificateSource": "BuiltIn" + }, + { + "type": "Proxy", + "hostName": "gateway.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": true, + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + }, + "defaultSslBinding": true, + "certificateSource": "Custom" + }, + { + "type": "DeveloperPortal", + "hostName": "developer.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + }, + "defaultSslBinding": false, + "certificateSource": "Custom" + }, + { + "type": "Management", + "hostName": "mgmt.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + }, + "defaultSslBinding": false, + "certificateSource": "Custom" + }, + { + "type": "ConfigurationApi", + "hostName": "configuration-api.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + }, + "defaultSslBinding": false, + "certificateSource": "Custom" + } + ], + "publicIPAddresses": [ + "13.92.130.49" + ], + "additionalLocations": [ + { + "location": "East US 2", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "zones": [], + "publicIPAddresses": [ + "40.70.24.106" + ], + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net", + "disableGateway": false + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" + }, + "virtualNetworkType": "None", + "certificates": [], + "disableGateway": false, + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "publicNetworkAccess": "Enabled" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d", + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789" + } + } + }, + "systemData": { + "createdBy": "bar@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T09:40:00.7106733Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/vvktestcons", + "name": "vvktestcons", + "type": "Microsoft.ApiManagement/service", + "tags": { + "Owner": "vitaliik" + }, + "location": "East US", + "etag": "AAAAAAAWKwo=", + "properties": { + "publisherEmail": "bar@contoso.com", + "publisherName": "vvktestcons", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2020-08-10T18:07:23.4565211Z", + "gatewayUrl": "https://vvktestcons.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "vvktestcons.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "enableClientCertificate": false, + "disableGateway": false, + "publicNetworkAccess": "Enabled" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Standard", + "name": "OGF-Z3-06162021-Standard", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "East US", + "etag": "AAAAAAAWF7M=", + "properties": { + "publisherEmail": "bar@contoso.com", + "publisherName": "Test Standard", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-06-16T09:39:58.6555759Z", + "gatewayUrl": "https://ogf-z3-06162021-standard.azure-api.net", + "gatewayRegionalUrl": "https://ogf-z3-06162021-standard-eastus-01.regional.azure-api.net", + "portalUrl": "https://ogf-z3-06162021-standard.portal.azure-api.net", + "developerPortalUrl": "https://ogf-z3-06162021-standard.developer.azure-api.net", + "managementApiUrl": "https://ogf-z3-06162021-standard.management.azure-api.net", + "scmUrl": "https://ogf-z3-06162021-standard.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "ogf-z3-06162021-standard.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "publicIPAddresses": [ + "13.82.208.32" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA": "true", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "publicNetworkAccess": "Enabled" + }, + "sku": { + "name": "Standard", + "capacity": 2 + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "347a5800-ca99-475a-9202-fe38ca79ee41", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d", + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789" + } + } + }, + "systemData": { + "createdBy": "bar@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T09:39:58.4591834Z", + "lastModifiedBy": "bar@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-17T15:05:13.5494721Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/ogf-dev-060921", + "name": "ogf-dev-060921", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "East US", + "etag": "AAAAAAAWEFg=", + "properties": { + "publisherEmail": "v-ssaiprasan@microsoft.com", + "publisherName": "TechM", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-06-09T10:06:22.2133978Z", + "gatewayUrl": "https://ogf-dev-060921.azure-api.net", + "gatewayRegionalUrl": "https://ogf-dev-060921-eastus-01.regional.azure-api.net", + "portalUrl": "https://ogf-dev-060921.portal.azure-api.net", + "developerPortalUrl": "https://ogf-dev-060921.developer.azure-api.net", + "managementApiUrl": "https://ogf-dev-060921.management.azure-api.net", + "scmUrl": "https://ogf-dev-060921.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "ogf-dev-060921.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificateSource": "BuiltIn" + } + ], + "publicIPAddresses": [ + "168.62.39.172" + ], + "additionalLocations": [ + { + "location": "South Central US", + "sku": { + "name": "Premium", + "capacity": 9 + }, + "zones": [], + "publicIPAddresses": [ + "13.84.208.29" + ], + "gatewayRegionalUrl": "https://ogf-dev-060921-southcentralus-01.regional.azure-api.net", + "disableGateway": false + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" + }, + "virtualNetworkType": "None", + "certificates": [ + { + "storeName": "Root", + "certificate": { + "expiry": "2021-11-25T22:51:47+00:00", + "thumbprint": "4E8234312EC69245D1AE296C4882D46FB84076A3", + "subject": "CN=*.apim.net" + } + } + ], + "disableGateway": false, + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "publicNetworkAccess": "Enabled" + }, + "sku": { + "name": "Premium", + "capacity": 3 + }, + "identity": { + "type": "SystemAssigned", + "principalId": "c9bd4c05-205e-4431-b232-112cf2e9e0aa", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + }, + "systemData": { + "createdBy": "v-ssaiprasan@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-09T10:06:21.7336597Z", + "lastModifiedBy": "v-ssaiprasan@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-10T14:27:05.546816Z" + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSku.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSku.json new file mode 100644 index 000000000000..bb21b556366f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSku.json @@ -0,0 +1,224 @@ +{ + "parameters": { + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "service", + "name": "Developer", + "locations": [ + "centralindia" + ], + "locationInfo": [ + { + "location": "centralindia", + "zones": [], + "zoneDetails": [] + } + ], + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "None" + }, + "restrictions": [] + }, + { + "resourceType": "service", + "name": "Standard", + "locations": [ + "centralindia" + ], + "locationInfo": [ + { + "location": "centralindia", + "zones": [], + "zoneDetails": [] + } + ], + "capacity": { + "minimum": 1, + "maximum": 4, + "default": 1, + "scaleType": "Automatic" + }, + "restrictions": [] + }, + { + "resourceType": "service", + "name": "Premium", + "locations": [ + "centralindia" + ], + "locationInfo": [ + { + "location": "centralindia", + "zones": [], + "zoneDetails": [] + } + ], + "capacity": { + "minimum": 1, + "maximum": 10, + "default": 1, + "scaleType": "Automatic" + }, + "restrictions": [] + }, + { + "resourceType": "service", + "name": "Basic", + "locations": [ + "centralindia" + ], + "locationInfo": [ + { + "location": "centralindia", + "zones": [], + "zoneDetails": [] + } + ], + "capacity": { + "minimum": 1, + "maximum": 2, + "default": 1, + "scaleType": "Manual" + }, + "restrictions": [] + }, + { + "resourceType": "service", + "name": "Consumption", + "locations": [ + "centralindia" + ], + "locationInfo": [ + { + "location": "centralindia", + "zones": [], + "zoneDetails": [] + } + ], + "capacity": { + "minimum": 0, + "maximum": 0, + "default": 0, + "scaleType": "None" + }, + "restrictions": [] + }, + { + "resourceType": "service", + "name": "Developer", + "locations": [ + "uaenorth" + ], + "locationInfo": [ + { + "location": "uaenorth", + "zones": [], + "zoneDetails": [] + } + ], + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "None" + }, + "restrictions": [] + }, + { + "resourceType": "service", + "name": "Standard", + "locations": [ + "uaenorth" + ], + "locationInfo": [ + { + "location": "uaenorth", + "zones": [], + "zoneDetails": [] + } + ], + "capacity": { + "minimum": 1, + "maximum": 4, + "default": 1, + "scaleType": "Automatic" + }, + "restrictions": [] + }, + { + "resourceType": "service", + "name": "Premium", + "locations": [ + "uaenorth" + ], + "locationInfo": [ + { + "location": "uaenorth", + "zones": [], + "zoneDetails": [] + } + ], + "capacity": { + "minimum": 1, + "maximum": 10, + "default": 1, + "scaleType": "Automatic" + }, + "restrictions": [] + }, + { + "resourceType": "service", + "name": "Basic", + "locations": [ + "uaenorth" + ], + "locationInfo": [ + { + "location": "uaenorth", + "zones": [], + "zoneDetails": [] + } + ], + "capacity": { + "minimum": 1, + "maximum": 2, + "default": 1, + "scaleType": "Manual" + }, + "restrictions": [] + }, + { + "resourceType": "service", + "name": "Developer", + "locations": [ + "australiacentral" + ], + "locationInfo": [ + { + "location": "australiacentral", + "zones": [], + "zoneDetails": [] + } + ], + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "None" + }, + "restrictions": [] + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSubscriptions.json new file mode 100644 index 000000000000..b87f37cbbd3b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListSubscriptions.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5600b59475ff190048070001", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "5600b59475ff190048070001", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001", + "state": "active", + "createdDate": "2015-09-22T01:57:40.3Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/56eaed3dbaf08b06e46d27fe", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "56eaed3dbaf08b06e46d27fe", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001", + "displayName": "Starter", + "state": "active", + "createdDate": "2016-03-17T17:45:33.837Z", + "startDate": "2016-03-17T00:00:00Z", + "expirationDate": "2016-04-01T00:00:00Z", + "notificationDate": "2016-03-20T00:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "5931a769d8d14f0ad8ce13b8", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "displayName": "Unlimited", + "state": "submitted", + "createdDate": "2017-06-02T17:59:06.223Z" + } + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagApiLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagApiLinks.json new file mode 100644 index 000000000000..6a0b7379677b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagApiLinks.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagOperationLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagOperationLinks.json new file mode 100644 index 000000000000..509939c036e1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagOperationLinks.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "name": "link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagProductLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagProductLinks.json new file mode 100644 index 000000000000..4a467a6ed69b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagProductLinks.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "name": "link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagResources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagResources.json new file mode 100644 index 000000000000..1894cfcc8a30 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTagResources.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tag": { + "id": "/tags/apitag123", + "name": "awesomeTag" + }, + "operation": { + "id": "/apis/echo-api/operations/create-resource", + "apiName": "Echo API", + "apiRevision": "1", + "name": "Create resource", + "method": "POST", + "urlTemplate": "/resource", + "description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend." + } + }, + { + "tag": { + "id": "/tags/apitag123", + "name": "awesomeTag" + }, + "api": { + "id": "/apis/echo-api", + "name": "Echo API", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo", + "isCurrent": true + } + }, + { + "tag": { + "id": "/tags/apitag123", + "name": "awesomeTag" + }, + "product": { + "id": "/products/starter", + "name": "Starter", + "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", + "terms": "", + "subscriptionRequired": true, + "approvalRequired": false, + "subscriptionsLimit": 1, + "state": "published" + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTags.json new file mode 100644 index 000000000000..e96716aae293 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTags.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020001", + "properties": { + "displayName": "tag1" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020002", + "properties": { + "displayName": "tag2" + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTemplates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTemplates.json new file mode 100644 index 000000000000..01abd7392ccf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTemplates.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/ApplicationApprovedNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "name": "ApplicationApprovedNotificationMessage", + "properties": { + "subject": "Your application $AppName is published in the application gallery", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

\r\n We are happy to let you know that your request to publish the $AppName application in the application gallery has been approved. Your application has been published and can be viewed here.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "title": "Application gallery submission approved", + "description": "Developers who submitted their application for publication in the application gallery on the developer portal receive this email after their submission is approved.", + "isDefault": true, + "parameters": [ + { + "name": "AppId", + "title": "Application id" + }, + { + "name": "AppName", + "title": "Application name" + }, + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ] + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTenantAccess.json new file mode 100644 index 000000000000..6c61a04ad7c7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTenantAccess.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", + "type": "Microsoft.ApiManagement/service/tenant", + "name": "access", + "properties": { + "enabled": true + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTenantSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTenantSettings.json new file mode 100644 index 000000000000..1d8841c0c2e7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListTenantSettings.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/settings/public", + "type": "Microsoft.ApiManagement/service/settings", + "name": "public", + "properties": { + "settings": { + "CustomPortalSettings.UserRegistrationTerms": null, + "CustomPortalSettings.UserRegistrationTermsEnabled": "False", + "CustomPortalSettings.UserRegistrationTermsConsentRequired": "False", + "CustomPortalSettings.DelegationEnabled": "False", + "CustomPortalSettings.DelegationUrl": "", + "CustomPortalSettings.DelegatedSubscriptionEnabled": "False" + } + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUserGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUserGroups.json new file mode 100644 index 000000000000..4a62f4541437 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUserGroups.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "57681833a40f7eb6c49f6acf" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/groups/5600b57e7e8880006a020002", + "type": "Microsoft.ApiManagement/service/users/groups", + "name": "5600b57e7e8880006a020002", + "properties": { + "displayName": "Developers", + "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.", + "builtIn": true, + "type": "system" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUserIdentities.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUserIdentities.json new file mode 100644 index 000000000000..bb902544e0e1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUserIdentities.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "57f2af53bb17172280f44057" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "provider": "Microsoft", + "id": "086cf9********55ab" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUserSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUserSubscriptions.json new file mode 100644 index 000000000000..086bc6759973 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUserSubscriptions.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "57681833a40f7eb6c49f6acf" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6ae3", + "type": "Microsoft.ApiManagement/service/users/subscriptions", + "name": "57681850a40f7eb6c49f6ae3", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7", + "displayName": "57681850a40f7eb6c49f6ae5", + "state": "active", + "createdDate": "2016-06-20T16:22:39.547Z", + "startDate": "2016-06-20T00:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6b2b", + "type": "Microsoft.ApiManagement/service/users/subscriptions", + "name": "57681850a40f7eb6c49f6b2b", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7", + "displayName": "57681850a40f7eb6c49f6b2d", + "state": "active", + "createdDate": "2016-06-20T16:22:41.103Z", + "startDate": "2016-06-20T00:00:00Z" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUsers.json new file mode 100644 index 000000000000..dc1566426401 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListUsers.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "type": "Microsoft.ApiManagement/service/users", + "name": "1", + "properties": { + "firstName": "Administrator", + "lastName": "", + "email": "admin@live.com", + "state": "active", + "registrationDate": "2015-09-22T01:57:39.677Z", + "identities": [ + { + "provider": "Azure", + "id": "admin@live.com" + } + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd", + "type": "Microsoft.ApiManagement/service/users", + "name": "56eaec62baf08b06e46d27fd", + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foo.bar.83@gmail.com", + "state": "active", + "registrationDate": "2016-03-17T17:41:56.327Z", + "identities": [ + { + "provider": "Basic", + "id": "foo.bar.83@gmail.com" + } + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/users", + "name": "5931a75ae4bbd512a88c680b", + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com", + "state": "active", + "registrationDate": "2017-06-02T17:58:50.357Z", + "identities": [ + { + "provider": "Microsoft", + "id": "*************" + } + ] + } + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiDiagnostics.json new file mode 100644 index 000000000000..36138037c5ca --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiDiagnostics.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "echo-api" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + }, + "frontend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + }, + "backend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + } + } + } + ], + "count": 1 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiOperationPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiOperationPolicies.json new file mode 100644 index 000000000000..e5f34f1dc76b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiOperationPolicies.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "599e2953193c3c0bd0b3e2fa", + "operationId": "599e29ab193c3c0bd0b3e2fb" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/599e2953193c3c0bd0b3e2fa/operations/599e29ab193c3c0bd0b3e2fb/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n xxx\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiOperations.json new file mode 100644 index 000000000000..dcaea0da2e61 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiOperations.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "displayName": "CancelOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "name": "57d2ef278aa04f0ad01d6cda", + "properties": { + "displayName": "GetMostRecentOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "name": "57d2ef278aa04f0ad01d6cd9", + "properties": { + "displayName": "GetOpenOrders", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "name": "57d2ef278aa04f0ad01d6cdb", + "properties": { + "displayName": "GetOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOrder" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "name": "57d2ef278aa04f0ad01d6cd8", + "properties": { + "displayName": "submitOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/submitOrder" + } + } + ], + "count": 5, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiPolicies.json new file mode 100644 index 000000000000..040a453d8094 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiPolicies.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "5600b59475ff190048040001" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b59475ff190048040001/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiReleases.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiReleases.json new file mode 100644 index 000000000000..ee81fb6f502f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiReleases.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "a1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "name": "5a7cb545298324c53224a799", + "properties": { + "createdDateTime": "2018-02-08T20:38:29.173Z", + "updatedDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiRevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiRevisions.json new file mode 100644 index 000000000000..f1ab509a23fb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiRevisions.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1;rev=1", + "apiRevision": "1", + "createdDateTime": "2018-02-01T22:21:20.467Z", + "updatedDateTime": "2018-02-01T22:21:20.467Z", + "isOnline": true, + "isCurrent": true + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiSchemas.json new file mode 100644 index 000000000000..11e2b92dc0ca --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiSchemas.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "59d5b28d1f7fab116c282650" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e", + "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", + "name": "59d5b28e1f7fab116402044e", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiVersionSets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiVersionSets.json new file mode 100644 index 000000000000..4bc4b25f32bc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApiVersionSets.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs1", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "name": "vs1", + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs2", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "name": "vs2", + "properties": { + "displayName": "api set 2", + "versioningScheme": "Query", + "description": "Version configuration 2" + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApis.json new file mode 100644 index 000000000000..6202ae74cdd9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceApis.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "name": "a1", + "properties": { + "displayName": "api1", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "api1", + "protocols": [ + "https" + ], + "isCurrent": true, + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5a73933b8f27f7cc82a2d533", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "name": "5a73933b8f27f7cc82a2d533", + "properties": { + "displayName": "api1", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "api1", + "protocols": [ + "https" + ], + "isCurrent": true, + "apiVersion": "v1", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "name": "echo-api", + "properties": { + "displayName": "Echo API", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo", + "protocols": [ + "https" + ], + "isCurrent": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5a7390baa5816a110435aee0", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "name": "5a7390baa5816a110435aee0", + "properties": { + "displayName": "Swagger Petstore Extensive", + "apiRevision": "1", + "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", + "serviceUrl": "http://petstore.swagger.wordnik.com/api", + "path": "vvv", + "protocols": [ + "https" + ], + "isCurrent": true + } + } + ], + "count": 4, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceBackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceBackends.json new file mode 100644 index 000000000000..b4f69078c805 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceBackends.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "name": "proxybackend", + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceCertificates.json new file mode 100644 index 000000000000..669b580e9b51 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceCertificates.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/kjoshiarmtemplateCert1", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "name": "templateCert1", + "properties": { + "subject": "CN=mutual-authcert", + "thumbprint": "EBA************************48594A6", + "expirationDate": "2017-04-23T17:03:41Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "name": "templateCertkv", + "properties": { + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690", + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + } + } + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceDiagnostics.json new file mode 100644 index 000000000000..59986a591cc6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceDiagnostics.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "verbosity": "information", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + }, + "frontend": { + "request": { + "headers": [], + "body": { + "bytes": 0 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 0 + } + } + }, + "backend": { + "request": { + "headers": [], + "body": { + "bytes": 0 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 0 + } + } + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/azuremonitor", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "name": "azuremonitor", + "properties": { + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/azuremonitor", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + } + } + } + ], + "count": 1 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceGroupUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceGroupUsers.json new file mode 100644 index 000000000000..572fbcbe4a00 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceGroupUsers.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "groupId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/kjoshiarmTemplateUser1", + "type": "Microsoft.ApiManagement/service/workspaces/groups/users", + "name": "armTemplateUser1", + "properties": { + "firstName": "user1", + "lastName": "lastname1", + "email": "user1@live.com", + "state": "active", + "registrationDate": "2017-05-31T18:54:41.447Z", + "note": "note for user 1", + "identities": [ + { + "provider": "Basic", + "id": "user1@live.com" + } + ] + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceGroups.json new file mode 100644 index 000000000000..5cef97bb118d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceGroups.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "description": "awesome group of people", + "builtIn": false, + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceLinks.json new file mode 100644 index 000000000000..e049bf196a60 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceLinks.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "service1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-1", + "name": "wk-1", + "type": "Microsoft.ApiManagement/service/workspaceLinks", + "etag": "AAAAAAAWN/4=", + "properties": { + "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-1", + "gateways": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-1" + } + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-2", + "name": "wk-1", + "type": "Microsoft.ApiManagement/service/workspaceLinks", + "etag": "AAAAAAAWKwo=", + "properties": { + "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-2", + "gateways": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceLoggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceLoggers.json new file mode 100644 index 000000000000..167e3a264a65 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceLoggers.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/azuremonitor", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "name": "azuremonitor", + "properties": { + "loggerType": "azureMonitor", + "isBuffered": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/vvktest", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "name": "vvktest", + "properties": { + "loggerType": "applicationInsights", + "credentials": { + "instrumentationKey": "{{Logger-Credentials-5b1a17ef2b3f91153004b10d}}" + }, + "isBuffered": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "name": "applicationinsights", + "properties": { + "loggerType": "applicationInsights", + "description": "miaoappinsight", + "credentials": { + "instrumentationKey": "{{Logger-Credentials-5b2056062b3f911ae84a3069}}" + }, + "isBuffered": true + } + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNamedValues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNamedValues.json new file mode 100644 index 000000000000..ddcb93666e06 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNamedValues.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/592f1174cc83890dc4f32686", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "name": "592f1174cc83890dc4f32686", + "properties": { + "displayName": "Logger-Credentials-592f1174cc83890dc4f32687", + "value": "propValue", + "secret": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "name": "testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret", + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + } + }, + "tags": [ + "foo", + "bar" + ], + "secret": true + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientEmails.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientEmails.json new file mode 100644 index 000000000000..15a93dae0507 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientEmails.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "notificationName": "RequestPublisherNotificationMessage" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "name": "contoso@live.com", + "properties": { + "email": "contoso@live.com" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "name": "foobar!live", + "properties": { + "email": "foobar!live" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "name": "foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientUsers.json new file mode 100644 index 000000000000..0b32b9ad8e6e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientUsers.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "notificationName": "RequestPublisherNotificationMessage" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers", + "name": "576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNotifications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNotifications.json new file mode 100644 index 000000000000..a4d6a07c4c3e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceNotifications.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/workspaces/notifications", + "name": "RequestPublisherNotificationMessage", + "properties": { + "title": "Subscription requests (requiring approval)", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/PurchasePublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/workspaces/notifications", + "name": "PurchasePublisherNotificationMessage", + "properties": { + "title": "New subscriptions", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + ] + } + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspacePolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspacePolicies.json new file mode 100644 index 000000000000..d8c97fed0c9d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspacePolicies.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "name": "policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspacePolicyFragmentReferences.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspacePolicyFragmentReferences.json new file mode 100644 index 000000000000..04a68bb00280 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspacePolicyFragmentReferences.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "id": "policyFragment1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "name": "policy" + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspacePolicyFragments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspacePolicyFragments.json new file mode 100644 index 000000000000..4653e5bd5fa6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspacePolicyFragments.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "name": "policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProductApiLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProductApiLinks.json new file mode 100644 index 000000000000..5ec6ebbcdf8b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProductApiLinks.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "product1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProductGroupLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProductGroupLinks.json new file mode 100644 index 000000000000..65aed3af3b2a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProductGroupLinks.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "product1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1/groupLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces.products/groupLinks", + "name": "link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProductPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProductPolicies.json new file mode 100644 index 000000000000..3d18fcd851c7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProductPolicies.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "armTemplateProduct4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/armTemplateProduct4/policies/policy", + "type": "Microsoft.ApiManagement/service/workspaces/products/policies", + "name": "policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProducts.json new file mode 100644 index 000000000000..654515f06671 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceProducts.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/kjoshiarmtemplateCert1", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "name": "kjoshiarmtemplateCert1", + "properties": { + "displayName": "Dev", + "description": "Development Product", + "subscriptionRequired": false, + "state": "published" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/starter", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "name": "starter", + "properties": { + "displayName": "Starter", + "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", + "terms": "", + "subscriptionRequired": true, + "approvalRequired": false, + "subscriptionsLimit": 1, + "state": "published" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/unlimited", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "name": "unlimited", + "properties": { + "displayName": "Unlimited", + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "subscriptionRequired": true, + "approvalRequired": true, + "subscriptionsLimit": 1, + "state": "published" + } + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceSchemas.json new file mode 100644 index 000000000000..62eaedb49bdc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceSchemas.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "name": "schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema2", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "name": "schema2", + "properties": { + "description": "sample schema description", + "schemaType": "json", + "document": { + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Person", + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + }, + "age": { + "description": "Age in years which must be equal to or greater than zero.", + "type": "integer", + "minimum": 0 + } + } + } + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceSubscriptions.json new file mode 100644 index 000000000000..b3ab1f78ce91 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceSubscriptions.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/5600b59475ff190048070001", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "name": "5600b59475ff190048070001", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060001", + "state": "active", + "createdDate": "2015-09-22T01:57:40.3Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/56eaed3dbaf08b06e46d27fe", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "name": "56eaed3dbaf08b06e46d27fe", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060001", + "displayName": "Starter", + "state": "active", + "createdDate": "2016-03-17T17:45:33.837Z", + "startDate": "2016-03-17T00:00:00Z", + "expirationDate": "2016-04-01T00:00:00Z", + "notificationDate": "2016-03-20T00:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "name": "5931a769d8d14f0ad8ce13b8", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", + "displayName": "Unlimited", + "state": "submitted", + "createdDate": "2017-06-02T17:59:06.223Z" + } + } + ], + "count": 3, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTagApiLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTagApiLinks.json new file mode 100644 index 000000000000..53f7480ae86f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTagApiLinks.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", + "name": "link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTagOperationLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTagOperationLinks.json new file mode 100644 index 000000000000..0de46a80045d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTagOperationLinks.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", + "name": "link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTagProductLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTagProductLinks.json new file mode 100644 index 000000000000..cef11c6dc9a9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTagProductLinks.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", + "name": "link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTags.json new file mode 100644 index 000000000000..a79c4ecdd4c9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaceTags.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "name": "5600b59375ff190048020001", + "properties": { + "displayName": "tag1" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "name": "5600b59375ff190048020002", + "properties": { + "displayName": "tag2" + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaces.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaces.json new file mode 100644 index 000000000000..a281324ac2eb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementListWorkspaces.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "name": "wks1", + "properties": { + "description": "workspace 1", + "displayName": "my workspace" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks2", + "type": "Microsoft.ApiManagement/service/workspaces", + "name": "wks1", + "properties": { + "description": "workspace 2", + "displayName": "my workspace" + } + } + ], + "count": 2, + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementNamedValueListValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementNamedValueListValue.json new file mode 100644 index 000000000000..ec4db0ca6ffc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementNamedValueListValue.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "namedValueId": "testarmTemplateproperties2" + }, + "responses": { + "200": { + "body": { + "value": "propValue" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementOpenidConnectProviderListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementOpenidConnectProviderListSecrets.json new file mode 100644 index 000000000000..8189ae7946b1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementOpenidConnectProviderListSecrets.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "opid": "templateOpenIdConnect2" + }, + "responses": { + "200": { + "body": { + "clientSecret": "oidsecretproviderTemplate2" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPerformConnectivityCheck.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPerformConnectivityCheck.json new file mode 100644 index 000000000000..19f675c6d543 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPerformConnectivityCheck.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connectivityCheckRequestParams": { + "source": { + "region": "northeurope" + }, + "destination": { + "address": "8.8.8.8", + "port": 53 + }, + "preferredIPVersion": "IPv4" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/connectivityCheck/operationresults/bmljb2xhLW5ldHdvcmt3YXRjaGVyNF9Db25uZWN0aXRpdml0eUNoZWNrXzE2MmExNmZl?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "hops": [ + { + "type": "Source", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address": "10.1.1.4", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "nextHopIds": [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues": [] + }, + { + "type": "Internet", + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "address": "8.8.8.8", + "nextHopIds": [], + "issues": [] + } + ], + "connectionStatus": "Connected", + "avgLatencyInMs": 1, + "minLatencyInMs": 1, + "maxLatencyInMs": 4, + "probesSent": 100, + "probesFailed": 0 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPerformConnectivityCheckHttpConnect.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPerformConnectivityCheckHttpConnect.json new file mode 100644 index 000000000000..fc3686e57e91 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPerformConnectivityCheckHttpConnect.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connectivityCheckRequestParams": { + "source": { + "region": "northeurope" + }, + "destination": { + "address": "https://microsoft.com", + "port": 3306 + }, + "protocol": "HTTPS", + "protocolConfiguration": { + "HTTPConfiguration": { + "method": "GET", + "validStatusCodes": [ + 200, + 204 + ], + "headers": [ + { + "name": "Authorization", + "value": "Bearer myPreciousToken" + } + ] + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/connectivityCheck/operationresults/bmljb2xhLW5ldHdvcmt3YXRjaGVyNF9Db25uZWN0aXRpdml0eUNoZWNrXzE2MmExNmZl?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "hops": [ + { + "type": "Source", + "id": "c60e2296-5ebc-48cc-80e8-7e6d2981e7b2", + "address": "20.82.216.48", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "nextHopIds": [ + "26aa44e7-04f1-462f-aa5d-5951957b5650" + ], + "issues": [] + }, + { + "type": "Internet", + "id": "26aa44e7-04f1-462f-aa5d-5951957b5650", + "address": "40.113.200.201", + "nextHopIds": [], + "issues": [] + } + ], + "connectionStatus": "Reachable", + "avgLatencyInMs": 260, + "minLatencyInMs": 250, + "maxLatencyInMs": 281, + "probesSent": 3, + "probesFailed": 0 + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalConfig.json new file mode 100644 index 000000000000..b7f086e402a0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalConfig.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "portalConfigId": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", + "type": "Microsoft.ApiManagement/service/portalconfigs", + "name": "default", + "properties": { + "enableBasicAuth": true, + "signin": { + "require": false + }, + "signup": { + "termsOfService": { + "text": "I agree to the service terms and conditions.", + "requireConsent": false + } + }, + "delegation": { + "delegateRegistration": false, + "delegateSubscription": false, + "delegationUrl": null, + "validationKey": null + }, + "csp": { + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ], + "allowedSources": [ + "*.contoso.com" + ] + }, + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsGetDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsGetDelegation.json new file mode 100644 index 000000000000..aa5d6d3a327c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsGetDelegation.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "delegation", + "properties": { + "url": "http://contoso.com/delegation", + "subscriptions": { + "enabled": true + }, + "userRegistration": { + "enabled": true + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsGetSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsGetSignIn.json new file mode 100644 index 000000000000..0c50b84fb5c6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsGetSignIn.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "signin", + "properties": { + "enabled": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsGetSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsGetSignUp.json new file mode 100644 index 000000000000..7c92a1957d53 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsGetSignUp.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "signup", + "properties": { + "enabled": true, + "termsOfService": { + "text": "Terms of service text.", + "enabled": true, + "consentRequired": true + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsPutDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsPutDelegation.json new file mode 100644 index 000000000000..6bde69c15e6b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsPutDelegation.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "url": "http://contoso.com/delegation", + "validationKey": "", + "subscriptions": { + "enabled": true + }, + "userRegistration": { + "enabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "delegation", + "properties": { + "url": "http://contoso.com/delegation", + "subscriptions": { + "enabled": true + }, + "userRegistration": { + "enabled": true + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsPutSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsPutSignIn.json new file mode 100644 index 000000000000..962a15310438 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsPutSignIn.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "signin", + "properties": { + "enabled": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsPutSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsPutSignUp.json new file mode 100644 index 000000000000..c202a5ab7e6d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsPutSignUp.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "enabled": true, + "termsOfService": { + "enabled": true, + "text": "Terms of service text.", + "consentRequired": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "signup", + "properties": { + "enabled": true, + "termsOfService": { + "text": "Terms of service text.", + "enabled": true, + "consentRequired": true + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsUpdateDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsUpdateDelegation.json new file mode 100644 index 000000000000..76a7d5e798f1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsUpdateDelegation.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "url": "http://contoso.com/delegation", + "validationKey": "", + "subscriptions": { + "enabled": true + }, + "userRegistration": { + "enabled": true + } + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsUpdateSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsUpdateSignIn.json new file mode 100644 index 000000000000..fdcdcccc9e2b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsUpdateSignIn.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "enabled": true + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsUpdateSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsUpdateSignUp.json new file mode 100644 index 000000000000..38575f7c6c33 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPortalSettingsUpdateSignUp.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "enabled": true, + "termsOfService": { + "enabled": true, + "text": "Terms of service text.", + "consentRequired": true + } + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json new file mode 100644 index 000000000000..ddb82fdc99ca --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationProviderId": "aadwithauthcode", + "authorizationId": "authz1", + "parameters": { + "consentCode": "theconsentcode" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshCertificate.json new file mode 100644 index 000000000000..ef67ddb8bdad --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshCertificate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "certificateId": "templateCertkv" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "templateCertkv", + "properties": { + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690", + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshNamedValue.json new file mode 100644 index 000000000000..4509fe6cabe4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshNamedValue.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "namedValueId": "testprop2" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6/refreshSecret?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "name": "testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + } + }, + "tags": [ + "foo", + "bar" + ], + "secret": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshWorkspaceCertificate.json new file mode 100644 index 000000000000..056c8b7def8c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshWorkspaceCertificate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "certificateId": "templateCertkv" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "name": "templateCertkv", + "properties": { + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690", + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshWorkspaceNamedValue.json new file mode 100644 index 000000000000..85aafa7f7131 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRefreshWorkspaceNamedValue.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "namedValueId": "testprop2" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6/refreshSecret?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "name": "testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + } + }, + "tags": [ + "foo", + "bar" + ], + "secret": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRestoreWithAccessKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRestoreWithAccessKey.json new file mode 100644 index 000000000000..2f60d8f00251 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementRestoreWithAccessKey.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "storageAccount": "teststorageaccount", + "containerName": "backupContainer", + "backupName": "apimService1backup_2017_03_19", + "accessType": "AccessKey", + "accessKey": "**************************************************" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "West US", + "etag": "AAAAAAACXok=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2019-12-18T06:26:20.3348609Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false + }, + { + "type": "Proxy", + "hostName": "gateway1.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": true + }, + { + "type": "Management", + "hostName": "mgmt.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + }, + { + "type": "Portal", + "hostName": "portal1.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + }, + { + "type": "ConfigurationApi", + "hostName": "config-api.msitesting.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": false + } + ], + "publicIPAddresses": [ + "13.91.32.113" + ], + "additionalLocations": [ + { + "location": "East US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "23.101.138.153" + ], + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "disableGateway": true + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + } + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceCheckNameAvailability.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceCheckNameAvailability.json new file mode 100644 index 000000000000..62d8c02907a9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceCheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "name": "apimService1" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "Valid", + "message": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceDeleteService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceDeleteService.json new file mode 100644 index 000000000000..e6016d03ca83 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceDeleteService.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2023-09-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West US", + "etag": "AAAAAAFfhHY=", + "properties": { + "publisherEmail": "contoso@live.com", + "publisherName": "Microsoft", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "Deleting", + "createdAtUtc": "2016-12-20T19:41:21.5823069Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "40.XX.XXX.168" + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/BlockVNETSamir/subnets/default" + }, + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Developer", + "capacity": 1 + } + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetDomainOwnershipIdentifier.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetDomainOwnershipIdentifier.json new file mode 100644 index 000000000000..13f0e64b9299 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetDomainOwnershipIdentifier.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "domainOwnershipIdentifier": "KLE1vdMblVeHECAi4nCe3oNaXXXXvNlLrXt2ev84KM=" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetMultiRegionInternalVnet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetMultiRegionInternalVnet.json new file mode 100644 index 000000000000..d47095f220e5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetMultiRegionInternalVnet.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1", + "name": "apimservice1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West US", + "etag": "AAAAAADqC0c=", + "properties": { + "publisherEmail": "abcs@contoso.com", + "publisherName": "contoso publisher", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2019-12-02T01:42:09.1268424Z", + "gatewayUrl": "https://apimservice1.azure-api.net", + "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net", + "portalUrl": "https://apimservice1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimservice1.management.azure-api.net", + "scmUrl": "https://apimservice1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificateSource": "BuiltIn" + }, + { + "type": "Proxy", + "hostName": "apimgatewaytest.preview.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2019-08-16T16:51:34+00:00", + "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476", + "subject": "CN=*.preview.net" + }, + "defaultSslBinding": true, + "certificateSource": "Custom" + } + ], + "publicIPAddresses": [ + "137.XXX.11.74" + ], + "privateIPAddresses": [ + "172.XX.0.5" + ], + "additionalLocations": [ + { + "location": "West US 2", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "40.XXX.79.187" + ], + "privateIPAddresses": [ + "10.0.X.6" + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub" + }, + "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net", + "disableGateway": false + } + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet" + }, + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False" + }, + "virtualNetworkType": "Internal", + "disableGateway": false, + "apiVersionConstraint": {} + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetNetworkStatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetNetworkStatus.json new file mode 100644 index 000000000000..5bb1828e46d2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetNetworkStatus.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": [ + { + "location": "Central US EUAP", + "networkStatus": { + "dnsServers": [ + "168.63.129.16" + ], + "connectivityStatus": [ + { + "name": "apimst8rlxXXXXX7.queue.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:41:44.6399168Z", + "lastStatusChange": "2023-05-25T03:53:44.1786214Z", + "resourceType": "SmtpQueue", + "isOptional": true + }, + { + "name": "apimstm5lkXXXXX4kky0.blob.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:39:33.9426753Z", + "lastStatusChange": "2023-05-25T03:53:44.1786214Z", + "resourceType": "BlobStorage", + "isOptional": false + }, + { + "name": "apimstm5lkXXXXX4kky0.file.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:41:38.9993574Z", + "lastStatusChange": "2023-05-25T03:53:43.8953621Z", + "resourceType": "FileStorage", + "isOptional": true + }, + { + "name": "apimstm5lkXXXXX4kky0.queue.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:41:38.4368875Z", + "lastStatusChange": "2023-05-25T03:53:44.2081238Z", + "resourceType": "Queue", + "isOptional": true + }, + { + "name": "apimstm5lkXXXXX4kky0.table.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:41:17.4762359Z", + "lastStatusChange": "2023-05-25T03:53:43.9734877Z", + "resourceType": "TableStorage", + "isOptional": false + }, + { + "name": "apirpsqlmgsXXXXXXic45.database.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:40:50.2954792Z", + "lastStatusChange": "2023-05-25T03:53:44.0704109Z", + "resourceType": "SQLDatabase", + "isOptional": false + }, + { + "name": "gcs.prod.monitoring.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:40:09.8448385Z", + "lastStatusChange": "2023-05-25T03:53:43.8484895Z", + "resourceType": "Monitoring", + "isOptional": false + }, + { + "name": "https://apikv-XXXXXXurugl3.vault.azure.net", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:40:17.3447288Z", + "lastStatusChange": "2023-06-02T06:54:45.7125288Z", + "resourceType": "AzureKeyVault", + "isOptional": false + }, + { + "name": "https://centraluseuap.login.microsoft.com", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:40:01.6660359Z", + "lastStatusChange": "2023-05-25T03:53:44.1490292Z", + "resourceType": "RegionalAzureActiveDirectory", + "isOptional": true + }, + { + "name": "https://gcs.prod.warm.ingestion.monitoring.azure.com", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:42:08.0050056Z", + "lastStatusChange": "2023-05-26T14:09:26.2508948Z", + "resourceType": "Monitoring", + "isOptional": true + }, + { + "name": "https://global.prod.microsoftmetrics.com/", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:40:12.9698299Z", + "lastStatusChange": "2023-05-25T03:53:44.1297766Z", + "resourceType": "Monitoring", + "isOptional": true + }, + { + "name": "https://login.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:40:43.4048644Z", + "lastStatusChange": "2023-06-04T11:10:16.1041673Z", + "resourceType": "AzureActiveDirectory", + "isOptional": true + }, + { + "name": "https://partner.prod.repmap.microsoft.com", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:40:32.6067213Z", + "lastStatusChange": "2023-05-25T03:53:44.2081238Z", + "resourceType": "CaptchaEndpoint", + "isOptional": true + }, + { + "name": "https://xxxxx.prod.microsoftmetrics.com:1886/RecoveryService", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:42:33.8566303Z", + "lastStatusChange": "2023-05-25T03:53:44.3488261Z", + "resourceType": "Metrics", + "isOptional": true + }, + { + "name": "https://samir-XXXXXXX.management.azure-api.net:3443/servicestatus?api-version=2018-01-01", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:42:10.3954682Z", + "lastStatusChange": "2023-06-08T16:42:10.3954682Z", + "resourceType": "ApiManagement Control Plane - inbound", + "isOptional": false + }, + { + "name": "LocalGatewayRedis", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:39:30.184537Z", + "lastStatusChange": "2023-05-25T03:53:44.2081238Z", + "resourceType": "InternalCache", + "isOptional": true + }, + { + "name": "Scm", + "status": "success", + "error": "", + "lastUpdated": "2023-06-08T16:41:24.6623693Z", + "lastStatusChange": "2023-05-25T03:32:02.6480516Z", + "resourceType": "SourceControl", + "isOptional": true + } + ] + } + } + ] + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetNetworkStatusByLocation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetNetworkStatusByLocation.json new file mode 100644 index 000000000000..204472833c82 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetNetworkStatusByLocation.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "locationName": "North Central US" + }, + "responses": { + "200": { + "body": { + "dnsServers": [ + "10.82.98.10" + ], + "connectivityStatus": [ + { + "name": "apimgmtst6tnxxxxxxxxxxx.blob.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:55:14.7035899Z", + "lastStatusChange": "2020-11-20T07:54:55.9365931Z", + "resourceType": "BlobStorage", + "isOptional": false + }, + { + "name": "apimgmtst6tnxxxxxxxxxxx.file.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:55:41.5322463Z", + "lastStatusChange": "2020-11-20T07:54:55.9265938Z", + "resourceType": "FileStorage", + "isOptional": true + }, + { + "name": "apimgmtst6tnxxxxxxxxxxx.queue.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:55:30.645994Z", + "lastStatusChange": "2020-11-20T07:54:55.8410477Z", + "resourceType": "Queue", + "isOptional": true + }, + { + "name": "apimgmtst6tnxxxxxxxxxxx.table.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:55:23.8789171Z", + "lastStatusChange": "2020-11-20T07:54:55.9365931Z", + "resourceType": "TableStorage", + "isOptional": false + }, + { + "name": "gcs.prod.monitoring.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:57:34.8666833Z", + "lastStatusChange": "2020-11-20T08:07:37.5486932Z", + "resourceType": "Monitoring", + "isOptional": true + }, + { + "name": "https://gcs.ppe.warm.ingestion.monitoring.azure.com", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:56:26.1870188Z", + "lastStatusChange": "2020-11-20T07:54:56.1060523Z", + "resourceType": "Monitoring", + "isOptional": true + }, + { + "name": "https://global.metrics.nsatc.net/", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:56:35.9620612Z", + "lastStatusChange": "2020-11-20T07:54:56.0510519Z", + "resourceType": "Monitoring", + "isOptional": true + }, + { + "name": "https://login.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:56:30.8047708Z", + "lastStatusChange": "2020-11-20T07:54:56.1060523Z", + "resourceType": "AzureActiveDirectory", + "isOptional": true + }, + { + "name": "https://prod2.metrics.nsatc.net:1886/RecoveryService", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:56:45.2095302Z", + "lastStatusChange": "2020-11-20T07:54:56.2796235Z", + "resourceType": "Metrics", + "isOptional": true + }, + { + "name": "LocalGatewayRedis", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:55:15.1345836Z", + "lastStatusChange": "2020-11-20T07:54:55.9365931Z", + "resourceType": "InternalCache", + "isOptional": true + }, + { + "name": "prod.warmpath.msftcloudes.com", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:55:57.8992141Z", + "lastStatusChange": "2020-11-20T07:54:55.8410477Z", + "resourceType": "Monitoring", + "isOptional": false + }, + { + "name": "Scm", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T23:03:57.6187917Z", + "lastStatusChange": "2020-11-20T07:54:57.325384Z", + "resourceType": "SourceControl", + "isOptional": true + }, + { + "name": "smtpi-xxx.msn.com:25028", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:58:22.2430074Z", + "lastStatusChange": "2020-11-20T07:54:56.3510577Z", + "resourceType": "Email", + "isOptional": true + }, + { + "name": "zwcvuxxxx.database.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2020-11-24T22:55:44.3582171Z", + "lastStatusChange": "2020-11-20T07:54:56.0410467Z", + "resourceType": "SQLDatabase", + "isOptional": false + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..62508f18d118 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,463 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Azure SMTP", + "endpoints": [ + { + "domainName": "smtpi-ch1.msn.com", + "endpointDetails": [ + { + "port": 25028, + "region": "West US" + } + ] + } + ] + }, + { + "category": "Azure SQL", + "endpoints": [ + { + "domainName": "xxxx1345234.database.windows.net", + "endpointDetails": [ + { + "port": 1433, + "region": "West US" + } + ] + } + ] + }, + { + "category": "Azure Storage", + "endpoints": [ + { + "domainName": "xxxx32storagedgfbay.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx1362629927xt.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx1362629927xt.table.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx141483183xt.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx141483183xt.table.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx1949864718xt.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx1949864718xt.table.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx3292114122xt.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx3292114122xt.table.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx32tst4oto8t0mlesawmm.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx32tst4oto8t0mlesawmm.file.core.windows.net", + "endpointDetails": [ + { + "port": 445, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx32tst4oto8t0mlesawmm.queue.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx32tst4oto8t0mlesawmm.table.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + } + ] + }, + { + "category": "Azure Event Hub", + "endpoints": [ + { + "domainName": "xxxx1362629927eh.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + }, + { + "port": 5671, + "region": "West US" + }, + { + "port": 5672, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx1949864718eh.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + }, + { + "port": 5671, + "region": "West US" + }, + { + "port": 5672, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx3292114122eh.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + }, + { + "port": 5671, + "region": "West US" + }, + { + "port": 5672, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx141483183eh.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + }, + { + "port": 5671, + "region": "West US" + }, + { + "port": 5672, + "region": "West US" + } + ] + } + ] + }, + { + "category": "SSL Certificate Verification", + "endpoints": [ + { + "domainName": "ocsp.msocsp.com", + "endpointDetails": [ + { + "port": 80, + "region": "Global" + }, + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "mscrl.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "region": "Global" + }, + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "crl.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "region": "Global" + }, + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "crl3.digicert.com", + "endpointDetails": [ + { + "port": 80, + "region": "Global" + }, + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "ocsp.digicert.com", + "endpointDetails": [ + { + "port": 80, + "region": "Global" + }, + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "cacerts.digicert.com", + "endpointDetails": [ + { + "port": 80, + "region": "Global" + }, + { + "port": 443, + "region": "Global" + } + ] + } + ] + }, + { + "category": "Azure Monitor", + "endpoints": [ + { + "domainName": "gcs.ppe.monitoring.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "global.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "xxx3.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 1886, + "region": "Global" + } + ] + }, + { + "domainName": "xxx3-red.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 1886, + "region": "Global" + } + ] + }, + { + "domainName": "xxx3-black.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 1886, + "region": "Global" + } + ] + }, + { + "domainName": "gcs.ppe.warm.ingestion.monitoring.azure.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "metrichost23.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "metrichost23-red.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "metrichost23-black.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + } + ] + }, + { + "category": "Portal Captcha", + "endpoints": [ + { + "domainName": "client.xxx.live.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "partner.xxx.live.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + } + ] + }, + { + "category": "Azure Active Directory", + "endpoints": [ + { + "domainName": "login.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "graph.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetService.json new file mode 100644 index 000000000000..22a69bd6635d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetService.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium", + "name": "OGF-Z3-06162021-Premium", + "type": "Microsoft.ApiManagement/service", + "tags": { + "owner": "v-aswmoh", + "ReleaseName": "Z3" + }, + "location": "East US", + "etag": "AAAAAAAWN/4=", + "properties": { + "publisherEmail": "string", + "publisherName": "Test Premium", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net", + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net", + "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net", + "developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net", + "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net", + "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "ogf-z3-06162021-premium.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificateSource": "BuiltIn" + }, + { + "type": "Proxy", + "hostName": "gateway.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", + "negotiateClientCertificate": true, + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + }, + "defaultSslBinding": true, + "certificateSource": "Custom" + }, + { + "type": "DeveloperPortal", + "hostName": "developer.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + }, + "defaultSslBinding": false, + "certificateSource": "Custom" + }, + { + "type": "Management", + "hostName": "mgmt.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + }, + "defaultSslBinding": false, + "certificateSource": "Custom" + }, + { + "type": "ConfigurationApi", + "hostName": "configuration-api.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + }, + "defaultSslBinding": false, + "certificateSource": "Custom" + } + ], + "publicIPAddresses": [ + "13.92.130.49" + ], + "additionalLocations": [ + { + "location": "East US 2", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "zones": [], + "publicIPAddresses": [ + "40.70.24.106" + ], + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net", + "disableGateway": false, + "platformVersion": "stv2" + } + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" + }, + "virtualNetworkType": "None", + "certificates": [], + "disableGateway": false, + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "name": "privateEndpointProxyName", + "properties": { + "provisioningState": "Pending", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request, thanks", + "actionsRequired": "None" + }, + "groupIds": [ + "Gateway" + ] + } + } + ], + "platformVersion": "stv2" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d", + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2021-06-16T09:40:00.7106733Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetServiceHavingMsi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetServiceHavingMsi.json new file mode 100644 index 000000000000..2256a20ad0f7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetServiceHavingMsi.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West Europe", + "etag": "AAAAAAAENfI=", + "properties": { + "publisherEmail": "foo@contoso.com", + "publisherName": "Contoso", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2016-04-12T00:20:15.6018952Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificateSource": "BuiltIn" + }, + { + "type": "Proxy", + "hostName": "proxy.msitesting.net", + "keyVaultId": "https://samir-msi-keyvault.vault.azure.net/secrets/msicertificate", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2020-12-18T11:11:47+00:00", + "thumbprint": "9833D531D7A45XXXXXA85908BD3692E0BD3F", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": true, + "certificateSource": "KeyVault" + } + ], + "publicIPAddresses": [ + "13.94.xxx.188" + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet" + }, + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "External", + "disableGateway": false + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "ca1d33f7-0000-42ec-0000-d526a1ee953a", + "tenantId": "72f988bf-0000-41af-0000-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": { + "principalId": "95194df2-9208-0000-0000-a10d2af9b5a3", + "clientId": "aaff9c7d-0000-4db2-0000-ab0e3e7806cf" + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetSsoToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetSsoToken.json new file mode 100644 index 000000000000..f22858c15a36 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceGetSsoToken.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "redirectUri": "https://apimService1.portal.azure-api.net:443/signin-sso?token=1%26201705301929%26eIkr3%2fnfaLs1GVJ0OVbzkJjAcwPFkEZAPM8VUXvXPf7cJ6lWsB9oUwsk2zln9x0KLkn21txCPJWWheSPq7SNeA%3d%3d" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceMigrateToStv2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceMigrateToStv2.json new file mode 100644 index 000000000000..c86fb2dffd17 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementServiceMigrateToStv2.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "mode": "PreserveIp" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1", + "name": "apimservice1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West US", + "etag": "AAAAAADqC0c=", + "properties": { + "publisherEmail": "abcs@contoso.com", + "publisherName": "contoso publisher", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2019-12-02T01:42:09.1268424Z", + "gatewayUrl": "https://apimservice1.azure-api.net", + "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net", + "portalUrl": "https://apimservice1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimservice1.management.azure-api.net", + "scmUrl": "https://apimservice1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificateSource": "BuiltIn" + }, + { + "type": "Proxy", + "hostName": "apimgatewaytest.preview.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2019-08-16T16:51:34+00:00", + "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476", + "subject": "CN=*.preview.net" + }, + "defaultSslBinding": true, + "certificateSource": "Custom" + } + ], + "publicIPAddresses": [ + "137.XXX.11.74" + ], + "privateIPAddresses": [ + "172.XX.0.5" + ], + "additionalLocations": [ + { + "location": "West US 2", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "40.XXX.79.187" + ], + "privateIPAddresses": [ + "10.0.X.6" + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub" + }, + "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net", + "disableGateway": false + } + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet" + }, + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False" + }, + "virtualNetworkType": "Internal", + "disableGateway": false, + "apiVersionConstraint": {}, + "platformVersion": "stv2" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementSubscriptionListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementSubscriptionListSecrets.json new file mode 100644 index 000000000000..e2e070ebbef9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementSubscriptionListSecrets.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "sid": "5931a769d8d14f0ad8ce13b8" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementSubscriptionRegeneratePrimaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementSubscriptionRegeneratePrimaryKey.json new file mode 100644 index 000000000000..1144960ea780 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementSubscriptionRegeneratePrimaryKey.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "sid": "testsub" + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementSubscriptionRegenerateSecondaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementSubscriptionRegenerateSecondaryKey.json new file mode 100644 index 000000000000..1144960ea780 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementSubscriptionRegenerateSecondaryKey.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "sid": "testsub" + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantAccessRegenerateKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantAccessRegenerateKey.json new file mode 100644 index 000000000000..a9d788f54832 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantAccessRegenerateKey.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "accessName": "access" + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantAccessSyncState.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantAccessSyncState.json new file mode 100644 index 000000000000..ae3e8c25d5b4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantAccessSyncState.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "configurationName": "configuration" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/syncState", + "type": "Microsoft.ApiManagement/service/tenant/syncState", + "name": "syncState", + "properties": { + "branch": "master", + "commitId": "de891c2342c7058dde45e5e624eae7e558c94683", + "isExport": true, + "isSynced": true, + "isGitEnabled": true, + "syncDate": "2021-04-13T01:15:53.9824995Z", + "configurationChangeDate": "2021-04-13T00:11:43.862781Z", + "lastOperationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/operationResults/6074f0bd093a9d0dac3d7347" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantConfigurationDeploy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantConfigurationDeploy.json new file mode 100644 index 000000000000..5ec3a0d15487 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantConfigurationDeploy.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "configurationName": "configuration", + "parameters": { + "properties": { + "branch": "master" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af4ae2a6d2e0b688d7517?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "6074e652093a9d0dac3d733c", + "type": "Microsoft.ApiManagement/service/tenant/operationResults", + "name": "6074e652093a9d0dac3d733c", + "properties": { + "status": "Failed", + "started": "2017-11-26T17:06:54.303Z", + "updated": "2017-11-26T17:07:21.777Z", + "error": { + "code": "ValidationError", + "message": "File not found: 'api-management/configuration.json'" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantConfigurationSave.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantConfigurationSave.json new file mode 100644 index 000000000000..7aa8b775439c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantConfigurationSave.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "configurationName": "configuration", + "parameters": { + "properties": { + "branch": "master" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "6074e652093a9d0dac3d733c", + "type": "Microsoft.ApiManagement/service/tenant/operationResults", + "name": "6074e652093a9d0dac3d733c", + "properties": { + "status": "Succeeded", + "started": "2021-04-13T00:31:14.94Z", + "updated": "2021-04-13T00:31:27.59Z", + "resultInfo": "The configuration was successfully saved to master as commit c0ae274f6046912107bad734834cbf65918668b6.", + "actionLog": [] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantConfigurationValidate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantConfigurationValidate.json new file mode 100644 index 000000000000..dc4eefa9ca25 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementTenantConfigurationValidate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "configurationName": "configuration", + "parameters": { + "properties": { + "branch": "master" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af64e2a6d2e0b688d751e?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "6074ec02093a9d0dac3d7345", + "type": "Microsoft.ApiManagement/service/tenant/operationResults", + "name": "6074ec02093a9d0dac3d7345", + "properties": { + "status": "Succeeded", + "started": "2021-04-13T00:55:30.62Z", + "updated": "2021-04-13T00:55:39.857Z", + "resultInfo": "Validation is successfull", + "actionLog": [] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUndelete.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUndelete.json new file mode 100644 index 000000000000..da94a46c3ab3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUndelete.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "publisherEmail": "foo@contoso.com", + "publisherName": "foo", + "restore": true + }, + "sku": { + "name": "Developer", + "capacity": 1 + }, + "location": "South Central US" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "location": "South Central US", + "etag": "AAAAAAAp3P0=", + "properties": { + "publisherEmail": "foo@contoso.com", + "publisherName": "foo", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2019-12-18T06:10:56.0327105Z", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true + } + ], + "virtualNetworkType": "None", + "disableGateway": false, + "apiVersionConstraint": {} + }, + "sku": { + "name": "Developer", + "capacity": 1 + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "location": "South Central US", + "etag": "AAAAAAAp3T4=", + "properties": { + "publisherEmail": "foo@contoso.com", + "publisherName": "foo", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2019-12-18T06:10:56.0327105Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-southcentralus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true + } + ], + "publicIPAddresses": [ + "23.102.171.124" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" + }, + "virtualNetworkType": "None", + "disableGateway": false, + "apiVersionConstraint": {} + }, + "sku": { + "name": "Developer", + "capacity": 1 + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApi.json new file mode 100644 index 000000000000..b48d6fb7cf70 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApi.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "echo-api", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "Echo API New", + "serviceUrl": "http://echoapi.cloudapp.net/api2", + "path": "newecho" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api", + "properties": { + "displayName": "Echo API New", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api2", + "path": "newecho", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "isOnline": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiDiagnostic.json new file mode 100644 index 000000000000..c767c9ea6187 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiDiagnostic.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "diagnosticId": "applicationinsights", + "apiId": "echo-api", + "If-Match": "*", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + }, + "frontend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + }, + "backend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiIssue.json new file mode 100644 index 000000000000..b2b0f8a77bf9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiIssue.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "If-Match": "*", + "parameters": { + "properties": { + "state": "closed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiOperation.json new file mode 100644 index 000000000000..3c68c53e5dbc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiOperation.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "echo-api", + "operationId": "operationId", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "Retrieve resource", + "method": "GET", + "urlTemplate": "/resource", + "templateParameters": [], + "request": { + "queryParameters": [ + { + "name": "param1", + "description": "A sample parameter that is required and has a default value of \"sample\".", + "type": "string", + "defaultValue": "sample", + "required": true, + "values": [ + "sample" + ] + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "Returned in all cases.", + "representations": [], + "headers": [] + }, + { + "statusCode": 500, + "description": "Server Error.", + "representations": [], + "headers": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "displayName": "CancelOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "templateParameters": [], + "request": { + "description": "IFazioService_CancelOrder_InputMessage", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrder" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "IFazioService_CancelOrder_OutputMessage", + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrderResponse" + } + ], + "headers": [] + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiRelease.json new file mode 100644 index 000000000000..0dc526ee59f4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiRelease.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "a1", + "releaseId": "testrev", + "If-Match": "*", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "notes": "yahooagain" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", + "type": "Microsoft.ApiManagement/service/apis/releases", + "name": "testrev", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "createdDateTime": "2018-02-08T20:38:29.173Z", + "updatedDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiVersionSet.json new file mode 100644 index 000000000000..972203f2bd16 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiVersionSet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "vs1", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "name": "vs1", + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiWiki.json new file mode 100644 index 000000000000..a2f21a397163 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateApiWiki.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a", + "If-Match": "*", + "parameters": { + "properties": { + "documents": [ + { + "documentationId": "docId1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "name": "default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateAuthorizationServer.json new file mode 100644 index 000000000000..57346ac8e027 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateAuthorizationServer.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authsid": "newauthServer", + "If-Match": "*", + "parameters": { + "properties": { + "clientId": "update", + "clientSecret": "updated", + "useInTestConsole": false, + "useInApiDocumentation": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "name": "newauthServer", + "properties": { + "displayName": "test3", + "useInTestConsole": false, + "useInApiDocumentation": true, + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "clientAuthenticationMethod": [ + "Basic" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "updated", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateBackend.json new file mode 100644 index 000000000000..bd87aa896b06 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateBackend.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "backendId": "proxybackend", + "If-Match": "*", + "parameters": { + "properties": { + "description": "description5308", + "tls": { + "validateCertificateChain": false, + "validateCertificateName": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "proxybackend", + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": true + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateCache.json new file mode 100644 index 000000000000..e12ab0f5b1fe --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateCache.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "cacheId": "c1", + "If-Match": "*", + "parameters": { + "properties": { + "useFromLocation": "westindia" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", + "type": "Microsoft.ApiManagement/service/caches", + "name": "c1", + "properties": { + "useFromLocation": "westindia", + "description": "Redis cache instances in West India", + "connectionString": "{{5f7fbca77a891a2200f3db38}}", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateDiagnostic.json new file mode 100644 index 000000000000..fc09d81ccf82 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateDiagnostic.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "diagnosticId": "applicationinsights", + "If-Match": "*", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateDocumentation.json new file mode 100644 index 000000000000..af884a90f478 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateDocumentation.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "documentationId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "title": "Title updated", + "content": "content updated" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "name": "57d1f7558aa04f15146d9d8a", + "properties": { + "title": "Title updated", + "content": "content updated" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateGateway.json new file mode 100644 index 000000000000..8add5ef56387 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateGateway.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayId": "gw1", + "If-Match": "*", + "parameters": { + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", + "type": "Microsoft.ApiManagement/service/gateways", + "name": "a1", + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateGraphQLApiResolver.json new file mode 100644 index 000000000000..7b7cdca22366 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateGraphQLApiResolver.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "echo-api", + "resolverId": "resolverId", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "Query AdminUsers", + "path": "Query/adminUsers", + "description": "A GraphQL Resolver example" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "displayName": "Query AdminUsers", + "path": "Query/adminUsers", + "description": "A GraphQL Resolver example" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateGroup.json new file mode 100644 index 000000000000..1fe834077443 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "tempgroup", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "temp group" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", + "type": "Microsoft.ApiManagement/service/groups", + "name": "tempgroup", + "properties": { + "displayName": "tempgroup", + "description": "awesome group of people", + "builtIn": false, + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateIdentityProvider.json new file mode 100644 index 000000000000..e12674420c14 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateIdentityProvider.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "identityProviderName": "facebook", + "If-Match": "*", + "parameters": { + "properties": { + "clientId": "updatedfacebookid", + "clientSecret": "updatedfacebooksecret" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "AadB2C", + "properties": { + "clientId": "f02dafe2-b8b8-48ec-a38e-27e5c16c51e5", + "type": "aadB2C", + "authority": "login.microsoftonline.com", + "signinTenant": "contosoaadb2c.onmicrosoft.com", + "allowedTenants": [ + "contosoaadb2c.onmicrosoft.com", + "contoso2aadb2c.onmicrosoft.com" + ], + "signupPolicyName": "B2C_1_policy-signup", + "signinPolicyName": "B2C_1_policy-signin" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateLogger.json new file mode 100644 index 000000000000..bf4243f5dce1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateLogger.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "loggerId": "eh1", + "If-Match": "*", + "parameters": { + "properties": { + "loggerType": "azureEventHub", + "description": "updating description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "eh1", + "properties": { + "loggerType": "azureEventHub", + "description": "updating description", + "credentials": { + "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" + }, + "isBuffered": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateNamedValue.json new file mode 100644 index 000000000000..33c1d7dd8709 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateNamedValue.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "namedValueId": "testprop2", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar2" + ], + "secret": false + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", + "type": "Microsoft.ApiManagement/service/namedValues", + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar2" + ], + "secret": false + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json new file mode 100644 index 000000000000..cea73d429232 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "opid": "templateOpenIdConnect2", + "If-Match": "*", + "parameters": { + "properties": { + "clientSecret": "updatedsecret", + "useInTestConsole": false, + "useInApiDocumentation": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "name": "templateOpenIdConnect2", + "properties": { + "displayName": "templateoidprovider2", + "description": "open id provider template2", + "metadataEndpoint": "https://oidprovider-template2.net", + "clientId": "oidprovidertemplate2", + "useInTestConsole": false, + "useInApiDocumentation": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdatePolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdatePolicyRestriction.json new file mode 100644 index 000000000000..4cd1b6218d7a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdatePolicyRestriction.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyRestrictionId": "policyRestriction1", + "If-Match": "*", + "parameters": { + "properties": { + "scope": "Sample Path 2 to the policy document." + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", + "type": "Microsoft.ApiManagement/service/policyRestrictions", + "name": "policyRestriction1", + "properties": { + "scope": "Sample Path 2 to the policy document.", + "requireBase": "true" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdatePortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdatePortalConfig.json new file mode 100644 index 000000000000..789781ed01cb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdatePortalConfig.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "portalConfigId": "default", + "If-Match": "*", + "parameters": { + "properties": { + "enableBasicAuth": true, + "signin": { + "require": false + }, + "signup": { + "termsOfService": { + "text": "I agree to the service terms and conditions.", + "requireConsent": false + } + }, + "delegation": { + "delegateRegistration": false, + "delegateSubscription": false, + "delegationUrl": null, + "validationKey": null + }, + "csp": { + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ], + "allowedSources": [ + "*.contoso.com" + ] + }, + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", + "type": "Microsoft.ApiManagement/service/portalconfigs", + "name": "default", + "properties": { + "enableBasicAuth": true, + "signin": { + "require": false + }, + "signup": { + "termsOfService": { + "text": "I agree to the service terms and conditions.", + "requireConsent": false + } + }, + "delegation": { + "delegateRegistration": false, + "delegateSubscription": false, + "delegationUrl": null, + "validationKey": null + }, + "csp": { + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ], + "allowedSources": [ + "*.contoso.com" + ] + }, + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdatePortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdatePortalRevision.json new file mode 100644 index 000000000000..1bcfb6565bf5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdatePortalRevision.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "portalRevisionId": "20201112101010", + "If-Match": "*", + "parameters": { + "properties": { + "description": "portal revision update", + "isCurrent": true + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2023-09-01-preview&asyncId=5faf16b81d9a028970d0bfbb&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5faf16b81d9a028970d0bfbb?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "name": "20201112101010", + "properties": { + "description": "portal revision update", + "statusDetails": null, + "status": "completed", + "isCurrent": true, + "createdDateTime": "2020-11-13T22:47:13.397Z", + "updatedDateTime": "2020-11-13T23:29:25.34Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateProduct.json new file mode 100644 index 000000000000..64f8b9abb8dd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateProduct.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "testproduct", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "Test Template ProductName 4" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", + "type": "Microsoft.ApiManagement/service/products", + "name": "testproduct", + "properties": { + "displayName": "Test Template ProductName 4", + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "subscriptionRequired": true, + "approvalRequired": true, + "subscriptionsLimit": 1, + "state": "published" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateProductWiki.json new file mode 100644 index 000000000000..9230a713e6f6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateProductWiki.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "productId": "57d1f7558aa04f15146d9d8a", + "If-Match": "*", + "parameters": { + "properties": { + "documents": [ + { + "documentationId": "docId1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "name": "default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateQuotaCounterKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateQuotaCounterKey.json new file mode 100644 index 000000000000..2902a0edd695 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateQuotaCounterKey.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "quotaCounterKey": "ba", + "parameters": { + "properties": { + "callsCount": 0, + "kbTransferred": 2.5630078125 + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "counterKey": "ba", + "periodKey": "0_P3Y6M4DT12H30M5S", + "periodStartTime": "2014-08-04T04:24:35Z", + "periodEndTime": "2018-02-08T16:54:40Z", + "value": { + "callsCount": 5, + "kbTransferred": 2.5830078125 + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json new file mode 100644 index 000000000000..20817b135a51 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "quotaCounterKey": "ba", + "quotaPeriodKey": "0_P3Y6M4DT12H30M5S", + "parameters": { + "properties": { + "callsCount": 0, + "kbTransferred": 0 + } + } + }, + "responses": { + "200": { + "body": { + "counterKey": "ba", + "periodKey": "0_P3Y6M4DT12H30M5S", + "periodStartTime": "2014-08-04T04:24:35Z", + "periodEndTime": "2018-02-08T16:54:40Z", + "value": { + "callsCount": 0, + "kbTransferred": 2.5625 + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateServiceDisableTls10.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateServiceDisableTls10.json new file mode 100644 index 000000000000..ee0c27581e0b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateServiceDisableTls10.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "Owner": "sasolank", + "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3", + "Reserved": "", + "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT", + "Pool": "Manual", + "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT" + }, + "location": "West US", + "etag": "AAAAAAAYRPs=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-06-29T17:50:42.3191122Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "40.86.176.232" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False" + }, + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateServicePublisherDetails.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateServicePublisherDetails.json new file mode 100644 index 000000000000..2bbc38ed4392 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateServicePublisherDetails.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "publisherEmail": "foobar@live.com", + "publisherName": "Contoso Vnext" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "Owner": "sasolank", + "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3", + "Reserved": "", + "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT", + "Pool": "Manual", + "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT" + }, + "location": "West US", + "etag": "AAAAAAAYRPs=", + "properties": { + "publisherEmail": "foobar@live.com", + "publisherName": "Contoso Vnext", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-06-29T17:50:42.3191122Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "40.86.176.232" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False" + }, + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json new file mode 100644 index 000000000000..97de85731f4c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "additionalLocations": [ + { + "location": "Australia East", + "sku": { + "name": "Premium", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default" + }, + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip" + } + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2" + }, + "virtualNetworkType": "External", + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east" + }, + "sku": { + "name": "Premium", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "location": "Japan East", + "etag": "AAAAAAAWBIU=", + "properties": { + "publisherEmail": "contoso@microsoft.com", + "publisherName": "apimPublisher", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2021-04-08T23:41:35.6447381Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-japaneast-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificateSource": "BuiltIn" + }, + { + "type": "Proxy", + "hostName": "mycustomdomain.int-azure-api.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2022-06-09T23:59:59+00:00", + "thumbprint": "2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD", + "subject": "CN=mycustomdomain.int-azure-api.net" + }, + "defaultSslBinding": true, + "certificateSource": "Managed" + } + ], + "publicIPAddresses": [ + "20.78.248.217" + ], + "additionalLocations": [ + { + "location": "Australia East", + "sku": { + "name": "Premium", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "publicIPAddresses": [ + "20.213.1.35" + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default" + }, + "gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net", + "disableGateway": false, + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip", + "platformVersion": "stv2" + } + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2" + }, + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" + }, + "virtualNetworkType": "Internal", + "disableGateway": false, + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east", + "publicNetworkAccess": "Enabled", + "platformVersion": "stv2" + }, + "sku": { + "name": "Premium", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "systemData": { + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-01-21T20:04:21.6108974Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateStandardGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateStandardGateway.json new file mode 100644 index 000000000000..24bdaf646b48 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateStandardGateway.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "gatewayName": "apimGateway1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": {}, + "sku": { + "name": "Standard", + "capacity": 10 + }, + "tags": { + "Name": "Contoso", + "Test": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", + "name": "apimGateway1", + "type": "Microsoft.ApiManagement/gateways", + "tags": { + "api-version": "2023-09-01-preview" + }, + "location": "East US", + "etag": "AAAAAAAmREI=", + "properties": { + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "frontend": { + "defaultHostname": "apimGateway1.eastus.gateway.azure-api.net" + }, + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "configurationApi": { + "hostname": "apimGateway1.eastus.configuration.gateway.azure-api.net" + } + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "user@contoso.com", + "createdByType": "User", + "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2023-09-01-preview&asyncResponse" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateSubscription.json new file mode 100644 index 000000000000..236f77a75dd9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateSubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "sid": "testsub", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "testsub" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "testsub", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "displayName": "testsub", + "state": "submitted", + "createdDate": "2017-06-02T17:59:06.223Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateTag.json new file mode 100644 index 000000000000..1e89a98890d1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateTag.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "temptag", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "temp tag" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/temptag", + "type": "Microsoft.ApiManagement/service/tags", + "name": "temptag", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateTemplate.json new file mode 100644 index 000000000000..dcc2cc81e9ef --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateTemplate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage", + "If-Match": "*", + "parameters": { + "properties": { + "subject": "Your request $IssueName was received", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

\r\n We are happy to let you know that your request to publish the $AppName application in the gallery has been approved. Your application has been published and can be viewed here.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "name": "NewIssueNotificationMessage", + "properties": { + "subject": "Your request $IssueName was received", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "title": "New issue received", + "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "isDefault": true, + "parameters": [ + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "IssueId", + "title": "Issue id" + }, + { + "name": "IssueName", + "title": "Issue name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateTenantAccess.json new file mode 100644 index 000000000000..91945c7d7c41 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateTenantAccess.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "If-Match": "*", + "accessName": "access", + "parameters": { + "properties": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", + "type": "Microsoft.ApiManagement/service/tenant", + "name": "access", + "properties": { + "enabled": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateUser.json new file mode 100644 index 000000000000..270fce3b58d8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateUser.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512a88c680b", + "If-Match": "*", + "parameters": { + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/users", + "name": "5931a75ae4bbd512a88c680b", + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com", + "state": "active", + "registrationDate": "2017-06-02T17:58:50.357Z", + "identities": [ + { + "provider": "Microsoft", + "id": "*************" + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspace.json new file mode 100644 index 000000000000..6d24aa93c9f0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspace.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "my workspace", + "description": "workspace 1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "name": "wks1", + "properties": { + "description": "workspace 1", + "displayName": "my workspace" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApi.json new file mode 100644 index 000000000000..9b413f66afce --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApi.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "echo-api", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "Echo API New", + "serviceUrl": "http://echoapi.cloudapp.net/api2", + "path": "newecho" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api", + "type": "Microsoft.ApiManagement/service/workspaces/pis", + "name": "echo-api", + "properties": { + "displayName": "Echo API New", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api2", + "path": "newecho", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true, + "isOnline": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiDiagnostic.json new file mode 100644 index 000000000000..b6a84c17c910 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiDiagnostic.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "diagnosticId": "applicationinsights", + "apiId": "echo-api", + "If-Match": "*", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 100 + }, + "frontend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + }, + "backend": { + "request": { + "headers": [], + "body": { + "bytes": 100 + } + }, + "response": { + "headers": [], + "body": { + "bytes": 100 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiOperation.json new file mode 100644 index 000000000000..8cac810e0548 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiOperation.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "echo-api", + "operationId": "operationId", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "Retrieve resource", + "method": "GET", + "urlTemplate": "/resource", + "templateParameters": [], + "request": { + "queryParameters": [ + { + "name": "param1", + "description": "A sample parameter that is required and has a default value of \"sample\".", + "type": "string", + "defaultValue": "sample", + "required": true, + "values": [ + "sample" + ] + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "Returned in all cases.", + "representations": [], + "headers": [] + }, + { + "statusCode": 500, + "description": "Server Error.", + "representations": [], + "headers": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "displayName": "CancelOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "templateParameters": [], + "request": { + "description": "IFazioService_CancelOrder_InputMessage", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrder" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "IFazioService_CancelOrder_OutputMessage", + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrderResponse" + } + ], + "headers": [] + } + ] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiRelease.json new file mode 100644 index 000000000000..0d4985a2f643 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiRelease.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "apiId": "a1", + "releaseId": "testrev", + "If-Match": "*", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "notes": "yahooagain" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/testrev", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "name": "testrev", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "createdDateTime": "2018-02-08T20:38:29.173Z", + "updatedDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiVersionSet.json new file mode 100644 index 000000000000..c6897a05aac1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceApiVersionSet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "versionSetId": "vs1", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs1", + "type": "Microsoft.ApiManagement/service/workspaces.api-version-sets", + "name": "vs1", + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceBackend.json new file mode 100644 index 000000000000..7b6f0a9c1e08 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceBackend.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "backendId": "proxybackend", + "If-Match": "*", + "parameters": { + "properties": { + "description": "description5308", + "tls": { + "validateCertificateChain": false, + "validateCertificateName": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "name": "proxybackend", + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": true + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceDiagnostic.json new file mode 100644 index 000000000000..b50554f74b9b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceDiagnostic.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "diagnosticId": "applicationinsights", + "If-Match": "*", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceGroup.json new file mode 100644 index 000000000000..9c832b22f25f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "groupId": "tempgroup", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "temp group" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "name": "tempgroup", + "properties": { + "displayName": "tempgroup", + "description": "awesome group of people", + "builtIn": false, + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceLogger.json new file mode 100644 index 000000000000..5d6062e5d514 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceLogger.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "loggerId": "eh1", + "If-Match": "*", + "parameters": { + "properties": { + "loggerType": "azureEventHub", + "description": "updating description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "name": "eh1", + "properties": { + "loggerType": "azureEventHub", + "description": "updating description", + "credentials": { + "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" + }, + "isBuffered": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceNamedValue.json new file mode 100644 index 000000000000..b8e56d4bfcec --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceNamedValue.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "namedValueId": "testprop2", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar2" + ], + "secret": false + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2?api-version=2023-09-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2023-09-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2", + "type": "Microsoft.ApiManagement/service/namedValues", + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar2" + ], + "secret": false + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceProduct.json new file mode 100644 index 000000000000..f076f1610516 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceProduct.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "productId": "testproduct", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "Test Template ProductName 4" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "name": "testproduct", + "properties": { + "displayName": "Test Template ProductName 4", + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "subscriptionRequired": true, + "approvalRequired": true, + "subscriptionsLimit": 1, + "state": "published" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceSubscription.json new file mode 100644 index 000000000000..41159e7eb3ed --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceSubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "sid": "testsub", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "testsub" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "name": "testsub", + "properties": { + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", + "displayName": "testsub", + "state": "submitted", + "createdDate": "2017-06-02T17:59:06.223Z" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceTag.json new file mode 100644 index 000000000000..0ac413e26374 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUpdateWorkspaceTag.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "tagId": "temptag", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "temp tag" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/temptag", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "name": "temptag", + "properties": { + "displayName": "tag1" + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUserConfirmationPasswordSend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUserConfirmationPasswordSend.json new file mode 100644 index 000000000000..7ab7e28db28f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUserConfirmationPasswordSend.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "57127d485157a511ace86ae7" + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUserGenerateSsoUrl.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUserGenerateSsoUrl.json new file mode 100644 index 000000000000..5db8ab0a21e2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUserGenerateSsoUrl.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "57127d485157a511ace86ae7" + }, + "responses": { + "200": { + "body": { + "value": "https://apimService1.portal.azure-api.net/signin-sso?token=57127d485157a511ace86ae7%26201706051624%267VY18MlwAom***********2bYr2bDQHg21OzQsNakExQ%3d%3d" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUserToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUserToken.json new file mode 100644 index 000000000000..8f23a8f761eb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementUserToken.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "userId1718", + "parameters": { + "properties": { + "keyType": "primary", + "expiry": "2019-04-21T00:44:24.2845269Z" + } + } + }, + "responses": { + "200": { + "body": { + "value": "userId1718&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg==" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementValidatePolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementValidatePolicies.json new file mode 100644 index 000000000000..267f78251f37 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementValidatePolicies.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ApiManagement/service/apimService1/validatePolicies?api-version=2023-05-01" + } + }, + "200": { + "body": { + "id": "6074e652093a9d0dac3d733c", + "type": "Microsoft.ApiManagement/service/tenant/operationResults", + "name": "6074e652093a9d0dac3d733c", + "properties": { + "status": "Succeeded", + "started": "2023-04-13T00:31:14.94Z", + "updated": "2023-04-13T00:31:27.59Z", + "resultInfo": "All the policies were validated", + "actionLog": [] + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceNamedValueListValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceNamedValueListValue.json new file mode 100644 index 000000000000..b4b1fa260326 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceNamedValueListValue.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "namedValueId": "testarmTemplateproperties2" + }, + "responses": { + "200": { + "body": { + "value": "propValue" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceSubscriptionListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceSubscriptionListSecrets.json new file mode 100644 index 000000000000..b2c5a02af3e9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceSubscriptionListSecrets.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "sid": "5931a769d8d14f0ad8ce13b8" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json new file mode 100644 index 000000000000..9e0efc2f6ec6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "sid": "testsub" + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json new file mode 100644 index 000000000000..9e0efc2f6ec6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/examples/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2023-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1", + "sid": "testsub" + }, + "responses": { + "204": {} + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/operationStatuses.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/operationStatuses.json new file mode 100644 index 000000000000..b85867523018 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/operationStatuses.json @@ -0,0 +1,107 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Resource provider operation status.", + "version": "2023-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/operationStatuses/{operationId}": { + "get": { + "operationId": "OperationStatus_Get", + "description": "Returns the current status of an async operation.", + "x-ms-examples": { + "Get operation status": { + "$ref": "./examples/ApiManagementGetOperationStatus.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/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "Requested operation status", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/operationResults/{operationId}": { + "get": { + "tags": [ + "OperationResults" + ], + "description": "Returns operation results for long running operations executing DELETE or PATCH on the resource.", + "operationId": "OperationsResults_Get", + "x-ms-examples": { + "ApiManagementGetOperationResult": { + "$ref": "./examples/ApiManagementGetOperationResult.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/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the operation result." + }, + "202": { + "description": "The operation is still in progress.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/readme.md b/specification/apimanagement/resource-manager/readme.md index ed3884fc7f8a..1f0fc90826aa 100644 --- a/specification/apimanagement/resource-manager/readme.md +++ b/specification/apimanagement/resource-manager/readme.md @@ -28,15 +28,81 @@ These are the global settings for the ApiManagement API. title: ApiManagementClient description: ApiManagement Client openapi-type: arm -tag: package-preview-2023-05 +tag: package-preview-2023-09 ``` +### Tag: package-preview-2023-09 + +These settings apply only when `--tag=package-preview-2023-09` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-09' +input-file: + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimallpolicies.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apigateway.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimanagement.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimapisByTags.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimapiversionsets.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationproviders.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationservers.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimcaches.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimcertificates.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimconnectivitycheck.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimcontenttypes.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimdeletedservices.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimdeployment.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimdiagnostics.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimdocumentations.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimemailtemplates.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimgateways.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimgatewayConfigConnections.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimgroups.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimidentityprovider.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimissues.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimloggers.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimnamedvalues.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimnetworkstatus.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimnotifications.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimopenidconnectproviders.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimoutbounddependency.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicies.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicydescriptions.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyfragments.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyrestrictions.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimpolicyrestrictionsvalidation.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalconfigs.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalrevisions.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimportalsettings.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimprivatelink.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimproducts.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimproductsByTags.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimquotas.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimregions.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimreports.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimschema.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimsettings.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimskus.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimsubscriptions.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimtagresources.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimtags.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimtenant.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimusers.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacebackends.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacecertificates.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacediagnostics.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspaceloggers.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacelinks.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspaces.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/definitions.json + - Microsoft.ApiManagement/preview/2023-09-01-preview/operationStatuses.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' +``` yaml $(tag) == 'package-preview-2023-05' input-file: - Microsoft.ApiManagement/preview/2023-05-01-preview/apimanagement.json - Microsoft.ApiManagement/preview/2023-05-01-preview/apimallpolicies.json @@ -90,6 +156,7 @@ input-file: - Microsoft.ApiManagement/preview/2023-05-01-preview/apimworkspaces.json - Microsoft.ApiManagement/preview/2023-05-01-preview/definitions.json ``` + ### Tag: package-preview-2023-03 These settings apply only when `--tag=package-preview-2023-03` is specified on the command line. @@ -1073,6 +1140,29 @@ suppressions: - code: PropertiesTypeObjectNoDefinition from: definitions.json reason: Invalid error -``` - + - code: PutRequestResponseSchemeArm + from: apimworkspacecertificates.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}"].put + reason: Certificate is a secret and it should not be available through get request + - code: GetCollectionOnlyHasValueAndNextLink + from: apimworkspacecertificates.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates].get.responses["200"].schema.properties + reason: Our object contain count property as a sibling to nextLink and value and it used for proxy resource collection GETs. + - code: GetCollectionOnlyHasValueAndNextLink + from: apimworkspacebackends.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends"].get.responses["200"].schema.properties + reason: Our object contain count property as a sibling to nextLink and value and it used for proxy resource collection GETs. + - code: GetCollectionOnlyHasValueAndNextLink + from: apimworkspacediagnostics.json + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics"].get.responses["200"].schema.properties + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics"].get.responses.["200"].schema.properties + reason: Our object contain count property as a sibling to nextLink and value and it used for proxy resource collection GETs. + - code: GetCollectionOnlyHasValueAndNextLink + from: apimworkspaceloggers.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers"].get.responses["200"].schema.properties + reason: Our object contain count property as a sibling to nextLink and value and it used for proxy resource collection GETs. + - code: PatchBodyParametersSchema + from: apimworkspacebackends.json + reasons: This are the object fields which when updated require some data to be present. diff --git a/specification/apimanagement/resource-manager/sdk-suppressions.yaml b/specification/apimanagement/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..e189d2c371d5 --- /dev/null +++ b/specification/apimanagement/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,9 @@ +suppressions: + azure-sdk-for-python: + - package: azure-mgmt-apimanagement + breaking-changes: + - Model ErrorResponse no longer has parameter code + - Model ErrorResponse no longer has parameter details + - Model ErrorResponse no longer has parameter message + - Renamed operation ApiOperations.delete to ApiOperations.begin_delete + - Renamed operation UserOperations.delete to UserOperations.begin_delete From 336fc73b8f6cd34b59b62046e1a4c0c8905926bd Mon Sep 17 00:00:00 2001 From: Jose Alvarez Date: Wed, 5 Jun 2024 18:50:53 +0200 Subject: [PATCH 40/49] Fixed typo in documentation (#29341) --- specification/ai/OpenAI.Assistants/tools/models.tsp | 2 +- .../OpenApiV3/2024-05-01-preview/assistants_generated.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/ai/OpenAI.Assistants/tools/models.tsp b/specification/ai/OpenAI.Assistants/tools/models.tsp index 7b0118649f98..72e17b73dae6 100644 --- a/specification/ai/OpenAI.Assistants/tools/models.tsp +++ b/specification/ai/OpenAI.Assistants/tools/models.tsp @@ -287,7 +287,7 @@ union AssistantsNamedToolChoiceType { fileSearch: "file_search", } -/** The function name that will be used, if using the `funtion` tool */ +/** The function name that will be used, if using the `function` tool */ @added(ServiceApiVersions.v2024_05_01_preview) model FunctionName { /** The name of the function to call */ diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml index 050d1237ad90..bb72844194ac 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml @@ -2072,7 +2072,7 @@ components: name: type: string description: The name of the function to call - description: The function name that will be used, if using the `funtion` tool + description: The function name that will be used, if using the `function` tool FunctionToolDefinition: type: object required: From d9f06f3de6cb00796a91b86b622dcf50340952a2 Mon Sep 17 00:00:00 2001 From: Francisco Gamino Date: Wed, 5 Jun 2024 11:13:49 -0700 Subject: [PATCH 41/49] Update 2023-12-01 Microsoft.Web functionAppConfig definition (#29226) * Rename enum to functionsDeploymentStorageType * Update enum name to camel case * Update enum names to camel case --- .../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json index fa9b45a208eb..b5b40169df97 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json @@ -3624,7 +3624,7 @@ "blobContainer" ], "x-ms-enum": { - "name": "storageType", + "name": "FunctionsDeploymentStorageType", "modelAsString": true } }, @@ -3646,7 +3646,7 @@ "StorageAccountConnectionString" ], "x-ms-enum": { - "name": "authenticationType", + "name": "AuthenticationType", "modelAsString": true } }, @@ -3731,7 +3731,7 @@ "custom" ], "x-ms-enum": { - "name": "runtimeName", + "name": "RuntimeName", "modelAsString": true } }, From 491e00d17f24909ecf5e1030b3833bed51224e92 Mon Sep 17 00:00:00 2001 From: Dylan Martinez Date: Wed, 5 Jun 2024 15:03:47 -0700 Subject: [PATCH 42/49] Update `securityPostureReference` in VMScaleSet API (#28891) * update securityPostureRef properties in VMScaleSet spec * add securityPostureReference to UpdateVMProfile definition and fix min version * add prettier changes * remove unsupported 'major.*' from spec * add optional fields in security posture example * add required fields * correct minimum api version * add prettier fixes * remove extensionsSettings property * create new Update model for security posture reference & update * fix validation issue * Create sdk-suppressions.yaml * add azure-sdk-for-go suppression * Update sdk-suppressions.yaml --------- Co-authored-by: Dylan Martinez Co-authored-by: Yuchao Yan Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> --- ...t_Create_WithSecurityPostureReference.json | 18 ++++++-- .../2024-03-01/virtualMachineScaleSet.json | 42 ++++++++++++++++--- .../resource-manager/sdk-suppressions.yaml | 14 +++++++ 3 files changed, 66 insertions(+), 8 deletions(-) create mode 100644 specification/compute/resource-manager/sdk-suppressions.yaml diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityPostureReference.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityPostureReference.json index 516e1f660510..8c7a40646ad6 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityPostureReference.json +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityPostureReference.json @@ -15,7 +15,11 @@ "overprovision": true, "virtualMachineProfile": { "securityPostureReference": { - "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest" + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "storageProfile": { "imageReference": { @@ -81,7 +85,11 @@ "uniqueId": "d12ccb3d-ab15-4794-9836-c4196392e9f2", "virtualMachineProfile": { "securityPostureReference": { - "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest" + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "storageProfile": { "imageReference": { @@ -159,7 +167,11 @@ "uniqueId": "d12ccb3d-ab15-4794-9836-c4196392e9f2", "virtualMachineProfile": { "securityPostureReference": { - "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest" + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "storageProfile": { "imageReference": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json index 579d93d9d08f..40974f0e3632 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json @@ -5181,7 +5181,7 @@ }, "securityPostureReference": { "$ref": "#/definitions/SecurityPostureReference", - "description": "Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01" + "description": "Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01" }, "timeCreated": { "readOnly": true, @@ -5206,6 +5206,10 @@ "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkProfile", "description": "The virtual machine scale set network profile." }, + "securityPostureReference": { + "$ref": "#/definitions/SecurityPostureReferenceUpdate", + "description": "The virtual machine scale set security posture reference." + }, "securityProfile": { "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", "description": "The virtual machine scale set Security profile" @@ -6336,17 +6340,45 @@ "properties": { "id": { "type": "string", - "description": "The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest" + "description": "The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest" }, "excludeExtensions": { "type": "array", "items": { - "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtension" + "type": "string" }, - "description": "List of virtual machine extensions to exclude when applying the Security Posture." + "description": "The list of virtual machine extension names to exclude when applying the security posture." + }, + "isOverridable": { + "type": "boolean", + "description": "Whether the security posture can be overridden by the user." + } + }, + "description": "Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01", + "required": [ + "id" + ] + }, + "SecurityPostureReferenceUpdate": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest" + }, + "excludeExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of virtual machine extension names to exclude when applying the security posture." + }, + "isOverridable": { + "type": "boolean", + "description": "Whether the security posture can be overridden by the user." } }, - "description": "Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01" + "description": "Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01" } } } diff --git a/specification/compute/resource-manager/sdk-suppressions.yaml b/specification/compute/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..4591cd0aac17 --- /dev/null +++ b/specification/compute/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,14 @@ +suppressions: + azure-sdk-for-python: + - package: azure-mgmt-compute + breaking-changes: + - Parameter id of model SecurityPostureReference is now required + azure-sdk-for-go: + - package: sdk/resourcemanager/compute/armcompute + breaking-changes: + - Type of `SecurityPostureReference.ExcludeExtensions` has been changed from `[]*VirtualMachineExtension` to `[]*string` + azure-sdk-for-js: + - package: "@azure/arm-compute" + breaking-changes: + - Parameter id of interface SecurityPostureReference is now required + - Type of parameter excludeExtensions of interface SecurityPostureReference is changed from VirtualMachineExtension[] to string[] \ No newline at end of file From d88c94b22a8efdd47c0cadfe6d8d489107db2b23 Mon Sep 17 00:00:00 2001 From: Priyanshi Jain <87351063+priyjain358@users.noreply.github.com> Date: Thu, 6 Jun 2024 03:34:21 +0530 Subject: [PATCH 43/49] [Microsoft.AzureStackHCI] Add 2024-04-01 for StackHCI (#29110) * Add 2024-04-01 for StackHCI * add missing properties * add log collection job type * changes in sdk suppressions * sdk suppression changes --- .../StackHCI/readme.azureresourceschema.md | 18 + .../StackHCI/readme.csharp.md | 15 + .../StackHCI/readme.go.md | 13 + .../StackHCI/readme.md | 242 +++ .../StackHCI/readme.python.md | 24 + .../StackHCI/readme.typescript.md | 13 + .../stable/2024-04-01/arcSettings.json | 819 +++++++++ .../StackHCI/stable/2024-04-01/clusters.json | 1550 +++++++++++++++++ .../stable/2024-04-01/deploymentSettings.json | 999 +++++++++++ .../stable/2024-04-01/edgeDevices.json | 1237 +++++++++++++ .../examples/ConfigureRemoteSupport.json | 113 ++ .../ConsentAndInstallDefaultExtensions.json | 52 + .../examples/CreateArcIdentity.json | 26 + .../2024-04-01/examples/CreateCluster.json | 60 + .../examples/CreateClusterIdentity.json | 25 + .../examples/CreateHciEdgeDevice.json | 257 +++ .../2024-04-01/examples/DeleteArcSetting.json | 18 + .../2024-04-01/examples/DeleteCluster.json | 17 + .../examples/DeleteDeploymentSettings.json | 17 + .../examples/DeleteEdgeDevices.json | 15 + .../2024-04-01/examples/DeleteExtension.json | 19 + .../examples/DeleteSecuritySettings.json | 17 + .../2024-04-01/examples/DeleteUpdateRuns.json | 19 + .../examples/DeleteUpdateSummaries.json | 17 + .../2024-04-01/examples/DeleteUpdates.json | 18 + .../ExtendSoftwareAssuranceBenefit.json | 82 + .../examples/Extensions_Upgrade.json | 22 + .../2024-04-01/examples/GeneratePassword.json | 19 + .../2024-04-01/examples/GetArcSetting.json | 61 + .../2024-04-01/examples/GetCluster.json | 122 ++ .../examples/GetDeploymentSettings.json | 269 +++ .../2024-04-01/examples/GetEdgeDevices.json | 46 + .../2024-04-01/examples/GetExtension.json | 80 + .../stable/2024-04-01/examples/GetOffer.json | 34 + .../2024-04-01/examples/GetPublisher.json | 18 + .../examples/GetSecuritySettings.json | 38 + .../stable/2024-04-01/examples/GetSku.json | 36 + .../2024-04-01/examples/GetUpdateRuns.json | 43 + .../examples/GetUpdateSummaries.json | 41 + .../2024-04-01/examples/GetUpdates.json | 44 + .../examples/InitializeDisableProcess.json | 19 + .../examples/ListArcSettingsByCluster.json | 64 + .../examples/ListClustersByResourceGroup.json | 131 ++ .../examples/ListClustersBySubscription.json | 130 ++ .../ListDeploymentSettingsByCluster.json | 202 +++ .../2024-04-01/examples/ListEdgeDevices.json | 72 + .../examples/ListExtensionsByArcSetting.json | 95 + .../examples/ListOffersByCluster.json | 36 + .../examples/ListOffersByPublisher.json | 37 + .../examples/ListPublishersByCluster.json | 21 + .../ListSecuritySettingsByCluster.json | 41 + .../2024-04-01/examples/ListSkusByOffer.json | 39 + .../2024-04-01/examples/ListUpdateRuns.json | 46 + .../examples/ListUpdateSummaries.json | 45 + .../2024-04-01/examples/ListUpdates.json | 47 + .../2024-04-01/examples/PatchArcSetting.json | 74 + .../2024-04-01/examples/PatchExtension.json | 99 ++ .../2024-04-01/examples/PostUpdates.json | 17 + .../2024-04-01/examples/PutArcSetting.json | 53 + .../examples/PutDeploymentSettings.json | 729 ++++++++ .../2024-04-01/examples/PutExtension.json | 164 ++ .../examples/PutSecuritySettings.json | 72 + .../2024-04-01/examples/PutUpdateRuns.json | 68 + .../examples/PutUpdateSummaries.json | 52 + .../2024-04-01/examples/PutUpdates.json | 71 + .../examples/TriggerLogCollection.json | 95 + .../2024-04-01/examples/UpdateCluster.json | 125 ++ .../examples/UploadCertificate.json | 23 + .../examples/ValidateEdgeDevices.json | 26 + .../stable/2024-04-01/extensions.json | 707 ++++++++ .../StackHCI/stable/2024-04-01/hciCommon.json | 367 ++++ .../StackHCI/stable/2024-04-01/offers.json | 302 ++++ .../stable/2024-04-01/publishers.json | 188 ++ .../stable/2024-04-01/securitySettings.json | 502 ++++++ .../StackHCI/stable/2024-04-01/skus.json | 275 +++ .../stable/2024-04-01/updateRuns.json | 412 +++++ .../stable/2024-04-01/updateSummaries.json | 408 +++++ .../StackHCI/stable/2024-04-01/updates.json | 577 ++++++ .../2024-04-01/examples/ListOperations.json | 453 +++++ .../stable/2024-04-01/operations.json | 73 + .../resource-manager/sdk-suppressions.yaml | 2 +- specification/azurestackhci/suppressions.yaml | 7 + 82 files changed, 13540 insertions(+), 1 deletion(-) create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.azureresourceschema.md create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.csharp.md create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.go.md create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.md create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.python.md create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.typescript.md create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/arcSettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/clusters.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/deploymentSettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/edgeDevices.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConfigureRemoteSupport.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConsentAndInstallDefaultExtensions.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateArcIdentity.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateClusterIdentity.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateHciEdgeDevice.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteDeploymentSettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteEdgeDevices.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteExtension.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteSecuritySettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ExtendSoftwareAssuranceBenefit.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/Extensions_Upgrade.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GeneratePassword.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetDeploymentSettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetEdgeDevices.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetExtension.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetOffer.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetPublisher.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSecuritySettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSku.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/InitializeDisableProcess.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListArcSettingsByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersBySubscription.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListDeploymentSettingsByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListEdgeDevices.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListExtensionsByArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListOffersByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListOffersByPublisher.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListPublishersByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListSecuritySettingsByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListSkusByOffer.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PatchArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PatchExtension.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PostUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutDeploymentSettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutExtension.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutSecuritySettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/TriggerLogCollection.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/UpdateCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/UploadCertificate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ValidateEdgeDevices.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/extensions.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/hciCommon.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/offers.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/publishers.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/securitySettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/skus.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/updateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/updateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/updates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/stable/2024-04-01/examples/ListOperations.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/stable/2024-04-01/operations.json create mode 100644 specification/azurestackhci/suppressions.yaml diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.azureresourceschema.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.azureresourceschema.md new file mode 100644 index 000000000000..9942b7e6e1c8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.azureresourceschema.md @@ -0,0 +1,18 @@ +## AzureResourceSchema + +These settings apply only when `--azureresourceschema` is specified on the command line. + +### AzureResourceSchema multi-api + +```yaml $(azureresourceschema) && $(multiapi) +batch: + - tag: package-2020-11-01 +``` + +Please also specify `--azureresourceschema-folder=`. + +### Tag: package-2020-11-01 and azureresourceschema + +```yaml $(tag) == '2020-11-01-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas +``` diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.csharp.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.csharp.md new file mode 100644 index 000000000000..7f5c47f16abd --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.csharp.md @@ -0,0 +1,15 @@ +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.AzureStackHCI + output-folder: $(csharp-sdks-folder)/azurestackhci/management/Microsoft.AzureStackHCI/GeneratedProtocol +``` diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.go.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.go.md new file mode 100644 index 000000000000..69fb71092716 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.go.md @@ -0,0 +1,13 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +go: + license-header: MICROSOFT_MIT_NO_VERSION + module-name: sdk/resourcemanager/azurestackhci/armazurestackhci + module: github.com/Azure/azure-sdk-for-go/$(module-name) + output-folder: $(go-sdk-folder)/$(module-name) + azure-arm: true +``` + diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.md new file mode 100644 index 000000000000..25421f6157a2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.md @@ -0,0 +1,242 @@ +# azurestackhci + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for azurestackhci. + +## 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 azurestackhci. + +``` yaml +title: AzureStackHCIClient +description: Azure Stack HCI management service +openapi-type: arm +openapi-subtype: rpaas +tag: package-2024-04 +``` + +## Suppression + +``` yaml +directive: + - suppress: R3020 + from: + - arcSettings.json + - clusters.json + - extensions.json + - operations.json + - offers.json + - publishers.json + - skus.json + - updates.json + - updateRuns.json + - updateSummaries.json + - deploymentSettings.json + - edgeDevices.json + - securitySettings.json + - hciCommon.json + + reason: Microsoft.AzureStackHCI is the correct name for our RP. +suppressions: + - code: PathResourceProviderNamePascalCase + reason: Microsoft.AzureStackHCI was chosen over Microsoft.AzureStackHci or Microsoft.AzureStackHyperConvergedInfrastructure + from: + - arcSettings.json + - clusters.json + - extensions.json + - operations.json + - offers.json + - publishers.json + - skus.json + - updates.json + - updateRuns.json + - updateSummaries.json + - deploymentSettings.json + - edgeDevices.json + - securitySettings.json + + - code: ResourceNameRestriction + reason: ClusterName didn't have a pattern initially, adding the constraint now will cause a breaking change + from: + - deploymentSettings.json + - clusters.json + - securitySettings.json + - arcSettings.json + - extensions.json + - offers.json + - publishers.json + - skus.json + - updateRuns.json + - updates.json + - updateSummaries.json + + - code: ParametersInPointGet + reason: already used in GA api version, fixing it will cause a breaking change + from: + - offers.json + - skus.json + + - code: PatchPropertiesCorrespondToPutProperties + reason: already used in GA api version, fixing it will cause breaking change + from: + - clusters.json + + - code: PatchBodyParametersSchema + reason: already used in GA api version, fixing it will cause breaking change + from: + - clusters.json + + - code: PutResponseCodes + reason: already used in GA api version, fixing it will cause breaking change + from: + - clusters.json + - arcSettings.json + - updateRuns.json + - updates.json + - updateSummaries.json + + - code: ConsistentPatchProperties + reason: already used in GA api version, fixing it will cause breaking change + from: + - arcSettings.json + + - code: PostResponseCodes + reason: already used in GA api version, fixing it will cause breaking change + from: + - arcSettings.json + - updates.json + + - code: DeleteResponseCodes + reason: already used in GA api version, fixing it will cause breaking change + from: + - clusters.json + - extensions.json + - arcSettings.json + - updateRuns.json + - updates.json + - updateSummaries.json + + - code: LroLocationHeader + reason: already used in GA api version, fixing it will cause breaking change + from: + - extensions.json + - clusters.json + - arcSettings.json + - updateRuns.json + - updates.json + - updateSummaries.json + + - code: ProvisioningStateSpecifiedForLROPut + reason: already working without the properties section, adding it will break polymorphism + from: + - edgeDevices.json + + - code: XmsPageableForListCalls + reason: already used in GA api version, fixing it will cause breaking change + from: + - operations.json + - updateSummaries.json + + - code: RequestSchemaForTrackedResourcesMustHaveTags + reason: these are not tracked resources, so tags are not needed + from: + - updates.json + - updateRuns.json + - updateSummaries.json + + - code: TrackedResourcePatchOperation + reason: these are not tracked resources, so no tags and corresponding patch operation is needed + from: + - updates.json + - updateRuns.json + - updateSummaries.json + + - code: AvoidAdditionalProperties + reason: already used in GA api version, fixing it will cause breaking change + from: + - updates.json + + - code: EvenSegmentedPathForPutOperation + reason: already used in GA api version, fixing it will cause breaking change + from: + - updateSummaries.json + + - code: DefinitionsPropertiesNamesCamelCase + reason: We have a dependency on other team which is already using these values, changing it will break backward compatibility + from: + - deploymentSettings.json + where: + - $.definitions.QosPolicyOverrides.properties.priorityValue8021Action_Cluster + - $.definitions.QosPolicyOverrides.properties.priorityValue8021Action_SMB + - $.definitions.QosPolicyOverrides.properties.bandwidthPercentage_SMB + - $.definitions.SetInformationJobProperties.properties.priorityValue8021Action_Cluster + - $.definitions.SetInformationJobProperties.properties.priorityValue8021Action_SMB + - $.definitions.SetInformationJobProperties.properties.bandwidthPercentage_SMB + + - code: TopLevelResourcesListBySubscription + reason: It is reporting issue for proxy extension resource which doesn't have use case to ListBySubscription as this resource will always tied to one parent resource only. Additionally, there is a 1:1 relationship between HybridCompute Machines and AzureStackHCI VirtualMachineInstances. +``` + + +### Tag: package-2024-04 + +These settings apply only when `--tag=package-2024-04` is specified on the command line. + +```yaml $(tag) == 'package-2024-04' +input-file: + - stable/2024-04-01/arcSettings.json + - stable/2024-04-01/clusters.json + - stable/2024-04-01/deploymentSettings.json + - stable/2024-04-01/edgeDevices.json + - stable/2024-04-01/extensions.json + - stable/2024-04-01/hciCommon.json + - stable/2024-04-01/offers.json + - ../operations/stable/2024-04-01/operations.json + - stable/2024-04-01/publishers.json + - stable/2024-04-01/securitySettings.json + - stable/2024-04-01/skus.json + - stable/2024-04-01/updateRuns.json + - stable/2024-04-01/updateSummaries.json + - stable/2024-04-01/updates.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_azurestackhci'] + - repo: azure-resource-manager-schemas + after_scripts: + - node sdkauto_afterscript.js azurestackhci/resource-manager + - repo: azure-powershell +``` + diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.python.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.python.md new file mode 100644 index 000000000000..08dd0c5a7b4c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.python.md @@ -0,0 +1,24 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-azurestackhci +namespace: azure.mgmt.azurestackhci +package-version: 1.0.0b1 +clear-output-folder: true +``` + +```yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/azurestackhci/azure-mgmt-azurestackhci/azure/mgmt/azurestackhci +``` + + +``` yaml $(python) +modelerfour: + lenient-model-deduplication: true +``` diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.typescript.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.typescript.md new file mode 100644 index 000000000000..c1b75dbf1e2d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-azurestackhci" + output-folder: "$(typescript-sdks-folder)/sdk/azurestackhci/arm-azurestackhci" + payload-flattening-threshold: 1 + generate-metadata: true +``` diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/arcSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/arcSettings.json new file mode 100644 index 000000000000..5f38a31256d8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/arcSettings.json @@ -0,0 +1,819 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/arcSettings": { + "get": { + "operationId": "ArcSettings_ListByCluster", + "description": "Get ArcSetting resources of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ArcSetting resources by HCI Cluster": { + "$ref": "./examples/ListArcSettingsByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}": { + "get": { + "operationId": "ArcSettings_Get", + "description": "Get ArcSetting resource details of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ArcSetting": { + "$ref": "./examples/GetArcSetting.json" + } + } + }, + "put": { + "operationId": "ArcSettings_Create", + "description": "Create ArcSetting for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "name": "arcSetting", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArcSetting" + }, + "description": "Parameters supplied to the Create ArcSetting resource for this HCI cluster." + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create ArcSetting": { + "$ref": "./examples/PutArcSetting.json" + } + } + }, + "patch": { + "operationId": "ArcSettings_Update", + "description": "Update ArcSettings for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "name": "arcSetting", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArcSettingsPatch" + }, + "description": "ArcSettings parameters that needs to be updated" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch ArcSetting": { + "$ref": "./examples/PatchArcSetting.json" + } + } + }, + "delete": { + "operationId": "ArcSettings_Delete", + "description": "Delete ArcSetting resource details of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No content" + }, + "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": { + "Delete ArcSetting": { + "$ref": "./examples/DeleteArcSetting.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/generatePassword": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_GeneratePassword", + "description": "Generate password for arc settings.", + "x-ms-examples": { + "Generate Password": { + "$ref": "./examples/GeneratePassword.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PasswordCredential" + } + }, + "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.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/createArcIdentity": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_CreateIdentity", + "description": "Create Aad identity for arc settings.", + "x-ms-examples": { + "Create Arc Identity": { + "$ref": "./examples/CreateArcIdentity.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcIdentityResponse" + } + }, + "202": { + "description": "Accepted" + }, + "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.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/consentAndInstallDefaultExtensions": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_ConsentAndInstallDefaultExtensions", + "description": "Add consent time for default extensions and initiate extensions installation", + "x-ms-examples": { + "Consent And Install Default Extensions": { + "$ref": "./examples/ConsentAndInstallDefaultExtensions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "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.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/initializeDisableProcess": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_InitializeDisableProcess", + "description": "Initializes ARC Disable process on the cluster", + "x-ms-examples": { + "Trigger ARC Disable": { + "$ref": "./examples/InitializeDisableProcess.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "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" + } + } + } + }, + "definitions": { + "ArcSettingList": { + "description": "List of ArcSetting proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of ArcSetting proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ArcSetting" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ArcSettingsPatch": { + "description": "ArcSetting details to update.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "ArcSettings properties.", + "$ref": "#/definitions/ArcSettingsPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ArcSettingsPatchProperties": { + "description": "ArcSettings properties.", + "type": "object", + "properties": { + "connectivityProperties": { + "description": "contains connectivity related configuration for ARC resources", + "type": "object", + "items": { + "$ref": "#/definitions/ArcConnectivityProperties" + } + } + } + }, + "ArcSetting": { + "description": "ArcSetting details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "ArcSetting properties.", + "$ref": "#/definitions/ArcSettingProperties", + "x-ms-client-flatten": true + } + } + }, + "ArcSettingProperties": { + "description": "ArcSetting properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the ArcSetting proxy resource.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Failed", + "Canceled", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "DisableInProgress" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "arcInstanceResourceGroup": { + "description": "The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.", + "type": "string" + }, + "arcApplicationClientId": { + "description": "App id of arc AAD identity.", + "type": "string" + }, + "arcApplicationTenantId": { + "description": "Tenant id of arc AAD identity.", + "type": "string" + }, + "arcServicePrincipalObjectId": { + "description": "Object id of arc AAD service principal.", + "type": "string" + }, + "arcApplicationObjectId": { + "description": "Object id of arc AAD identity.", + "type": "string" + }, + "aggregateState": { + "description": "Aggregate state of Arc agent across the nodes in this HCI cluster.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "DisableInProgress" + ], + "x-ms-enum": { + "name": "ArcSettingAggregateState", + "modelAsString": true + }, + "readOnly": true + }, + "perNodeDetails": { + "description": "State of Arc agent in each of the nodes.", + "type": "array", + "items": { + "$ref": "#/definitions/PerNodeState" + }, + "readOnly": true + }, + "connectivityProperties": { + "description": "contains connectivity related configuration for ARC resources", + "type": "object", + "items": { + "$ref": "#/definitions/ArcConnectivityProperties" + } + }, + "defaultExtensions": { + "description": "Properties for each of the default extensions category", + "type": "array", + "items": { + "$ref": "#/definitions/DefaultExtensionDetails" + }, + "x-ms-identifiers": [ + "category" + ], + "readOnly": true + } + } + }, + "PerNodeState": { + "description": "Status of Arc agent for a particular node in HCI Cluster.", + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the Node in HCI Cluster" + }, + "arcInstance": { + "description": "Fully qualified resource ID for the Arc agent of this node.", + "type": "string", + "readOnly": true + }, + "arcNodeServicePrincipalObjectId": { + "description": "The service principal id of the arc for server node", + "type": "string", + "readOnly": true + }, + "state": { + "description": "State of Arc agent in this node.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "DisableInProgress" + ], + "x-ms-enum": { + "name": "NodeArcState", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "DefaultExtensionDetails": { + "description": "Properties for a particular default extension category.", + "type": "object", + "properties": { + "category": { + "description": "Default extension category", + "type": "string", + "readOnly": true + }, + "consentTime": { + "description": "Consent time for extension category", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "ArcConnectivityProperties": { + "description": "Connectivity related configuration required by arc server.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "True indicates ARC connectivity is enabled" + }, + "serviceConfigurations": { + "type": "array", + "description": "Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'.", + "items": { + "$ref": "#/definitions/ServiceConfiguration" + }, + "x-ms-identifiers": [ + "serviceName" + ] + } + }, + "additionalProperties": false + }, + "ServiceConfiguration": { + "type": "object", + "description": "Service configuration details", + "required": [ + "serviceName", + "port" + ], + "properties": { + "serviceName": { + "type": "string", + "description": "Name of the service.", + "enum": [ + "WAC" + ], + "x-ms-enum": { + "name": "serviceName", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The port on which service is enabled." + } + } + }, + "PasswordCredential": { + "type": "object", + "properties": { + "secretText": { + "type": "string" + }, + "keyId": { + "type": "string" + }, + "startDateTime": { + "type": "string", + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false, + "readOnly": true + }, + "ArcIdentityResponse": { + "description": "ArcIdentity details.", + "type": "object", + "properties": { + "properties": { + "description": "ArcIdentity properties.", + "$ref": "#/definitions/ArcIdentityResponseProperties", + "x-ms-client-flatten": true + } + } + }, + "ArcIdentityResponseProperties": { + "type": "object", + "properties": { + "arcApplicationClientId": { + "type": "string" + }, + "arcApplicationTenantId": { + "type": "string" + }, + "arcServicePrincipalObjectId": { + "type": "string" + }, + "arcApplicationObjectId": { + "type": "string" + } + }, + "additionalProperties": false, + "readOnly": true + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ArcSettingNameParameter": { + "name": "arcSettingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proxy resource holding details of HCI ArcSetting information.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/clusters.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/clusters.json new file mode 100644 index 000000000000..325400afbfa3 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/clusters.json @@ -0,0 +1,1550 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListBySubscription", + "x-ms-examples": { + "List clusters in a given subscription": { + "$ref": "./examples/ListClustersBySubscription.json" + } + }, + "description": "List all HCI clusters in a 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/ClusterList" + } + }, + "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.AzureStackHCI/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "x-ms-examples": { + "List clusters in a given resource group": { + "$ref": "./examples/ListClustersByResourceGroup.json" + } + }, + "description": "List all HCI clusters in 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" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "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.AzureStackHCI/clusters/{clusterName}": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Get", + "x-ms-examples": { + "Get cluster": { + "$ref": "./examples/GetCluster.json" + } + }, + "description": "Get HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Create", + "x-ms-examples": { + "Create cluster": { + "$ref": "./examples/CreateCluster.json" + } + }, + "description": "Create an HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "cluster", + "in": "body", + "description": "Details of the HCI cluster.", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Update", + "x-ms-examples": { + "Update cluster": { + "$ref": "./examples/UpdateCluster.json" + } + }, + "description": "Update an HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "cluster", + "in": "body", + "description": "Details of the HCI cluster.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Delete", + "x-ms-examples": { + "Delete cluster": { + "$ref": "./examples/DeleteCluster.json" + } + }, + "description": "Delete an HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No content" + }, + "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 + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/uploadCertificate": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_UploadCertificate", + "x-ms-examples": { + "Upload certificate": { + "$ref": "./examples/UploadCertificate.json" + } + }, + "description": "Upload certificate.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "uploadCertificateRequest", + "in": "body", + "description": "Upload certificate request.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadCertificateRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "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" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/createClusterIdentity": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_CreateIdentity", + "description": "Create cluster identity.", + "x-ms-examples": { + "Create cluster Identity": { + "$ref": "./examples/CreateClusterIdentity.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterIdentityResponse" + } + }, + "202": { + "description": "Accepted" + }, + "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" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/extendSoftwareAssuranceBenefit": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_ExtendSoftwareAssuranceBenefit", + "description": "Extends Software Assurance Benefit to a cluster", + "x-ms-examples": { + "Create cluster Identity": { + "$ref": "./examples/ExtendSoftwareAssuranceBenefit.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "softwareAssuranceChangeRequest", + "in": "body", + "description": "Software Assurance Change Request Payload", + "required": true, + "schema": { + "$ref": "#/definitions/SoftwareAssuranceChangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Accepted" + }, + "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.AzureStackHCI/clusters/{clusterName}/triggerLogCollection": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_TriggerLogCollection", + "description": "Trigger Log Collection on a cluster", + "x-ms-examples": { + "Trigger Log Collection": { + "$ref": "./examples/TriggerLogCollection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "logCollectionRequest", + "in": "body", + "description": "Trigger Log Collection Request Payload", + "required": true, + "schema": { + "$ref": "#/definitions/LogCollectionRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "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.AzureStackHCI/clusters/{clusterName}/configureRemoteSupport": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_ConfigureRemoteSupport", + "description": "Configure RemoteSupport on a cluster", + "x-ms-examples": { + "Configure Remote Support": { + "$ref": "./examples/ConfigureRemoteSupport.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "remoteSupportRequest", + "in": "body", + "description": "Configure Remote Support Request Payload", + "required": true, + "schema": { + "$ref": "#/definitions/RemoteSupportRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "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": { + "ClusterList": { + "description": "List of clusters.", + "type": "object", + "properties": { + "value": { + "description": "List of clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Cluster": { + "description": "Cluster details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Identity of Cluster resource", + "$ref": "../../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Cluster properties.", + "$ref": "#/definitions/ClusterProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterPatch": { + "description": "Cluster details to update.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "description": "Identity of Cluster resource", + "$ref": "../../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Cluster properties.", + "$ref": "#/definitions/ClusterPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterProperties": { + "description": "Cluster properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning", + "NotSpecified", + "Creating", + "Updating", + "Deleting", + "Moving", + "Deleted", + "PartiallySucceeded", + "InProgress", + "DisableInProgress", + "Connected", + "PartiallyConnected", + "Disconnected" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "status": { + "description": "Status of the cluster agent.", + "type": "string", + "enum": [ + "NotYetRegistered", + "ConnectedRecently", + "NotConnectedRecently", + "Disconnected", + "Error", + "NotSpecified", + "ValidationInProgress", + "ValidationSuccess", + "ValidationFailed", + "DeploymentInProgress", + "DeploymentFailed", + "DeploymentSuccess" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + }, + "readOnly": true + }, + "connectivityStatus": { + "description": "Overall connectivity status for the cluster resource.", + "type": "string", + "enum": [ + "NotYetRegistered", + "Connected", + "NotConnectedRecently", + "PartiallyConnected", + "Disconnected", + "NotSpecified" + ], + "x-ms-enum": { + "name": "ConnectivityStatus", + "modelAsString": true + }, + "readOnly": true + }, + "cloudId": { + "description": "Unique, immutable resource id.", + "type": "string", + "readOnly": true + }, + "cloudManagementEndpoint": { + "description": "Endpoint configured for management from the Azure portal.", + "type": "string" + }, + "aadClientId": { + "description": "App id of cluster AAD identity.", + "type": "string" + }, + "aadTenantId": { + "description": "Tenant id of cluster AAD identity.", + "type": "string" + }, + "aadApplicationObjectId": { + "description": "Object id of cluster AAD identity.", + "type": "string" + }, + "aadServicePrincipalObjectId": { + "description": "Id of cluster identity service principal.", + "type": "string" + }, + "softwareAssuranceProperties": { + "description": "Software Assurance properties of the cluster.", + "$ref": "#/definitions/SoftwareAssuranceProperties" + }, + "logCollectionProperties": { + "description": "Log Collection properties of the cluster.", + "$ref": "#/definitions/LogCollectionProperties" + }, + "remoteSupportProperties": { + "description": "RemoteSupport properties of the cluster.", + "$ref": "#/definitions/RemoteSupportProperties" + }, + "desiredProperties": { + "description": "Desired properties of the cluster.", + "$ref": "#/definitions/ClusterDesiredProperties" + }, + "reportedProperties": { + "description": "Properties reported by cluster agent.", + "$ref": "#/definitions/ClusterReportedProperties", + "readOnly": true + }, + "isolatedVmAttestationConfiguration": { + "description": "Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.", + "$ref": "#/definitions/IsolatedVmAttestationConfiguration", + "readOnly": true + }, + "trialDaysRemaining": { + "description": "Number of days remaining in the trial period.", + "type": "number", + "readOnly": true + }, + "billingModel": { + "description": "Type of billing applied to the resource.", + "type": "string", + "readOnly": true + }, + "registrationTimestamp": { + "description": "First cluster sync timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastSyncTimestamp": { + "description": "Most recent cluster sync timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastBillingTimestamp": { + "description": "Most recent billing meter timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "serviceEndpoint": { + "description": "Region specific DataPath Endpoint of the cluster.", + "type": "string", + "readOnly": true + }, + "resourceProviderObjectId": { + "description": "Object id of RP Service Principal", + "type": "string", + "readOnly": true + } + } + }, + "ClusterPatchProperties": { + "description": "Cluster properties.", + "type": "object", + "properties": { + "cloudManagementEndpoint": { + "description": "Endpoint configured for management from the Azure portal", + "type": "string" + }, + "aadClientId": { + "description": "App id of cluster AAD identity.", + "type": "string" + }, + "aadTenantId": { + "description": "Tenant id of cluster AAD identity.", + "type": "string" + }, + "desiredProperties": { + "description": "Desired properties of the cluster.", + "$ref": "#/definitions/ClusterDesiredProperties" + } + } + }, + "LogCollectionProperties": { + "description": "Log Collection properties of the cluster.", + "type": "object", + "properties": { + "fromDate": { + "description": "From DateTimeStamp from when logs need to be connected", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "toDate": { + "description": "To DateTimeStamp till when logs need to be connected", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastLogGenerated": { + "description": "Recent DateTimeStamp where logs are successfully generated", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "logCollectionSessionDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/LogCollectionSession" + }, + "readOnly": true + } + } + }, + "LogCollectionSession": { + "description": "Log Collection Session details of the cluster.", + "type": "object", + "properties": { + "logStartTime": { + "description": "Start Time of the logs when it was collected", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "logEndTime": { + "description": "End Time of the logs when it was collected", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "timeCollected": { + "description": "Duration of logs collected", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "logSize": { + "description": "Size of the logs collected", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "logCollectionStatus": { + "description": "LogCollection status", + "type": "string", + "enum": [ + "None", + "InProgress", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "LogCollectionStatus", + "modelAsString": true + }, + "readOnly": true + }, + "logCollectionJobType": { + "description": "LogCollection job type", + "type": "string", + "enum": [ + "OnDemand", + "Scheduled" + ], + "x-ms-enum": { + "name": "LogCollectionJobType", + "modelAsString": true + }, + "readOnly": true + }, + "correlationId": { + "description": "CorrelationId of the log collection", + "type": "string", + "readOnly": true + }, + "endTimeCollected": { + "description": "End Time of the logs when it was collected", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "logCollectionError": { + "$ref": "#/definitions/LogCollectionError", + "readOnly": true + } + } + }, + "AccessLevel": { + "description": "Remote Support Access Level", + "type": "string", + "enum": [ + "Diagnostics", + "DiagnosticsAndRepair" + ], + "x-ms-enum": { + "name": "AccessLevel", + "modelAsString": true + } + }, + "LogCollectionError": { + "description": "Log Collection Error details of the cluster.", + "type": "object", + "properties": { + "errorCode": { + "description": "Error Code of the log collection", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "Error Message of the log collection", + "type": "string", + "readOnly": true + } + } + }, + "RemoteSupportProperties": { + "description": "Remote Support properties of the cluster.", + "type": "object", + "properties": { + "accessLevel": { + "$ref": "#/definitions/AccessLevel", + "readOnly": true + }, + "expirationTimeStamp": { + "description": "Expiration DateTimeStamp when Remote Support Access will be expired", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "remoteSupportType": { + "description": "Remote Support Type for cluster", + "type": "string", + "enum": [ + "Enable", + "Revoke" + ], + "x-ms-enum": { + "name": "RemoteSupportType", + "modelAsString": true + }, + "readOnly": true + }, + "remoteSupportNodeSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/RemoteSupportNodeSettings" + }, + "readOnly": true + }, + "remoteSupportSessionDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/PerNodeRemoteSupportSession" + }, + "readOnly": true + } + } + }, + "RemoteSupportNodeSettings": { + "description": "Remote Support Node Settings of the cluster.", + "type": "object", + "properties": { + "arcResourceId": { + "description": "Arc ResourceId of the Node", + "type": "string", + "readOnly": true + }, + "state": { + "description": "Remote Support Access Connection State on the Node", + "type": "string", + "readOnly": true + }, + "createdAt": { + "description": "Remote Support Enablement Request Created TimeStamp on the Node", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "description": "Remote Support Enablement Request Updated TimeStamp on the Node", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "connectionStatus": { + "description": "Remote Support Access Connection Status on the Node", + "type": "string", + "readOnly": true + }, + "connectionErrorMessage": { + "description": "Remote Support Access Connection Error Message on the Node", + "type": "string", + "readOnly": true + }, + "transcriptLocation": { + "description": "Remote Support Transcript location on the node", + "type": "string", + "readOnly": true + } + } + }, + "PerNodeRemoteSupportSession": { + "description": "Remote Support Node Session Details on the Node.", + "type": "object", + "properties": { + "sessionStartTime": { + "description": "Remote Support Session StartTime on the Node", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "sessionEndTime": { + "description": "Remote Support Session EndTime on the Node", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "nodeName": { + "description": "Name of the node", + "type": "string", + "readOnly": true + }, + "duration": { + "description": "Duration of Remote Support Enablement", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "accessLevel": { + "$ref": "#/definitions/AccessLevel", + "readOnly": true + } + } + }, + "SoftwareAssuranceProperties": { + "description": "Software Assurance properties of the cluster.", + "type": "object", + "properties": { + "softwareAssuranceStatus": { + "description": "Status of the Software Assurance for the cluster.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SoftwareAssuranceStatus", + "modelAsString": true + }, + "readOnly": true + }, + "softwareAssuranceIntent": { + "description": "Customer Intent for Software Assurance Benefit.", + "type": "string", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SoftwareAssuranceIntent", + "modelAsString": true + } + }, + "lastUpdated": { + "description": "TimeStamp denoting the latest SA benefit applicability is validated.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "IsolatedVmAttestationConfiguration": { + "description": "Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.", + "type": "object", + "properties": { + "attestationResourceId": { + "description": "Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Attestation/attestationProviders", + "scopes": [ + "Tenant" + ] + } + ] + }, + "readOnly": true + }, + "relyingPartyServiceEndpoint": { + "description": "Region specific endpoint for relying party service.", + "type": "string", + "readOnly": true + }, + "attestationServiceEndpoint": { + "description": "Region specific endpoint for Microsoft Azure Attestation service for the cluster", + "type": "string", + "readOnly": true + } + } + }, + "ClusterDesiredProperties": { + "description": "Desired properties of the cluster.", + "type": "object", + "properties": { + "windowsServerSubscription": { + "description": "Desired state of Windows Server Subscription.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WindowsServerSubscription", + "modelAsString": true + } + }, + "diagnosticLevel": { + "description": "Desired level of diagnostic data emitted by the cluster.", + "type": "string", + "enum": [ + "Off", + "Basic", + "Enhanced" + ], + "x-ms-enum": { + "name": "DiagnosticLevel", + "modelAsString": true + } + } + } + }, + "ClusterReportedProperties": { + "description": "Properties reported by cluster agent.", + "type": "object", + "properties": { + "clusterName": { + "description": "Name of the on-prem cluster connected to this resource.", + "type": "string", + "readOnly": true + }, + "clusterId": { + "description": "Unique id generated by the on-prem cluster.", + "type": "string", + "readOnly": true + }, + "clusterVersion": { + "description": "Version of the cluster software.", + "type": "string", + "readOnly": true + }, + "nodes": { + "description": "List of nodes reported by the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterNode" + }, + "readOnly": true + }, + "lastUpdated": { + "description": "Last time the cluster reported the data.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "imdsAttestation": { + "description": "IMDS attestation status of the cluster.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ImdsAttestation", + "modelAsString": true + }, + "readOnly": true + }, + "diagnosticLevel": { + "description": "Level of diagnostic data emitted by the cluster.", + "type": "string", + "enum": [ + "Off", + "Basic", + "Enhanced" + ], + "x-ms-enum": { + "name": "DiagnosticLevel", + "modelAsString": true + } + }, + "supportedCapabilities": { + "description": "Capabilities supported by the cluster.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "clusterType": { + "description": "The node type of all the nodes of the cluster.", + "type": "string", + "enum": [ + "FirstParty", + "ThirdParty" + ], + "x-ms-enum": { + "name": "ClusterNodeType", + "modelAsString": true + }, + "readOnly": true + }, + "manufacturer": { + "description": "The manufacturer of all the nodes of the cluster.", + "type": "string", + "readOnly": true + }, + "oemActivation": { + "description": "OEM activation status of the cluster.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "OemActivation", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "ClusterNode": { + "description": "Cluster node details.", + "type": "object", + "properties": { + "name": { + "description": "Name of the cluster node.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the node in the cluster.", + "type": "number", + "readOnly": true + }, + "windowsServerSubscription": { + "description": "State of Windows Server Subscription.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WindowsServerSubscription", + "modelAsString": true + }, + "readOnly": true + }, + "nodeType": { + "description": "Type of the cluster node hardware.", + "type": "string", + "enum": [ + "FirstParty", + "ThirdParty" + ], + "x-ms-enum": { + "name": "ClusterNodeType", + "modelAsString": true + }, + "readOnly": true + }, + "ehcResourceId": { + "description": "Edge Hardware Center Resource Id", + "type": "string", + "readOnly": true + }, + "manufacturer": { + "description": "Manufacturer of the cluster node hardware.", + "type": "string", + "readOnly": true + }, + "model": { + "description": "Model name of the cluster node hardware.", + "type": "string", + "readOnly": true + }, + "osName": { + "description": "Operating system running on the cluster node.", + "type": "string", + "readOnly": true + }, + "osVersion": { + "description": "Version of the operating system running on the cluster node.", + "type": "string", + "readOnly": true + }, + "osDisplayVersion": { + "description": "Display version of the operating system running on the cluster node.", + "type": "string", + "readOnly": true + }, + "serialNumber": { + "description": "Immutable id of the cluster node.", + "type": "string", + "readOnly": true + }, + "coreCount": { + "description": "Number of physical cores on the cluster node.", + "type": "number", + "readOnly": true + }, + "memoryInGiB": { + "description": "Total available memory on the cluster node (in GiB).", + "type": "number", + "readOnly": true + }, + "lastLicensingTimestamp": { + "description": "Most recent licensing timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "oemActivation": { + "description": "OEM activation status of the node.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "OemActivation", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "RawCertificateData": { + "type": "object", + "properties": { + "certificates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "UploadCertificateRequest": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RawCertificateData" + } + }, + "additionalProperties": false + }, + "LogCollectionRequestProperties": { + "description": "Properties for Log Collection Request", + "type": "object", + "properties": { + "fromDate": { + "description": "From DateTimeStamp from when logs need to be connected", + "type": "string", + "format": "date-time" + }, + "toDate": { + "description": "To DateTimeStamp till when logs need to be connected", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "fromDate", + "toDate" + ], + "additionalProperties": false + }, + "RemoteSupportRequestProperties": { + "description": "Properties for Remote Support Request", + "type": "object", + "properties": { + "accessLevel": { + "$ref": "#/definitions/AccessLevel", + "readOnly": true + }, + "expirationTimeStamp": { + "description": "Expiration DateTimeStamp when Remote Support Access will be expired", + "type": "string", + "format": "date-time" + }, + "remoteSupportType": { + "description": "Remote Support Type for cluster", + "type": "string", + "enum": [ + "Enable", + "Revoke" + ], + "x-ms-enum": { + "name": "RemoteSupportType", + "modelAsString": true + } + } + }, + "additionalProperties": false + }, + "SoftwareAssuranceChangeRequestProperties": { + "type": "object", + "properties": { + "softwareAssuranceIntent": { + "type": "string", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SoftwareAssuranceIntent", + "modelAsString": true + } + } + }, + "additionalProperties": false + }, + "SoftwareAssuranceChangeRequest": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SoftwareAssuranceChangeRequestProperties" + } + }, + "additionalProperties": false + }, + "LogCollectionRequest": { + "description": "Log Collection Request", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/LogCollectionRequestProperties" + } + }, + "additionalProperties": false + }, + "RemoteSupportRequest": { + "description": "Remote Support Request", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RemoteSupportRequestProperties" + } + }, + "additionalProperties": false + }, + "ClusterIdentityResponse": { + "description": "Cluster Identity details.", + "type": "object", + "properties": { + "properties": { + "description": "Cluster identity properties.", + "$ref": "#/definitions/ClusterIdentityResponseProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterIdentityResponseProperties": { + "type": "object", + "properties": { + "aadClientId": { + "type": "string" + }, + "aadTenantId": { + "type": "string" + }, + "aadServicePrincipalObjectId": { + "type": "string" + }, + "aadApplicationObjectId": { + "type": "string" + } + }, + "additionalProperties": false, + "readOnly": true + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/deploymentSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/deploymentSettings.json new file mode 100644 index 000000000000..fbe9009422c9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/deploymentSettings.json @@ -0,0 +1,999 @@ +{ + "swagger": "2.0", + "info": { + "title": "Deployment Settings", + "version": "2024-04-01", + "description": "Azure Stack HCI Deployment Settings." + }, + "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": "DeploymentSettings" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings": { + "get": { + "operationId": "DeploymentSettings_ListByClusters", + "tags": [ + "DeploymentSettings" + ], + "description": "List DeploymentSetting resources by Clusters", + "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": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeploymentSettingListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Deployment Settings": { + "$ref": "./examples/ListDeploymentSettingsByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings/{deploymentSettingsName}": { + "get": { + "operationId": "DeploymentSettings_Get", + "tags": [ + "DeploymentSettings" + ], + "description": "Get a DeploymentSetting", + "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": "#/parameters/ClusterNameParameter" + }, + { + "name": "deploymentSettingsName", + "in": "path", + "description": "Name of Deployment Setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeploymentSetting" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Deployment Settings": { + "$ref": "./examples/GetDeploymentSettings.json" + } + } + }, + "put": { + "operationId": "DeploymentSettings_CreateOrUpdate", + "tags": [ + "DeploymentSettings" + ], + "description": "Create a DeploymentSetting", + "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": "#/parameters/ClusterNameParameter" + }, + { + "name": "deploymentSettingsName", + "in": "path", + "description": "Name of Deployment Setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentSetting" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DeploymentSetting' update operation succeeded", + "schema": { + "$ref": "#/definitions/DeploymentSetting" + } + }, + "201": { + "description": "Resource 'DeploymentSetting' create operation succeeded", + "schema": { + "$ref": "#/definitions/DeploymentSetting" + }, + "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 Deployment Settings": { + "$ref": "./examples/PutDeploymentSettings.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DeploymentSettings_Delete", + "tags": [ + "DeploymentSettings" + ], + "description": "Delete a DeploymentSetting", + "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": "#/parameters/ClusterNameParameter" + }, + { + "name": "deploymentSettingsName", + "in": "path", + "description": "Name of Deployment Setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion 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." + } + } + }, + "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": { + "Delete Deployment Settings": { + "$ref": "./examples/DeleteDeploymentSettings.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AdapterPropertyOverrides": { + "type": "object", + "description": "The AdapterPropertyOverrides of a cluster.", + "properties": { + "jumboPacket": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + }, + "networkDirect": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + }, + "networkDirectTechnology": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE'" + } + } + }, + "DeploymentCluster": { + "type": "object", + "description": "AzureStackHCI Cluster deployment properties.", + "properties": { + "name": { + "type": "string", + "description": "The cluster name provided when preparing Active Directory." + }, + "witnessType": { + "type": "string", + "description": "Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. " + }, + "witnessPath": { + "type": "string", + "description": "Specify the fileshare path for the local witness for your Azure Stack HCI cluster." + }, + "cloudAccountName": { + "type": "string", + "description": "Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster." + }, + "azureServiceEndpoint": { + "type": "string", + "description": "For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net." + } + } + }, + "DeploymentConfiguration": { + "type": "object", + "description": "Deployment Configuration", + "properties": { + "version": { + "type": "string", + "description": "deployment template version " + }, + "scaleUnits": { + "type": "array", + "description": "Scale units will contains list of deployment data", + "items": { + "$ref": "#/definitions/ScaleUnits" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "scaleUnits" + ] + }, + "DeploymentData": { + "type": "object", + "description": "The Deployment data of AzureStackHCI Cluster.", + "properties": { + "securitySettings": { + "$ref": "#/definitions/DeploymentSecuritySettings", + "description": "SecuritySettings to deploy AzureStackHCI Cluster." + }, + "observability": { + "$ref": "#/definitions/Observability", + "description": "Observability config to deploy AzureStackHCI Cluster." + }, + "cluster": { + "$ref": "#/definitions/DeploymentCluster", + "description": "Observability config to deploy AzureStackHCI Cluster." + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage config to deploy AzureStackHCI Cluster." + }, + "namingPrefix": { + "type": "string", + "description": "naming prefix to deploy cluster.", + "pattern": "^[a-zA-Z0-9-]{1,8}$" + }, + "domainFqdn": { + "type": "string", + "description": "FQDN to deploy cluster" + }, + "infrastructureNetwork": { + "type": "array", + "description": "InfrastructureNetwork config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/InfrastructureNetwork" + }, + "x-ms-identifiers": [] + }, + "physicalNodes": { + "type": "array", + "description": "list of physical nodes config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/PhysicalNodes" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "hostNetwork": { + "$ref": "#/definitions/HostNetwork", + "description": "HostNetwork config to deploy AzureStackHCI Cluster." + }, + "sdnIntegration": { + "$ref": "#/definitions/SdnIntegration", + "description": "SDN Integration config to deploy AzureStackHCI Cluster." + }, + "adouPath": { + "type": "string", + "description": "The path to the Active Directory Organizational Unit container object prepared for the deployment. " + }, + "secretsLocation": { + "type": "string", + "description": "Azure keyvault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead." + }, + "secrets": { + "type": "array", + "description": "secrets used for cloud deployment.", + "items": { + "$ref": "./hciCommon.json#/definitions/EceDeploymentSecrets" + }, + "x-ms-identifiers": [ + "secretName" + ] + }, + "optionalServices": { + "$ref": "#/definitions/OptionalServices", + "description": "OptionalServices config to deploy AzureStackHCI Cluster." + } + } + }, + "DeploymentSetting": { + "type": "object", + "description": "Edge device resource", + "properties": { + "properties": { + "$ref": "#/definitions/DeploymentSettingsProperties", + "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" + } + ] + }, + "DeploymentSettingListResult": { + "type": "object", + "description": "The response of a DeploymentSetting list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DeploymentSetting items on this page", + "items": { + "$ref": "#/definitions/DeploymentSetting" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DeploymentSettingsProperties": { + "type": "object", + "description": "DeploymentSetting properties", + "properties": { + "provisioningState": { + "$ref": "./hciCommon.json#/definitions/ProvisioningState", + "description": "DeploymentSetting provisioning state", + "readOnly": true + }, + "arcNodeResourceIds": { + "type": "array", + "description": "Azure resource ids of Arc machines to be part of cluster.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "deploymentMode": { + "$ref": "./hciCommon.json#/definitions/DeploymentMode", + "description": "The deployment mode for cluster deployment." + }, + "operationType": { + "type": "string", + "description": "The intended operation for a cluster.", + "enum": [ + "ClusterProvisioning", + "ClusterUpgrade" + ], + "default": "ClusterProvisioning", + "x-ms-enum": { + "name": "OperationType", + "modelAsString": true, + "values": [ + { + "name": "ClusterProvisioning", + "value": "ClusterProvisioning", + "description": "Cluster provisioning operation." + }, + { + "name": "ClusterUpgrade", + "value": "ClusterUpgrade", + "description": "Cluster upgrade operation." + } + ] + } + }, + "deploymentConfiguration": { + "$ref": "#/definitions/DeploymentConfiguration", + "description": "Scale units will contains list of deployment data", + "x-ms-identifiers": [] + }, + "reportedProperties": { + "$ref": "./hciCommon.json#/definitions/EceReportedProperties", + "description": "Deployment Status reported from cluster.", + "readOnly": true + } + }, + "required": [ + "arcNodeResourceIds", + "deploymentMode", + "deploymentConfiguration" + ] + }, + "HostNetwork": { + "type": "object", + "description": "The HostNetwork of a cluster.", + "properties": { + "intents": { + "type": "array", + "description": "The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM.", + "items": { + "$ref": "#/definitions/Intents" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "storageNetworks": { + "type": "array", + "description": "List of StorageNetworks config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/StorageNetworks" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "storageConnectivitySwitchless": { + "type": "boolean", + "description": "Defines how the storage adapters between nodes are connected either switch or switch less..", + "default": false + }, + "enableStorageAutoIp": { + "type": "boolean", + "description": "Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically.", + "default": false + } + } + }, + "InfrastructureNetwork": { + "type": "object", + "description": "The InfrastructureNetwork of a AzureStackHCI Cluster.", + "properties": { + "subnetMask": { + "type": "string", + "description": "Subnet mask that matches the provided IP address space." + }, + "gateway": { + "type": "string", + "description": "Default gateway that should be used for the provided IP address space." + }, + "ipPools": { + "type": "array", + "description": "Range of IP addresses from which addresses are allocated for nodes within a subnet.", + "items": { + "$ref": "#/definitions/IpPools" + }, + "x-ms-identifiers": [] + }, + "dnsServers": { + "type": "array", + "description": "IPv4 address of the DNS servers in your environment.", + "items": { + "type": "string" + } + }, + "useDhcp": { + "type": "boolean", + "description": "Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required" + } + } + }, + "Intents": { + "type": "object", + "description": "The Intents of a cluster.", + "properties": { + "name": { + "type": "string", + "description": "Name of the network intent you wish to create." + }, + "trafficType": { + "type": "array", + "description": "List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'.", + "items": { + "type": "string" + } + }, + "adapter": { + "type": "array", + "description": "Array of network interfaces used for the network intent.", + "items": { + "type": "string" + } + }, + "overrideVirtualSwitchConfiguration": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "default": false + }, + "virtualSwitchConfigurationOverrides": { + "$ref": "#/definitions/VirtualSwitchConfigurationOverrides", + "description": "Set virtualSwitch ConfigurationOverrides for cluster." + }, + "overrideQosPolicy": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "default": false + }, + "qosPolicyOverrides": { + "$ref": "#/definitions/QosPolicyOverrides", + "description": "Set QoS PolicyOverrides for cluster." + }, + "overrideAdapterProperty": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "default": false + }, + "adapterPropertyOverrides": { + "$ref": "#/definitions/AdapterPropertyOverrides", + "description": "Set Adapter PropertyOverrides for cluster." + } + } + }, + "IpPools": { + "type": "object", + "description": "The dnsServers of a device.", + "properties": { + "startingAddress": { + "type": "string", + "description": "Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering." + }, + "endingAddress": { + "type": "string", + "description": "Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering." + } + } + }, + "NetworkController": { + "type": "object", + "description": "network controller config for SDN Integration to deploy AzureStackHCI Cluster.", + "properties": { + "macAddressPoolStart": { + "type": "string", + "description": "macAddressPoolStart of network controller used for SDN Integration." + }, + "macAddressPoolStop": { + "type": "string", + "description": "macAddressPoolStop of network controller used for SDN Integration." + }, + "networkVirtualizationEnabled": { + "type": "boolean", + "description": "NetworkVirtualizationEnabled of network controller used for SDN Integration." + } + } + }, + "Observability": { + "type": "object", + "description": "The Observability of AzureStackHCI Cluster.", + "properties": { + "streamingDataClient": { + "type": "boolean", + "description": "Enables telemetry data to be sent to Microsoft", + "default": true + }, + "euLocation": { + "type": "boolean", + "description": "Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU.", + "default": false + }, + "episodicDataUpload": { + "type": "boolean", + "description": "When set to true, collects log data to facilitate quicker issue resolution.", + "default": true + } + } + }, + "OptionalServices": { + "type": "object", + "description": "The OptionalServices of AzureStackHCI Cluster.", + "properties": { + "customLocation": { + "type": "string", + "description": "The name of custom location." + } + } + }, + "PhysicalNodes": { + "type": "object", + "description": "The PhysicalNodes of a cluster.", + "properties": { + "name": { + "type": "string", + "description": "NETBIOS name of each physical server on your Azure Stack HCI cluster." + }, + "ipv4Address": { + "type": "string", + "description": "The IPv4 address assigned to each physical server on your Azure Stack HCI cluster." + } + } + }, + "QosPolicyOverrides": { + "type": "object", + "description": "The QoSPolicyOverrides of a cluster.", + "properties": { + "priorityValue8021Action_Cluster": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + }, + "priorityValue8021Action_SMB": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + }, + "bandwidthPercentage_SMB": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + } + } + }, + "SbePartnerInfo": { + "type": "object", + "description": "The solution builder extension (SBE) partner deployment info for cluster.", + "properties": { + "sbeDeploymentInfo": { + "$ref": "#/definitions/SbeDeploymentInfo", + "description": "SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment." + }, + "partnerProperties": { + "type": "array", + "description": "List of SBE partner properties for AzureStackHCI cluster deployment.", + "items": { + "$ref": "#/definitions/SbePartnerProperties" + }, + "x-ms-identifiers": [] + }, + "credentialList": { + "type": "array", + "description": "SBE credentials list for AzureStackHCI cluster deployment.", + "items": { + "$ref": "#/definitions/SbeCredentials" + }, + "x-ms-identifiers": [ + "secretName" + ] + } + } + }, + "SbeDeploymentInfo": { + "type": "object", + "description": "Solution builder extension (SBE) package and manifest information for the solution builder extension staged for AzureStackHCI cluster deployment.", + "properties": { + "version": { + "type": "string", + "description": "SBE package version." + }, + "family": { + "type": "string", + "description": "SBE family name." + }, + "publisher": { + "type": "string", + "description": "SBE manifest publisher." + }, + "sbeManifestSource": { + "type": "string", + "description": "SBE Manifest Source." + }, + "sbeManifestCreationDate": { + "type": "string", + "format": "date-time", + "description": "SBE Manifest Creation Date." + } + } + }, + "SbePartnerProperties": { + "type": "object", + "description": "Solution builder extension (SBE) partner properties object.", + "properties": { + "name": { + "type": "string", + "description": "SBE partner property name." + }, + "value": { + "type": "string", + "description": "SBE partner property value." + } + } + }, + "SbeCredentials": { + "type": "object", + "description": "secrets used for solution builder extension (SBE) partner extensibility.", + "properties": { + "secretName": { + "type": "string", + "description": "secret name stored in keyvault." + }, + "eceSecretName": { + "type": "string", + "description": "secret name expected for Enterprise Cloud Engine (ECE)." + }, + "secretLocation": { + "type": "string", + "format": "uri", + "description": "secret URI stored in keyvault." + } + } + }, + "ScaleUnits": { + "type": "object", + "description": "Scale units will contains list of deployment data", + "properties": { + "deploymentData": { + "$ref": "#/definitions/DeploymentData", + "description": "Deployment Data to deploy AzureStackHCI Cluster." + }, + "sbePartnerInfo": { + "$ref": "#/definitions/SbePartnerInfo", + "description": "Solution builder extension (SBE) partner properties" + } + }, + "required": [ + "deploymentData" + ], + "externalDocs": { + "description": "Deploy Azure Stack HCI using an existing configuration file", + "url": "https://learn.microsoft.com/en-us/azure-stack/hci/deploy/deployment-tool-existing-file" + } + }, + "SdnIntegration": { + "type": "object", + "description": "SDN Integration config to deploy AzureStackHCI Cluster.", + "properties": { + "networkController": { + "$ref": "#/definitions/NetworkController", + "description": "network controller config for SDN Integration to deploy AzureStackHCI Cluster." + } + } + }, + "DeploymentSecuritySettings": { + "type": "object", + "description": "The SecuritySettings of AzureStackHCI Cluster.", + "properties": { + "hvciProtection": { + "type": "boolean", + "description": "By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster.", + "default": true + }, + "drtmProtection": { + "type": "boolean", + "description": "By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent.", + "default": true + }, + "driftControlEnforced": { + "type": "boolean", + "description": "When set to true, the security baseline is re-applied regularly.", + "default": true + }, + "credentialGuardEnforced": { + "type": "boolean", + "description": "When set to true, Credential Guard is enabled.", + "default": false + }, + "smbSigningEnforced": { + "type": "boolean", + "description": "When set to true, the SMB default instance requires sign in for the client and server services.", + "default": true + }, + "smbClusterEncryption": { + "type": "boolean", + "description": "When set to true, cluster east-west traffic is encrypted.", + "default": false + }, + "sideChannelMitigationEnforced": { + "type": "boolean", + "description": "When set to true, all the side channel mitigations are enabled", + "default": true + }, + "bitlockerBootVolume": { + "type": "boolean", + "description": "When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ", + "default": true + }, + "bitlockerDataVolumes": { + "type": "boolean", + "description": "When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes.", + "default": true + }, + "wdacEnforced": { + "type": "boolean", + "description": "WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster.", + "default": true + } + } + }, + "Storage": { + "type": "object", + "description": "The Storage config of AzureStackHCI Cluster.", + "properties": { + "configurationMode": { + "type": "string", + "description": "By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage'", + "default": "Express" + } + } + }, + "StorageAdapterIPInfo": { + "type": "object", + "description": "The StorageAdapter physical nodes of a cluster.", + "properties": { + "physicalNode": { + "type": "string", + "description": "storage adapter physical node name." + }, + "ipv4Address": { + "type": "string", + "description": "The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster." + }, + "subnetMask": { + "type": "string", + "description": "The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster." + } + } + }, + "StorageNetworks": { + "type": "object", + "description": "The StorageNetworks of a cluster.", + "properties": { + "name": { + "type": "string", + "description": "Name of the storage network." + }, + "networkAdapterName": { + "type": "string", + "description": "Name of the storage network adapter." + }, + "vlanId": { + "type": "string", + "description": "ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. " + }, + "storageAdapterIPInfo": { + "type": "array", + "description": "List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/StorageAdapterIPInfo" + }, + "x-ms-identifiers": [ + "physicalNode" + ] + } + } + }, + "VirtualSwitchConfigurationOverrides": { + "type": "object", + "description": "The VirtualSwitchConfigurationOverrides of a cluster.", + "properties": { + "enableIov": { + "type": "string", + "description": "Enable IoV for Virtual Switch" + }, + "loadBalancingAlgorithm": { + "type": "string", + "description": "Load Balancing Algorithm for Virtual Switch" + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/edgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/edgeDevices.json new file mode 100644 index 000000000000..0cf93143542f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/edgeDevices.json @@ -0,0 +1,1237 @@ +{ + "swagger": "2.0", + "info": { + "title": "Edge Devices", + "version": "2024-04-01", + "description": "Azure Arc-enabled Edge Device." + }, + "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": "EdgeDevices" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices": { + "get": { + "operationId": "EdgeDevices_List", + "tags": [ + "EdgeDevices" + ], + "description": "List EdgeDevice resources by parent", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeDeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Edge Devices": { + "$ref": "./examples/ListEdgeDevices.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}": { + "get": { + "operationId": "EdgeDevices_Get", + "tags": [ + "EdgeDevices" + ], + "description": "Get a EdgeDevice", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "Name of Device", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeDevice" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Edge Device": { + "$ref": "./examples/GetEdgeDevices.json" + } + } + }, + "put": { + "operationId": "EdgeDevices_CreateOrUpdate", + "tags": [ + "EdgeDevices" + ], + "description": "Create a EdgeDevice", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "Name of Device", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EdgeDevice" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeDevice" + } + }, + "201": { + "description": "Resource successfully created.", + "schema": { + "$ref": "#/definitions/EdgeDevice" + }, + "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": { + "Create HCI Edge Device": { + "$ref": "./examples/CreateHciEdgeDevice.json" + } + } + }, + "delete": { + "operationId": "EdgeDevices_Delete", + "tags": [ + "EdgeDevices" + ], + "description": "Delete a EdgeDevice", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "Name of Device", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion 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." + } + } + }, + "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": { + "Delete Edge Devices": { + "$ref": "./examples/DeleteEdgeDevices.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/validate": { + "post": { + "operationId": "EdgeDevices_Validate", + "tags": [ + "EdgeDevices" + ], + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "Name of Device", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "ValidateRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateResponse" + } + }, + "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-examples": { + "Validate Edge Devices": { + "$ref": "./examples/ValidateEdgeDevices.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AdapterPropertyOverrides": { + "type": "object", + "description": "The AdapterPropertyOverrides of a cluster.", + "properties": { + "jumboPacket": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "readOnly": true + }, + "networkDirect": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "readOnly": true + }, + "networkDirectTechnology": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE'", + "readOnly": true + } + } + }, + "ArcExtensionState": { + "type": "string", + "description": "Arc extension installation state.", + "enum": [ + "NotSpecified", + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Creating", + "Updating", + "Moving", + "Deleting", + "Deleted" + ], + "x-ms-enum": { + "name": "ArcExtensionState", + "modelAsString": true, + "values": [ + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "Arc extension state is not specified." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Arc extension state is Succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Arc extension state is Failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Arc extension state is Canceled." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Arc extension state is Accepted when extension installation triggered." + }, + { + "name": "Creating", + "value": "Creating", + "description": "Arc extension is in Creating State." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Arc extension is in Updating State." + }, + { + "name": "Moving", + "value": "Moving", + "description": "Arc extension is in Moving State." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Arc extension is in Deleting State." + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Arc extension is in Deleted State." + } + ] + } + }, + "DeviceConfiguration": { + "type": "object", + "description": "The device Configuration for edge device.", + "properties": { + "nicDetails": { + "type": "array", + "description": "NIC Details of device", + "items": { + "$ref": "#/definitions/NicDetail" + }, + "x-ms-identifiers": [ + "adapterName" + ] + }, + "deviceMetadata": { + "type": "string", + "description": "Device metadata details." + } + } + }, + "DeviceKind": { + "type": "string", + "description": "Edge device kind.", + "enum": [ + "HCI" + ], + "default": "HCI", + "x-ms-enum": { + "name": "DeviceKind", + "modelAsString": true, + "values": [ + { + "name": "HCI", + "value": "HCI", + "description": "Arc-enabled edge device with HCI OS." + } + ] + } + }, + "DeviceState": { + "type": "string", + "description": "The edge device state.", + "enum": [ + "NotSpecified", + "Connected", + "Disconnected", + "Repairing", + "Draining", + "InMaintenance", + "Resuming", + "Processing" + ], + "x-ms-enum": { + "name": "DeviceState", + "modelAsString": true, + "values": [ + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "The edge device state is not specified." + }, + { + "name": "Connected", + "value": "Connected", + "description": "The edge device state is in connected state." + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "The edge device state is in disconnected state." + }, + { + "name": "Repairing", + "value": "Repairing", + "description": "The edge device state is in repairing state." + }, + { + "name": "Draining", + "value": "Draining", + "description": "The edge device state is in draining state." + }, + { + "name": "InMaintenance", + "value": "InMaintenance", + "description": "The edge device state is in maintenance state." + }, + { + "name": "Resuming", + "value": "Resuming", + "description": "The edge device state is in resuming state." + }, + { + "name": "Processing", + "value": "Processing", + "description": "The edge device state is in processing state." + } + ] + } + }, + "EdgeDevice": { + "type": "object", + "description": "Edge device resource.", + "properties": { + "kind": { + "$ref": "#/definitions/DeviceKind", + "description": "Device kind to support polymorphic resource.", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "kind", + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EdgeDeviceListResult": { + "type": "object", + "description": "The response of a EdgeDevice list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EdgeDevice items on this page", + "items": { + "$ref": "#/definitions/EdgeDevice" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EdgeDeviceProperties": { + "type": "object", + "description": "Edge Device properties", + "properties": { + "deviceConfiguration": { + "$ref": "#/definitions/DeviceConfiguration", + "description": "Device Configuration" + }, + "provisioningState": { + "$ref": "./hciCommon.json#/definitions/ProvisioningState", + "description": "Provisioning state of edgeDevice resource", + "readOnly": true + } + } + }, + "ErrorDetail": { + "type": "object", + "description": "details of validation failure", + "properties": { + "exception": { + "type": "string", + "description": "Exception details while installing extension.", + "readOnly": true + } + } + }, + "Extension": { + "type": "object", + "description": "Arc extension installed on edge device.", + "properties": { + "extensionName": { + "type": "string", + "description": "Arc extension name installed on edge device.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/ArcExtensionState", + "description": "Arc extension state from arc machine extension.", + "readOnly": true + }, + "errorDetails": { + "type": "array", + "description": "Error details while installing Arc extension.", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "extensionResourceId": { + "type": "string", + "format": "arm-id", + "description": "Arc Extension Azure resource id.", + "readOnly": true + }, + "typeHandlerVersion": { + "type": "string", + "description": "Extension version installed.", + "readOnly": true + }, + "managedBy": { + "type": "string", + "description": "Extension managed by user or Azure.", + "default": "Azure", + "enum": [ + "User", + "Azure" + ], + "x-ms-enum": { + "name": "ExtensionManagedBy", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "ExtensionManagedBy": { + "type": "string", + "description": "Arc extension managed by Azure or User.", + "enum": [ + "User", + "Azure" + ], + "x-ms-enum": { + "name": "ExtensionManagedBy", + "modelAsString": true + } + }, + "ExtensionProfile": { + "type": "object", + "description": "Extensions details for edge device.", + "properties": { + "extensions": { + "type": "array", + "description": "List of Arc extensions installed on edge device.", + "items": { + "$ref": "#/definitions/Extension" + }, + "readOnly": true, + "x-ms-identifiers": [ + "extensionName" + ] + } + } + }, + "HciEdgeDevice": { + "type": "object", + "description": "Arc-enabled edge device with HCI OS.", + "properties": { + "properties": { + "$ref": "#/definitions/HciEdgeDeviceProperties", + "description": "properties for Arc-enabled edge device with HCI OS." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EdgeDevice" + } + ], + "x-ms-discriminator-value": "HCI" + }, + "HciEdgeDeviceProperties": { + "type": "object", + "description": "properties for Arc-enabled edge device with HCI OS.", + "properties": { + "reportedProperties": { + "$ref": "#/definitions/HciReportedProperties", + "description": "The instance view of all current configurations on HCI device.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/EdgeDeviceProperties" + } + ] + }, + "HciNetworkProfile": { + "type": "object", + "description": "The network profile of a device.", + "properties": { + "nicDetails": { + "type": "array", + "description": "List of NIC Details of device.", + "items": { + "$ref": "#/definitions/HciNicDetail" + }, + "readOnly": true, + "x-ms-identifiers": [ + "adapterName" + ] + }, + "switchDetails": { + "type": "array", + "description": "List of switch details for edge device.", + "items": { + "$ref": "#/definitions/SwitchDetail" + }, + "readOnly": true, + "x-ms-identifiers": [ + "switchName" + ] + }, + "hostNetwork": { + "$ref": "#/definitions/HostNetwork", + "description": "HostNetwork config to deploy AzureStackHCI Cluster.", + "readOnly": true + } + } + }, + "HciNicDetail": { + "type": "object", + "description": "The NIC Detail of a device.", + "properties": { + "adapterName": { + "type": "string", + "description": "Adapter Name of NIC", + "readOnly": true + }, + "interfaceDescription": { + "type": "string", + "description": "Interface Description of NIC", + "readOnly": true + }, + "componentId": { + "type": "string", + "description": "Component Id of NIC", + "readOnly": true + }, + "driverVersion": { + "type": "string", + "description": "Driver Version of NIC", + "readOnly": true + }, + "ip4Address": { + "type": "string", + "description": "Subnet Mask of NIC", + "readOnly": true + }, + "subnetMask": { + "type": "string", + "description": "Subnet Mask of NIC", + "readOnly": true + }, + "defaultGateway": { + "type": "string", + "description": "Default Gateway of NIC", + "readOnly": true + }, + "dnsServers": { + "type": "array", + "description": "DNS Servers for NIC", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "defaultIsolationId": { + "type": "string", + "description": "Default Isolation of Management NIC", + "readOnly": true + }, + "macAddress": { + "type": "string", + "description": "MAC address information of NIC.", + "readOnly": true + }, + "slot": { + "type": "string", + "description": "The slot attached to the NIC.", + "readOnly": true + }, + "switchName": { + "type": "string", + "description": "The switch attached to the NIC, if any.", + "readOnly": true + }, + "nicType": { + "type": "string", + "description": "The type of NIC, physical, virtual, management.", + "readOnly": true + }, + "vlanId": { + "type": "string", + "description": "The VLAN ID of the physical NIC.", + "readOnly": true + }, + "nicStatus": { + "type": "string", + "description": "The status of NIC, up, disconnected.", + "readOnly": true + } + } + }, + "HciOsProfile": { + "type": "object", + "description": "OS configurations for HCI device.", + "properties": { + "bootType": { + "type": "string", + "description": "The boot type of the device. e.g. UEFI, Legacy etc", + "readOnly": true + }, + "assemblyVersion": { + "type": "string", + "description": "Version of assembly present on device", + "readOnly": true + } + } + }, + "HciReportedProperties": { + "type": "object", + "description": "The device Configuration for HCI device.", + "properties": { + "networkProfile": { + "$ref": "#/definitions/HciNetworkProfile", + "description": "HCI device network information.", + "readOnly": true + }, + "osProfile": { + "$ref": "#/definitions/HciOsProfile", + "description": "HCI device OS specific information.", + "readOnly": true + }, + "sbeDeploymentPackageInfo": { + "$ref": "#/definitions/SbeDeploymentPackageInfo", + "description": "Solution builder extension (SBE) deployment package information.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ReportedProperties" + } + ] + }, + "HostNetwork": { + "type": "object", + "description": "The HostNetwork of a cluster.", + "properties": { + "intents": { + "type": "array", + "description": "The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM.", + "items": { + "$ref": "#/definitions/Intents" + }, + "readOnly": true, + "x-ms-identifiers": [ + "intentName" + ] + }, + "storageNetworks": { + "type": "array", + "description": "List of StorageNetworks config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/StorageNetworks" + }, + "readOnly": true, + "x-ms-identifiers": [ + "networkAdapterName" + ] + }, + "storageConnectivitySwitchless": { + "type": "boolean", + "description": "Defines how the storage adapters between nodes are connected either switch or switch less.", + "readOnly": true + }, + "enableStorageAutoIp": { + "type": "boolean", + "description": "Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically.", + "readOnly": true + } + } + }, + "Intents": { + "type": "object", + "description": "The Intents of a cluster.", + "properties": { + "scope": { + "type": "integer", + "format": "int64", + "description": "Scope for host network intent.", + "readOnly": true + }, + "intentType": { + "type": "integer", + "format": "int64", + "description": "IntentType for host network intent.", + "readOnly": true + }, + "isComputeIntentSet": { + "type": "boolean", + "description": "IsComputeIntentSet for host network intent.", + "readOnly": true + }, + "isStorageIntentSet": { + "type": "boolean", + "description": "IsStorageIntentSet for host network intent.", + "readOnly": true + }, + "isOnlyStorage": { + "type": "boolean", + "description": "IntentType for host network intent.", + "readOnly": true + }, + "isManagementIntentSet": { + "type": "boolean", + "description": "IsManagementIntentSet for host network intent.", + "readOnly": true + }, + "isStretchIntentSet": { + "type": "boolean", + "description": "IsStretchIntentSet for host network intent.", + "readOnly": true + }, + "isOnlyStretch": { + "type": "boolean", + "description": "IsOnlyStretch for host network intent.", + "readOnly": true + }, + "isNetworkIntentType": { + "type": "boolean", + "description": "IsNetworkIntentType for host network intent.", + "readOnly": true + }, + "intentName": { + "type": "string", + "description": "Name of the network intent you wish to create.", + "readOnly": true + }, + "intentAdapters": { + "type": "array", + "description": "Array of adapters used for the network intent.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "overrideVirtualSwitchConfiguration": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "readOnly": true + }, + "virtualSwitchConfigurationOverrides": { + "$ref": "#/definitions/VirtualSwitchConfigurationOverrides", + "description": "Set virtualSwitch ConfigurationOverrides for cluster.", + "readOnly": true + }, + "overrideQosPolicy": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "readOnly": true + }, + "qosPolicyOverrides": { + "$ref": "./deploymentSettings.json#/definitions/QosPolicyOverrides", + "description": "Set QoS PolicyOverrides for cluster.", + "readOnly": true + }, + "overrideAdapterProperty": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "readOnly": true + }, + "adapterPropertyOverrides": { + "$ref": "#/definitions/AdapterPropertyOverrides", + "description": "Set Adapter PropertyOverrides for cluster.", + "readOnly": true + } + } + }, + "NicDetail": { + "type": "object", + "description": "The NIC Detail of a device.", + "properties": { + "adapterName": { + "type": "string", + "description": "Adapter Name of NIC" + }, + "interfaceDescription": { + "type": "string", + "description": "Interface Description of NIC" + }, + "componentId": { + "type": "string", + "description": "Component Id of NIC" + }, + "driverVersion": { + "type": "string", + "description": "Driver Version of NIC" + }, + "ip4Address": { + "type": "string", + "description": "Subnet Mask of NIC" + }, + "subnetMask": { + "type": "string", + "description": "Subnet Mask of NIC" + }, + "defaultGateway": { + "type": "string", + "description": "Default Gateway of NIC" + }, + "dnsServers": { + "type": "array", + "description": "DNS Servers for NIC", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "defaultIsolationId": { + "type": "string", + "description": "Default Isolation of Management NIC" + } + } + }, + "ReportedProperties": { + "type": "object", + "description": "Reported properties pushed from edge device.", + "properties": { + "deviceState": { + "$ref": "#/definitions/DeviceState", + "description": "edge device state.", + "readOnly": true + }, + "extensionProfile": { + "$ref": "#/definitions/ExtensionProfile", + "description": "Extensions details for edge device.", + "readOnly": true + } + } + }, + "SbeDeploymentPackageInfo": { + "type": "object", + "description": "Solution builder extension (SBE) deployment package information.", + "properties": { + "code": { + "type": "string", + "description": "SBE deployment validation code.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "A detailed message that explains the SBE package validation result.", + "readOnly": true + }, + "sbeManifest": { + "type": "string", + "description": "This represents discovered update results for matching updates and store it as SBE manifest.", + "readOnly": true + } + } + }, + "StorageAdapterIPInfo": { + "type": "object", + "description": "The StorageAdapter physical nodes of a cluster.", + "properties": { + "physicalNode": { + "type": "string", + "description": "storage adapter physical node name.", + "readOnly": true + }, + "ipv4Address": { + "type": "string", + "description": "The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster.", + "readOnly": true + }, + "subnetMask": { + "type": "string", + "description": "The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster.", + "readOnly": true + } + } + }, + "StorageNetworks": { + "type": "object", + "description": "The StorageNetworks of a cluster.", + "properties": { + "name": { + "type": "string", + "description": "Name of the storage network.", + "readOnly": true + }, + "networkAdapterName": { + "type": "string", + "description": "Name of the storage network adapter.", + "readOnly": true + }, + "storageVlanId": { + "type": "string", + "description": "ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. ", + "readOnly": true + }, + "storageAdapterIPInfo": { + "type": "array", + "description": "List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/StorageAdapterIPInfo" + }, + "readOnly": true, + "x-ms-identifiers": [ + "physicalNode" + ] + } + } + }, + "SwitchDetail": { + "type": "object", + "description": "List of switch details for edge device.", + "properties": { + "switchName": { + "type": "string", + "description": "The name of the switch.", + "readOnly": true + }, + "switchType": { + "type": "string", + "description": "The type of the switch. e.g. external, internal.", + "readOnly": true + }, + "extensions": { + "type": "array", + "description": "This represents extensions installed on virtualSwitch.", + "items": { + "$ref": "#/definitions/SwitchExtension" + }, + "readOnly": true, + "x-ms-identifiers": [ + "extensionName" + ] + } + } + }, + "SwitchExtension": { + "type": "object", + "description": "This represents extensions installed on virtualSwitch.", + "properties": { + "switchId": { + "type": "string", + "description": "Unique identifier for virtualSwitch.", + "readOnly": true + }, + "extensionName": { + "type": "string", + "description": "This will show extension name for virtualSwitch.", + "readOnly": true + }, + "extensionEnabled": { + "type": "boolean", + "description": "This represents whether extension is enabled on virtualSwitch.", + "readOnly": true + } + } + }, + "ValidateRequest": { + "type": "object", + "description": "The validate request for Edge Device.", + "properties": { + "edgeDeviceIds": { + "type": "array", + "description": "Node Ids against which, current node has to be validated.", + "items": { + "type": "string" + } + }, + "additionalInfo": { + "type": "string", + "description": "Additional info required for validation." + } + }, + "required": [ + "edgeDeviceIds" + ] + }, + "ValidateResponse": { + "type": "object", + "description": "An Accepted response with an Operation-Location header.", + "properties": { + "status": { + "type": "string", + "description": "edge device validation status", + "readOnly": true + } + } + }, + "VirtualSwitchConfigurationOverrides": { + "type": "object", + "description": "The VirtualSwitchConfigurationOverrides of a cluster.", + "properties": { + "enableIov": { + "type": "string", + "description": "Enable IoV for Virtual Switch", + "readOnly": true + }, + "loadBalancingAlgorithm": { + "type": "string", + "description": "Load Balancing Algorithm for Virtual Switch", + "readOnly": true + } + } + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConfigureRemoteSupport.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConfigureRemoteSupport.json new file mode 100644 index 000000000000..59079ea4467c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConfigureRemoteSupport.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "mycluster", + "api-version": "2024-04-01", + "remoteSupportRequest": { + "properties": { + "accessLevel": "Diagnostics", + "expirationTimeStamp": "2020-01-01T17:18:19.1234567Z", + "remoteSupportType": "Enable" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "remoteSupportProperties": { + "accessLevel": "Diagnostics", + "expirationTimeStamp": "2020-01-01T17:18:19.1234567Z", + "remoteSupportType": "Enable", + "remoteSupportNodeSettings": [ + { + "arcResourceId": "/subscriptions//resourcegroups//Microsoft.HybridCompute/machines/arcNode0", + "state": "Active", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "updatedAt": "2020-01-01T17:18:19.1234567Z", + "connectionStatus": "Connected", + "connectionErrorMessage": "test", + "transcriptLocation": "test" + }, + { + "arcResourceId": "/subscriptions//resourcegroups//Microsoft.HybridCompute/machines/arcNode1", + "state": "Active", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "updatedAt": "2020-01-01T17:18:19.1234567Z", + "connectionStatus": "Connected", + "connectionErrorMessage": "test", + "transcriptLocation": "test" + } + ], + "remoteSupportSessionDetails": [ + { + "sessionStartTime": "2020-01-01T17:18:19.1234567Z", + "sessionEndTime": "2020-01-01T17:18:19.1234567Z", + "nodeName": "arcNode0", + "duration": 120, + "accessLevel": "Diagnostics" + } + ] + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "nodeType": "ThirdParty", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConsentAndInstallDefaultExtensions.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConsentAndInstallDefaultExtensions.json new file mode 100644 index 000000000000..a8d4b38d29aa --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConsentAndInstallDefaultExtensions.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "Creating", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Creating" + } + ], + "connectivityProperties": { + "enabled": false, + "serviceConfigurations": [] + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateArcIdentity.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateArcIdentity.json new file mode 100644 index 000000000000..13a425a48d9c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateArcIdentity.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "arcApplicationClientId": "7b93bf67-60ac-4909-a987-ac438e69f9ba", + "arcApplicationTenantId": "bdb2c88c-9cfd-4e19-927d-51e875f6912b", + "arcApplicationObjectId": "400bd05f-395f-45a6-ba75-72601df80107", + "arcServicePrincipalObjectId": "00cc4014-482e-4de9-9932-83415cc75f45" + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateCluster.json new file mode 100644 index 000000000000..e1ae7cec68f4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateCluster.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-04-01", + "cluster": { + "location": "East US", + "properties": { + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "identity": { + "principalId": "87a834db-2e45-409e-911b-e16a44562ec3", + "tenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "type": "SystemAssigned" + }, + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "NotYetRegistered", + "connectivityStatus": "NotYetRegistered", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Disabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": {}, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "serviceEndpoint": "https://azurestackhci.azurefd.net/eastus" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateClusterIdentity.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateClusterIdentity.json new file mode 100644 index 000000000000..9ac63f9947e8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateClusterIdentity.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "aadClientId": "7b93bf67-60ac-4909-a987-ac438e69f9ba", + "aadTenantId": "bdb2c88c-9cfd-4e19-927d-51e875f6912b", + "aadServicePrincipalObjectId": "400bd05f-395f-45a6-ba75-72601df80107", + "aadApplicationObjectId": "00cc4014-482e-4de9-9932-83415cc75f45" + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateHciEdgeDevice.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateHciEdgeDevice.json new file mode 100644 index 000000000000..0c3e49a73e10 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateHciEdgeDevice.json @@ -0,0 +1,257 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2024-04-01", + "resource": { + "kind": "HCI", + "properties": { + "deviceConfiguration": { + "nicDetails": [ + { + "adapterName": "ethernet", + "interfaceDescription": "NDIS 6.70 ", + "componentId": "VMBUS{f8615163-df3e-46c5-913f-f2d2f965ed0g} ", + "driverVersion": "10.0.20348.1547 ", + "ip4Address": "10.10.10.10", + "subnetMask": "255.255.255.0", + "defaultGateway": "10.10.10.1", + "dnsServers": [ + "100.10.10.1" + ], + "defaultIsolationId": "0" + } + ], + "deviceMetadata": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/edgeDevices", + "kind": "HCI", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "reportedProperties": { + "deviceState": "Connected", + "networkProfile": { + "nicDetails": [ + { + "adapterName": "vmanagement", + "interfaceDescription": "Hyper-V Virtual Ethernet Adapter", + "componentId": "vms_mp", + "driverVersion": "10.0.25398.1", + "ip4Address": "192.168.200.92", + "subnetMask": "255.255.255.0", + "defaultGateway": "192.168.200.1", + "dnsServers": [ + "192.168.200.222" + ], + "defaultIsolationId": "0", + "slot": "0", + "macAddress": "000000000041", + "switchName": null, + "nicType": "Virtual", + "vlanId": "0", + "nicStatus": "Up" + } + ], + "switchDetails": [ + { + "switchName": "vmanagement", + "switchType": "External" + } + ], + "hostNetwork": { + "intents": [ + { + "intentName": "managementcomputestorage", + "scope": 0, + "intentType": 14, + "isComputeIntentSet": true, + "isStorageIntentSet": true, + "isOnlyStorage": false, + "isManagementIntentSet": true, + "isStretchIntentSet": false, + "isOnlyStretch": false, + "isNetworkIntentType": true, + "intentAdapters": [ + "ethernet", + "ethernet2" + ], + "overrideVirtualSwitchConfiguration": true, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": true, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": null, + "priorityValue8021Action_SMB": null, + "bandwidthPercentage_SMB": null + }, + "overrideAdapterProperty": true, + "adapterPropertyOverrides": { + "jumboPacket": null, + "networkDirect": "0", + "networkDirectTechnology": null + } + } + ], + "storageNetworks": [ + { + "name": "StorageIntent1", + "networkAdapterName": "ethernet", + "storageVlanId": "8", + "storageAdapterIPInfo": [ + { + "physicalNode": "v-host1", + "ipv4Address": "192.168.120.192", + "subnetMask": "255.255.244.0" + } + ] + } + ], + "storageConnectivitySwitchless": false, + "enableStorageAutoIp": false + } + }, + "osProfile": { + "bootType": "UEFI", + "assemblyVersion": "2402.1" + }, + "sbeDeploymentPackageInfo": { + "code": "NewerThanLatestPublished", + "message": "The SBE package at path 'C:\\SBE' with version 4.1.2312.10 is published later than the latest SBE manifest published for online discovery. ", + "sbeManifest": "PEFwcGxpY2Fi" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/edgeDevices", + "kind": "HCI", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "reportedProperties": { + "deviceState": "Connected", + "networkProfile": { + "nicDetails": [ + { + "adapterName": "vmanagement", + "interfaceDescription": "Hyper-V Virtual Ethernet Adapter", + "componentId": "vms_mp", + "driverVersion": "10.0.25398.1", + "ip4Address": "192.168.200.92", + "subnetMask": "255.255.255.0", + "defaultGateway": "192.168.200.1", + "dnsServers": [ + "192.168.200.222" + ], + "defaultIsolationId": "0", + "slot": "0", + "macAddress": "000000000041", + "switchName": null, + "nicType": "Virtual", + "vlanId": "0", + "nicStatus": "Up" + } + ], + "switchDetails": [ + { + "switchName": "vmanagement", + "switchType": "External" + } + ], + "hostNetwork": { + "intents": [ + { + "intentName": "managementcomputestorage", + "scope": 0, + "intentType": 14, + "isComputeIntentSet": true, + "isStorageIntentSet": true, + "isOnlyStorage": false, + "isManagementIntentSet": true, + "isStretchIntentSet": false, + "isOnlyStretch": false, + "intentAdapters": [ + "ethernet", + "ethernet2" + ], + "overrideVirtualSwitchConfiguration": true, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": true, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": null, + "priorityValue8021Action_SMB": null, + "bandwidthPercentage_SMB": null + }, + "overrideAdapterProperty": true, + "adapterPropertyOverrides": { + "jumboPacket": null, + "networkDirect": "0", + "networkDirectTechnology": null + } + } + ], + "storageNetworks": [ + { + "name": "StorageIntent1", + "networkAdapterName": "ethernet", + "storageVlanId": "8", + "storageAdapterIPInfo": [ + { + "physicalNode": "v-host1", + "ipv4Address": "192.168.120.192", + "subnetMask": "255.255.244.0" + } + ] + } + ], + "storageConnectivitySwitchless": false, + "enableStorageAutoIp": false + } + }, + "osProfile": { + "bootType": "UEFI", + "assemblyVersion": "2402.1" + }, + "sbeDeploymentPackageInfo": { + "code": "NewerThanLatestPublished", + "message": "The SBE package at path 'C:\\SBE' with version 4.1.2312.10 is published later than the latest SBE manifest published for online discovery. ", + "sbeManifest": "PEFwcGxpY2Fi" + } + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteArcSetting.json new file mode 100644 index 000000000000..f9dbff0fbe7b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteArcSetting.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteCluster.json new file mode 100644 index 000000000000..b8caa9c19623 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteCluster.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteDeploymentSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteDeploymentSettings.json new file mode 100644 index 000000000000..917c57f5507b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteDeploymentSettings.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "deploymentSettingsName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteEdgeDevices.json new file mode 100644 index 000000000000..104d8387c560 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteEdgeDevices.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteExtension.json new file mode 100644 index 000000000000..f9f32f9da758 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteExtension.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteSecuritySettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteSecuritySettings.json new file mode 100644 index 000000000000..be97c58dac77 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteSecuritySettings.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "securitySettingsName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdateRuns.json new file mode 100644 index 000000000000..dc58e7b7ed87 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdateRuns.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdateSummaries.json new file mode 100644 index 000000000000..be6b9900ba37 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdateSummaries.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdates.json new file mode 100644 index 000000000000..5804c91f29d5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdates.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ExtendSoftwareAssuranceBenefit.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ExtendSoftwareAssuranceBenefit.json new file mode 100644 index 000000000000..dfc929d3c51c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ExtendSoftwareAssuranceBenefit.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-04-01", + "softwareAssuranceChangeRequest": { + "properties": { + "softwareAssuranceIntent": "Enable" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "softwareAssuranceProperties": { + "softwareAssuranceStatus": "Enabled", + "lastUpdated": "2022-08-18T22:01:12.4191603Z", + "softwareAssuranceIntent": "Enable" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "nodeType": "ThirdParty", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/Extensions_Upgrade.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/Extensions_Upgrade.json new file mode 100644 index 000000000000..06ed96f6960d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/Extensions_Upgrade.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2024-04-01", + "extensionUpgradeParameters": { + "targetVersion": "1.0.18062.0" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses", + "Retry-After": 200, + "Azure-AsyncOperation": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GeneratePassword.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GeneratePassword.json new file mode 100644 index 000000000000..59f4fff9db00 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GeneratePassword.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "secretText": "secretText", + "startDateTime": "2022-02-17T16:24:23.6264005+05:30", + "endDateTime": "2121-02-17T16:24:23.6264377+05:30", + "keyId": "00000000-2d47-4fb2-8ed2-fed71a5c197b" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetArcSetting.json new file mode 100644 index 000000000000..aead6e343a82 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetArcSetting.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "PartiallyConnected", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Connected" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Disconnected" + } + ], + "connectivityProperties": { + "enabled": false, + "serviceConfigurations": [ + { + "serviceName": "WAC", + "port": 6516 + } + ] + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + }, + { + "category": "Supportability", + "consentTime": null + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetCluster.json new file mode 100644 index 000000000000..0fa28803fcb2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetCluster.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "connectivityStatus": "Connected", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "isolatedVmAttestationConfiguration": { + "attestationResourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/testmaa", + "relyingPartyServiceEndpoint": "https://azurestackhci.azurefd.net/eastus", + "attestationServiceEndpoint": "https://dantestnoauth01.eus.attest.azure.net" + }, + "logCollectionProperties": { + "fromDate": "2020-01-01T17:18:19.1234567Z", + "toDate": "2021-01-01T17:18:19.1234567Z", + "lastLogGenerated": "2020-01-01T17:18:19.1234567Z", + "logCollectionSessionDetails": [ + { + "logStartTime": "2020-01-01T17:18:19.1234567Z", + "logEndTime": "2020-01-01T17:18:19.1234567Z", + "timeCollected": "2020-01-01T17:18:19.1234567Z", + "logSize": 1000, + "logCollectionStatus": "Succeeded", + "logCollectionJobType": "OnDemand", + "correlationId": "a76ab33a-1819-4e82-1212-e3e4ec3d1425", + "endTimeCollected": "2020-01-01T17:25:19.1234567Z" + } + ] + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "clusterType": "ThirdParty", + "manufacturer": "Dell Inc.", + "oemActivation": "Disabled", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z", + "oemActivation": "Disabled" + }, + { + "name": "Node2", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z", + "oemActivation": "Disabled" + }, + { + "name": "Node3", + "id": 3, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z", + "oemActivation": "Disabled" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetDeploymentSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetDeploymentSettings.json new file mode 100644 index 000000000000..edbf86a7d62f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetDeploymentSettings.json @@ -0,0 +1,269 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "deploymentSettingsName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationType": "ClusterProvisioning", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5", + "storageAdapterIPInfo": [ + { + "physicalNode": "string", + "ipv4Address": "10.57.48.60", + "subnetMask": "255.255.248.0" + } + ] + } + ], + "storageConnectivitySwitchless": true, + "enableStorageAutoIp": false + }, + "sdnIntegration": { + "networkController": { + "macAddressPoolStart": "00-0D-3A-1B-C7-21", + "macAddressPoolStop": "00-0D-3A-1B-C7-29", + "networkVirtualizationEnabled": true + } + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "secrets": [ + { + "secretName": "cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "BMCAdminUserCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + }, + { + "secretName": "cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "AzureStackLCMUserCredential", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c" + } + ], + "optionalServices": { + "customLocation": "customLocationName" + } + }, + "sbePartnerInfo": { + "sbeDeploymentInfo": { + "version": "4.0.2309.13", + "family": "Gen5", + "publisher": "Contoso", + "sbeManifestSource": "default", + "sbeManifestCreationDate": "2023-07-25T02:40:33Z" + }, + "partnerProperties": [ + { + "name": "EnableBMCIpV6", + "value": "false" + }, + { + "name": "PhoneHomePort", + "value": "1653" + }, + { + "name": "BMCSecurityState", + "value": "HighSecurity" + } + ], + "credentialList": [ + { + "secretName": "cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "DownloadConnectorCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + } + ] + } + } + ] + }, + "reportedProperties": { + "validationStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10" + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ] + } + ] + } + ] + }, + "deploymentStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10" + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ] + } + ] + } + ] + } + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetEdgeDevices.json new file mode 100644 index 000000000000..2420e64ab177 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetEdgeDevices.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/edgeDevices", + "kind": "HCI", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "deviceConfiguration": { + "nicDetails": [ + { + "adapterName": "ethernet", + "interfaceDescription": "NDIS 6.70 ", + "componentId": "VMBUS{f8615163-df3e-46c5-913f-f2d2f965ed0g} ", + "driverVersion": "10.0.20348.1547 ", + "ip4Address": "10.10.10.10", + "subnetMask": "255.255.255.0", + "defaultGateway": "10.10.10.1", + "dnsServers": [ + "100.10.10.1" + ], + "defaultIsolationId": "0" + } + ], + "deviceMetadata": "" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetExtension.json new file mode 100644 index 000000000000..a2454fdc02dd --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetExtension.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "enableAutomaticUpgrade": true, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "Azure" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetOffer.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetOffer.json new file mode 100644 index 000000000000..6ed664276390 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetOffer.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "offerName": "offer1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers", + "name": "offer1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetPublisher.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetPublisher.json new file mode 100644 index 000000000000..b50b77248e4b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetPublisher.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1", + "type": "Microsoft.AzureStackHCI/clusters/publishers", + "name": "publisher1" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSecuritySettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSecuritySettings.json new file mode 100644 index 000000000000..d46f92c48fd5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSecuritySettings.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "securitySettingsName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default", + "type": "Microsoft.AzureStackHCI/clusters/securitySettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "securedCoreComplianceAssignment": "Audit", + "wdacComplianceAssignment": "ApplyAndAutoCorrect", + "smbEncryptionForIntraClusterTrafficComplianceAssignment": "Audit", + "securityComplianceStatus": { + "securedCoreCompliance": "Compliant", + "wdacCompliance": "Compliant", + "dataAtRestEncrypted": "Compliant", + "dataInTransitProtected": "Compliant", + "lastUpdated": "2023-11-14T07:09:44.771Z" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSku.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSku.json new file mode 100644 index 000000000000..eafffee51bdb --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSku.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "offerName": "offer1", + "skuName": "sku1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1/skus/sku1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers/skus", + "name": "sku1", + "properties": { + "publisherId": "publisher1", + "offerId": "offer1", + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdateRuns.json new file mode 100644 index 000000000000..57c3f31bbde7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdateRuns.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3", + "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3", + "type": "Microsoft.AzureStackHCI/updates/updateRuns", + "location": "West US", + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdateSummaries.json new file mode 100644 index 000000000000..e23f69f320c0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdateSummaries.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/updateSummaries", + "location": "West US", + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "packageVersions": [ + { + "packageType": "OEM", + "version": "2.2.2108.6", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Services", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Infrastructure", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + } + ], + "currentVersion": "4.2203.2.32", + "state": "AppliedSuccessfully" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdates.json new file mode 100644 index 000000000000..81bc23aa08a2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdates.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32", + "name": "Microsoft4.2203.2.32", + "type": "Microsoft.AzureStackHCI/updates", + "location": "West US", + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/InitializeDisableProcess.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/InitializeDisableProcess.json new file mode 100644 index 000000000000..5abc71ea7a0a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/InitializeDisableProcess.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses", + "Retry-After": 200, + "Azure-AsyncOperation": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListArcSettingsByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListArcSettingsByCluster.json new file mode 100644 index 000000000000..988ebf57ba61 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListArcSettingsByCluster.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "PartiallyConnected", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Connected" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Disconnected" + } + ], + "connectivityProperties": { + "enabled": false, + "serviceConfigurations": [ + { + "serviceName": "WAC", + "port": 6516 + } + ] + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + }, + { + "category": "Supportability", + "consentTime": null + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersByResourceGroup.json new file mode 100644 index 000000000000..2daf0b42eea1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersByResourceGroup.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster1", + "name": "myCluster1", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "NotYetRegistered", + "connectivityStatus": "NotYetRegistered", + "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": {}, + "trialDaysRemaining": 29, + "billingModel": "Trial" + } + }, + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster2", + "name": "myCluster2", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "connectivityStatus": "PartiallyConnected", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "clusterType": "ThirdParty", + "manufacturer": "Dell Inc.", + "oemActivation": "Disabled", + "nodes": [ + { + "name": "Node1", + "id": 0, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "oemActivation": "Enabled" + }, + { + "name": "Node2", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "oemActivation": "Enabled" + }, + { + "name": "Node3", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "oemActivation": "Disabled" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersBySubscription.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersBySubscription.json new file mode 100644 index 000000000000..650f4fa99062 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersBySubscription.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg1/providers/Microsoft.AzureStackHCI/clusters/myCluster1", + "name": "myCluster1", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "NotYetRegistered", + "connectivityStatus": "NotYetRegistered", + "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": {}, + "trialDaysRemaining": 29, + "billingModel": "Trial" + } + }, + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg2/providers/Microsoft.AzureStackHCI/clusters/myCluster2", + "name": "myCluster2", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "West US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "connectivityStatus": "Connected", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "clusterType": "ThirdParty", + "manufacturer": "Dell Inc.", + "oemActivation": "Enabled", + "nodes": [ + { + "name": "Node1", + "id": 0, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "oemActivation": "Enabled" + }, + { + "name": "Node2", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "oemActivation": "Enabled" + }, + { + "name": "Node3", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "oemActivation": "Enabled" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListDeploymentSettingsByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListDeploymentSettingsByCluster.json new file mode 100644 index 000000000000..d44c5389e1e7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListDeploymentSettingsByCluster.json @@ -0,0 +1,202 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationType": "ClusterProvisioning", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5", + "storageAdapterIPInfo": [ + { + "physicalNode": "string", + "ipv4Address": "10.57.48.60", + "subnetMask": "255.255.248.0" + } + ] + } + ], + "storageConnectivitySwitchless": true, + "enableStorageAutoIp": false + }, + "sdnIntegration": { + "networkController": { + "macAddressPoolStart": "00-0D-3A-1B-C7-21", + "macAddressPoolStop": "00-0D-3A-1B-C7-29", + "networkVirtualizationEnabled": true + } + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "secrets": [ + { + "secretName": "cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "BMCAdminUserCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + }, + { + "secretName": "cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "AzureStackLCMUserCredential", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c" + } + ], + "optionalServices": { + "customLocation": "customLocationName" + } + }, + "sbePartnerInfo": { + "sbeDeploymentInfo": { + "version": "4.0.2309.13", + "family": "Gen5", + "publisher": "Contoso", + "sbeManifestSource": "default", + "sbeManifestCreationDate": "2023-07-25T02:40:33Z" + }, + "partnerProperties": [ + { + "name": "EnableBMCIpV6", + "value": "false" + }, + { + "name": "PhoneHomePort", + "value": "1653" + }, + { + "name": "BMCSecurityState", + "value": "HighSecurity" + } + ], + "credentialList": [ + { + "secretName": "cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "DownloadConnectorCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + } + ] + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListEdgeDevices.json new file mode 100644 index 000000000000..73799b2835d8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListEdgeDevices.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/edgeDevices", + "kind": "HCI", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "reportedProperties": { + "networkProfile": { + "nicDetails": [ + { + "adapterName": "vmanagement", + "interfaceDescription": "Hyper-V Virtual Ethernet Adapter", + "componentId": "vms_mp", + "driverVersion": "10.0.25398.1", + "ip4Address": "192.168.200.92", + "subnetMask": "255.255.255.0", + "defaultGateway": "192.168.200.1", + "dnsServers": [ + "192.168.200.222" + ], + "defaultIsolationId": "0", + "slot": "0", + "macAddress": "000000000041", + "switchName": null, + "nicType": "Virtual", + "vlanId": "0", + "nicStatus": "Up" + } + ], + "switchDetails": [ + { + "switchName": "vmanagement", + "switchType": "External" + } + ] + }, + "osProfile": { + "bootType": "UEFI", + "assemblyVersion": "2402.1" + }, + "sbeDeploymentPackageInfo": { + "code": "NewerThanLatestPublished", + "message": "The SBE package at path 'C:\\SBE' with version 4.1.2312.10 is published later than the latest SBE manifest published for online discovery. ", + "sbeManifest": "PEFwcGxpY2Fi" + } + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListExtensionsByArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListExtensionsByArcSetting.json new file mode 100644 index 000000000000..18fcab0705f3 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListExtensionsByArcSetting.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallyConnected", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Connected" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Disconnected" + } + ], + "managedBy": "Azure" + } + }, + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/Extensions/SecurityExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.CustomScriptExtension", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "scriptLocation": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/SecurityExtension", + "state": "Succeeded" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/SecurityExtension", + "state": "Failed" + } + ], + "managedBy": "Azure" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListOffersByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListOffersByCluster.json new file mode 100644 index 000000000000..f2cb70e3e02e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListOffersByCluster.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers", + "name": "offer1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListOffersByPublisher.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListOffersByPublisher.json new file mode 100644 index 000000000000..b5c62f74652d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListOffersByPublisher.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers", + "name": "offer1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListPublishersByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListPublishersByCluster.json new file mode 100644 index 000000000000..5fc94c3d7db5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListPublishersByCluster.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1", + "type": "Microsoft.AzureStackHCI/clusters/publishers", + "name": "publisher1" + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListSecuritySettingsByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListSecuritySettingsByCluster.json new file mode 100644 index 000000000000..98cc5554dd6f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListSecuritySettingsByCluster.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default", + "type": "Microsoft.AzureStackHCI/clusters/securitySettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "securedCoreComplianceAssignment": "Audit", + "wdacComplianceAssignment": "ApplyAndAutoCorrect", + "smbEncryptionForIntraClusterTrafficComplianceAssignment": "Audit", + "securityComplianceStatus": { + "securedCoreCompliance": "Compliant", + "wdacCompliance": "Compliant", + "dataAtRestEncrypted": "Compliant", + "dataInTransitProtected": "Compliant", + "lastUpdated": "2023-11-14T07:09:44.771Z" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListSkusByOffer.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListSkusByOffer.json new file mode 100644 index 000000000000..3ead1d5863b1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListSkusByOffer.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "offerName": "offer1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1/skus/sku1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers/skus", + "name": "sku1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "offerId": "offer1", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdateRuns.json new file mode 100644 index 000000000000..125373cb1b53 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdateRuns.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3", + "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3", + "type": "Microsoft.AzureStackHCI/updates/updateRuns", + "location": "West US", + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdateSummaries.json new file mode 100644 index 000000000000..ff8e46594a4b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdateSummaries.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/updateSummaries", + "location": "West US", + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "packageVersions": [ + { + "packageType": "OEM", + "version": "2.2.2108.6", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Services", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Infrastructure", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + } + ], + "currentVersion": "4.2203.2.32", + "state": "AppliedSuccessfully" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdates.json new file mode 100644 index 000000000000..2f97f4fbff1a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdates.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32", + "name": "Microsoft4.2203.2.32", + "type": " Microsoft. AzureStackHCI/updates", + "location": "West US", + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PatchArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PatchArcSetting.json new file mode 100644 index 000000000000..ac1cccbd5ae9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PatchArcSetting.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "arcSetting": { + "properties": { + "connectivityProperties": { + "enabled": true, + "serviceConfigurations": [ + { + "serviceName": "WAC", + "port": 6516 + } + ] + } + } + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "Creating", + "connectivityProperties": { + "enabled": true, + "serviceConfigurations": [ + { + "serviceName": "WAC", + "port": 6516 + } + ] + }, + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Creating" + } + ], + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + }, + { + "category": "Supportability", + "consentTime": null + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PatchExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PatchExtension.json new file mode 100644 index 000000000000..e09961569649 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PatchExtension.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "extension": { + "properties": { + "extensionParameters": { + "typeHandlerVersion": "1.10", + "enableAutomaticUpgrade": false, + "settings": { + "workspaceId": "xx" + }, + "protectedSettings": { + "workspaceKey": "xx" + } + } + } + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10", + "enableAutomaticUpgrade": false, + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallyConnected", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Connected", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Disconnected", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "User" + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PostUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PostUpdates.json new file mode 100644 index 000000000000..86fd36d89264 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PostUpdates.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2024-04-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutArcSetting.json new file mode 100644 index 000000000000..74b65a5ded3b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutArcSetting.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "arcSetting": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "Creating", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Creating" + } + ], + "connectivityProperties": { + "enabled": false, + "serviceConfigurations": [] + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutDeploymentSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutDeploymentSettings.json new file mode 100644 index 000000000000..809b81d78b78 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutDeploymentSettings.json @@ -0,0 +1,729 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "deploymentSettingsName": "default", + "api-version": "2024-04-01", + "resource": { + "properties": { + "operationType": "ClusterProvisioning", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5", + "storageAdapterIPInfo": [ + { + "physicalNode": "string", + "ipv4Address": "10.57.48.60", + "subnetMask": "255.255.248.0" + } + ] + } + ], + "storageConnectivitySwitchless": true, + "enableStorageAutoIp": false + }, + "sdnIntegration": { + "networkController": { + "macAddressPoolStart": "00-0D-3A-1B-C7-21", + "macAddressPoolStop": "00-0D-3A-1B-C7-29", + "networkVirtualizationEnabled": true + } + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "secrets": [ + { + "secretName": "cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "BMCAdminUserCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + }, + { + "secretName": "cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "AzureStackLCMUserCredential", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c" + } + ], + "optionalServices": { + "customLocation": "customLocationName" + } + }, + "sbePartnerInfo": { + "sbeDeploymentInfo": { + "version": "4.0.2309.13", + "family": "Gen5", + "publisher": "Contoso", + "sbeManifestSource": "default", + "sbeManifestCreationDate": "2023-07-25T02:40:33Z" + }, + "partnerProperties": [ + { + "name": "EnableBMCIpV6", + "value": "false" + }, + { + "name": "PhoneHomePort", + "value": "1653" + }, + { + "name": "BMCSecurityState", + "value": "HighSecurity" + } + ], + "credentialList": [ + { + "secretName": "cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "DownloadConnectorCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + } + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5", + "storageAdapterIPInfo": [ + { + "physicalNode": "string", + "ipv4Address": "10.57.48.60", + "subnetMask": "255.255.248.0" + } + ] + } + ], + "storageConnectivitySwitchless": true, + "enableStorageAutoIp": false + }, + "sdnIntegration": { + "networkController": { + "macAddressPoolStart": "00-0D-3A-1B-C7-21", + "macAddressPoolStop": "00-0D-3A-1B-C7-29", + "networkVirtualizationEnabled": true + } + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "secrets": [ + { + "secretName": "cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "BMCAdminUserCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + }, + { + "secretName": "cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "AzureStackLCMUserCredential", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c" + } + ], + "optionalServices": { + "customLocation": "customLocationName" + } + }, + "sbePartnerInfo": { + "sbeDeploymentInfo": { + "version": "4.0.2309.13", + "family": "Gen5", + "publisher": "Contoso", + "sbeManifestSource": "default", + "sbeManifestCreationDate": "2023-07-25T02:40:33Z" + }, + "partnerProperties": [ + { + "name": "EnableBMCIpV6", + "value": "false" + }, + { + "name": "PhoneHomePort", + "value": "1653" + }, + { + "name": "BMCSecurityState", + "value": "HighSecurity" + } + ], + "credentialList": [ + { + "secretName": "cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "DownloadConnectorCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + } + ] + } + } + ] + }, + "reportedProperties": { + "validationStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + } + ] + } + ] + }, + "deploymentStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": null, + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": null, + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + } + ] + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5", + "storageAdapterIPInfo": [ + { + "physicalNode": "string", + "ipv4Address": "10.57.48.60", + "subnetMask": "255.255.248.0" + } + ] + } + ], + "storageConnectivitySwitchless": true, + "enableStorageAutoIp": false + }, + "sdnIntegration": { + "networkController": { + "macAddressPoolStart": "00-0D-3A-1B-C7-21", + "macAddressPoolStop": "00-0D-3A-1B-C7-29", + "networkVirtualizationEnabled": true + } + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "secrets": [ + { + "secretName": "cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "BMCAdminUserCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + }, + { + "secretName": "cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "AzureStackLCMUserCredential", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c" + } + ], + "optionalServices": { + "customLocation": "customLocationName" + } + }, + "sbePartnerInfo": { + "sbeDeploymentInfo": { + "version": "4.0.2309.13", + "family": "Gen5", + "publisher": "Contoso", + "sbeManifestSource": "default", + "sbeManifestCreationDate": "2023-07-25T02:40:33Z" + }, + "partnerProperties": [ + { + "name": "EnableBMCIpV6", + "value": "false" + }, + { + "name": "PhoneHomePort", + "value": "1653" + }, + { + "name": "BMCSecurityState", + "value": "HighSecurity" + } + ], + "credentialList": [ + { + "secretName": "cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "DownloadConnectorCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + } + ] + } + } + ] + }, + "reportedProperties": { + "validationStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10" + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ] + } + ] + } + ] + }, + "deploymentStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + } + ] + } + ] + } + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutExtension.json new file mode 100644 index 000000000000..972a44ef4bc6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutExtension.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "extension": { + "properties": { + "extensionParameters": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "type": "MicrosoftMonitoringAgent", + "enableAutomaticUpgrade": false, + "settings": { + "workspaceId": "xx" + }, + "protectedSettings": { + "workspaceKey": "xx" + } + } + } + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "enableAutomaticUpgrade": false, + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "enableAutomaticUpgrade": false, + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "User" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutSecuritySettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutSecuritySettings.json new file mode 100644 index 000000000000..2f119926076e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutSecuritySettings.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "securitySettingsName": "default", + "api-version": "2024-04-01", + "resource": { + "properties": { + "securedCoreComplianceAssignment": "Audit", + "wdacComplianceAssignment": "ApplyAndAutoCorrect", + "smbEncryptionForIntraClusterTrafficComplianceAssignment": "Audit" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default", + "type": "Microsoft.AzureStackHCI/clusters/securitySettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "securedCoreComplianceAssignment": "Audit", + "wdacComplianceAssignment": "ApplyAndAutoCorrect", + "smbEncryptionForIntraClusterTrafficComplianceAssignment": "Audit", + "securityComplianceStatus": { + "securedCoreCompliance": "Compliant", + "wdacCompliance": "Compliant", + "dataAtRestEncrypted": "Compliant", + "dataInTransitProtected": "Compliant", + "lastUpdated": "2023-11-14T07:09:44.771Z" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default", + "type": "Microsoft.AzureStackHCI/clusters/securitySettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "securedCoreComplianceAssignment": "Audit", + "wdacComplianceAssignment": "ApplyAndAutoCorrect", + "smbEncryptionForIntraClusterTrafficComplianceAssignment": "Audit", + "securityComplianceStatus": { + "securedCoreCompliance": "Compliant", + "wdacCompliance": "Compliant", + "dataAtRestEncrypted": "Compliant", + "dataInTransitProtected": "Compliant", + "lastUpdated": "2023-11-14T07:09:44.771Z" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdateRuns.json new file mode 100644 index 000000000000..cc20c3a4ddb1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdateRuns.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3", + "api-version": "2024-04-01", + "updateRunsProperties": { + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3", + "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3", + "type": "Microsoft.AzureStackHCI/updates/updateRuns", + "location": "West US", + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdateSummaries.json new file mode 100644 index 000000000000..77510c72ccf2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdateSummaries.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2024-04-01", + "updateLocationProperties": { + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "lastChecked": "2022-04-07T18:04:07Z", + "currentVersion": "4.2203.2.32", + "lastUpdated": "2022-04-06T14:08:18.254Z", + "state": "AppliedSuccessfully" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/updateSummaries", + "location": "West US", + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "packageVersions": [ + { + "packageType": "OEM", + "version": "2.2.2108.6", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Services", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Infrastructure", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + } + ], + "currentVersion": "4.2203.2.32", + "state": "AppliedSuccessfully" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdates.json new file mode 100644 index 000000000000..7bfc2a7db950 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdates.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2024-04-01", + "updateProperties": { + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32", + "name": "Microsoft4.2203.2.32", + "type": "Microsoft.AzureStackHCI/updates", + "location": "West US", + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/TriggerLogCollection.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/TriggerLogCollection.json new file mode 100644 index 000000000000..d03e3de6d2f7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/TriggerLogCollection.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "mycluster", + "api-version": "2024-04-01", + "logCollectionRequest": { + "properties": { + "fromDate": "2020-01-01T17:18:19.1234567Z", + "toDate": "2021-01-01T17:18:19.1234567Z" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "logCollectionProperties": { + "fromDate": "2020-01-01T17:18:19.1234567Z", + "toDate": "2021-01-01T17:18:19.1234567Z", + "lastLogGenerated": "2020-01-01T17:18:19.1234567Z", + "logCollectionSessionDetails": [ + { + "logStartTime": "2020-01-01T17:18:19.1234567Z", + "logEndTime": "2020-01-01T17:18:19.1234567Z", + "timeCollected": "2020-01-01T17:18:19.1234567Z", + "logSize": 1000, + "logCollectionStatus": "Succeeded", + "logCollectionJobType": "OnDemand", + "correlationId": "a76ab33a-1819-4e82-1212-e3e4ec3d1425", + "endTimeCollected": "2020-01-01T17:25:19.1234567Z" + } + ] + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "nodeType": "ThirdParty", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/UpdateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/UpdateCluster.json new file mode 100644 index 000000000000..67d4e6c28100 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/UpdateCluster.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-04-01", + "cluster": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "identity": { + "principalId": "87a834db-2e45-409e-911b-e16a44562ec3", + "tenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "connectivityStatus": "Connected", + "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "isolatedVmAttestationConfiguration": { + "attestationResourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/testmaa", + "relyingPartyServiceEndpoint": "https://azurestackhci.azurefd.net/eastus", + "attestationServiceEndpoint": "https://dantestnoauth01.eus.attest.azure.net" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "clusterType": "ThirdParty", + "manufacturer": "Dell Inc.", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + }, + { + "name": "Node2", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + }, + { + "name": "Node3", + "id": 3, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/UploadCertificate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/UploadCertificate.json new file mode 100644 index 000000000000..d692e2aba2b5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/UploadCertificate.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-04-01", + "uploadCertificateRequest": { + "properties": { + "certificates": [ + "base64cert", + "base64cert" + ] + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ValidateEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ValidateEdgeDevices.json new file mode 100644 index 000000000000..50f99fda89c4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ValidateEdgeDevices.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2024-04-01", + "ValidateRequest": { + "edgeDeviceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/edgeDevices/default", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/edgeDevices/default" + ], + "additionalInfo": "test" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "200": { + "body": { + "status": "success" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/extensions.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/extensions.json new file mode 100644 index 000000000000..19785514d95f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/extensions.json @@ -0,0 +1,707 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions": { + "get": { + "operationId": "Extensions_ListByArcSetting", + "description": "List all Extensions under ArcSetting resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExtensionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Extensions under ArcSetting resource": { + "$ref": "./examples/ListExtensionsByArcSetting.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}": { + "get": { + "operationId": "Extensions_Get", + "description": "Get particular Arc Extension of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ArcSettings Extension": { + "$ref": "./examples/GetExtension.json" + } + } + }, + "put": { + "operationId": "Extensions_Create", + "description": "Create Extension for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "name": "extension", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Extension" + }, + "description": "Details of the Machine Extension to be created." + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/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 Arc Extension": { + "$ref": "./examples/PutExtension.json" + } + } + }, + "patch": { + "operationId": "Extensions_Update", + "description": "Update Extension for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "name": "extension", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExtensionPatch" + }, + "description": "Details of the Machine Extension to be created." + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "Update Arc Extension": { + "$ref": "./examples/PatchExtension.json" + } + } + }, + "delete": { + "operationId": "Extensions_Delete", + "description": "Delete particular Arc Extension of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "OK" + }, + "204": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/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": { + "Delete Arc Extension": { + "$ref": "./examples/DeleteExtension.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}/upgrade": { + "post": { + "operationId": "Extensions_Upgrade", + "description": "Upgrade a particular Arc Extension of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "name": "extensionUpgradeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExtensionUpgradeParameters" + }, + "description": "Parameters supplied to the Upgrade Extensions operation." + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/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": { + "Upgrade Machine Extensions": { + "$ref": "./examples/Extensions_Upgrade.json" + } + } + } + } + }, + "definitions": { + "Extension": { + "description": "Details of a particular extension in HCI Cluster.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Describes Machine Extension Properties.", + "$ref": "#/definitions/ExtensionProperties", + "x-ms-client-flatten": true + } + } + }, + "ExtensionPatch": { + "description": "Extension Details to update", + "type": "object", + "properties": { + "properties": { + "description": "Describes Machine Extension Properties that can be updated.", + "$ref": "#/definitions/ExtensionPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ExtensionProperties": { + "description": "Status of Arc Extension for a particular node in HCI Cluster.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Extension proxy resource.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Failed", + "Canceled", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "extensionParameters": { + "description": "Parameters specific to this extension type.", + "$ref": "#/definitions/ExtensionParameters", + "x-ms-client-flatten": true + }, + "aggregateState": { + "description": "Aggregate state of Arc Extensions across the nodes in this HCI cluster.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "UpgradeFailedRollbackSucceeded" + ], + "x-ms-enum": { + "name": "ExtensionAggregateState", + "modelAsString": true + }, + "readOnly": true + }, + "perNodeExtensionDetails": { + "description": "State of Arc Extension in each of the nodes.", + "type": "array", + "items": { + "$ref": "#/definitions/PerNodeExtensionState" + }, + "readOnly": true + }, + "managedBy": { + "description": "Indicates if the extension is managed by azure or the user.", + "type": "string", + "enum": [ + "Azure", + "User" + ], + "x-ms-enum": { + "name": "ExtensionManagedBy", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "ExtensionPatchProperties": { + "description": "Describes Machine Extension Properties that can be updated.", + "type": "object", + "properties": { + "extensionParameters": { + "description": "Describes the properties of a Machine Extension that can be updated.", + "$ref": "#/definitions/ExtensionPatchParameters" + } + } + }, + "ExtensionPatchParameters": { + "description": "Describes the properties of a Machine Extension that can be updated.", + "type": "object", + "properties": { + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler. Latest version would be used if not specified." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings (may contain secrets).", + "x-ms-secret": true + } + } + }, + "PerNodeExtensionState": { + "description": "Status of Arc Extension for a particular node in HCI Cluster.", + "type": "object", + "properties": { + "name": { + "description": "Name of the node in HCI Cluster.", + "type": "string", + "readOnly": true + }, + "extension": { + "description": "Fully qualified resource ID for the particular Arc Extension on this node.", + "type": "string", + "readOnly": true + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler.", + "readOnly": true + }, + "state": { + "description": "State of Arc Extension in this node.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "NodeExtensionState", + "modelAsString": true + }, + "readOnly": true + }, + "instanceView": { + "$ref": "#/definitions/ExtensionInstanceView", + "description": "The extension instance view.", + "readOnly": true + } + } + }, + "ExtensionList": { + "description": "List of Extensions in HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of Extensions in HCI cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/Extension" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ExtensionParameters": { + "description": "Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute.", + "type": "object", + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "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. Latest version would be used if not specified." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings (may contain secrets).", + "x-ms-secret": true + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." + } + } + }, + "ExtensionInstanceView": { + "type": "object", + "description": "Describes the Extension Instance View.", + "properties": { + "name": { + "type": "string", + "description": "The extension name." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"MicrosoftMonitoringAgent\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "status": { + "type": "object", + "description": "Instance view status.", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + } + } + } + }, + "ExtensionUpgradeParameters": { + "type": "object", + "description": "Describes the parameters for Extension upgrade.", + "properties": { + "targetVersion": { + "type": "string", + "description": "Extension Upgrade Target Version." + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ArcSettingNameParameter": { + "name": "arcSettingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proxy resource holding details of HCI ArcSetting information.", + "x-ms-parameter-location": "method" + }, + "ExtensionNameParameter": { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/hciCommon.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/hciCommon.json new file mode 100644 index 000000000000..34c37faa08a0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/hciCommon.json @@ -0,0 +1,367 @@ +{ + "swagger": "2.0", + "info": { + "title": "AzureStackHCI Common", + "version": "2024-04-01", + "description": "Azure Stack HCI common Rest API spec definitions." + }, + "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": [], + "paths": {}, + "definitions": { + "DeploymentMode": { + "type": "string", + "description": "The deployment mode of EnterpriseCloudEngine(ECE) action for a cluster.", + "enum": [ + "Validate", + "Deploy" + ], + "default": "Deploy", + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": true, + "values": [ + { + "name": "Validate", + "value": "Validate", + "description": "Validate ECE action deployment for a cluster." + }, + { + "name": "Deploy", + "value": "Deploy", + "description": "Deploy ECE action deployment for a cluster." + } + ] + } + }, + "EceReportedProperties": { + "type": "object", + "description": "The DeploymentStatus of AzureStackHCI Cluster.", + "properties": { + "validationStatus": { + "$ref": "#/definitions/EceActionStatus", + "description": "validation status of AzureStackHCI Cluster Deployment.", + "readOnly": true + }, + "deploymentStatus": { + "$ref": "#/definitions/EceActionStatus", + "description": "Deployment status of AzureStackHCI Cluster Deployment.", + "readOnly": true + } + } + }, + "EceActionStatus": { + "type": "object", + "description": "The ECE action plan deployment status for AzureStackHCI Cluster.", + "properties": { + "status": { + "type": "string", + "description": "Status of ECE action AzureStackHCI Cluster Deployment.", + "readOnly": true + }, + "steps": { + "type": "array", + "description": "List of steps of AzureStackHCI Cluster Deployment.", + "items": { + "$ref": "#/definitions/DeploymentStep" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "NotSpecified", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "readOnly": true, + "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": "NotSpecified", + "value": "NotSpecified", + "description": "The resource provision state is not specified" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + } + }, + "EceDeploymentSecrets": { + "type": "object", + "description": "Protected parameters list stored in keyvault.", + "properties": { + "secretName": { + "type": "string", + "description": "Secret name stored in keyvault." + }, + "eceSecretName": { + "$ref": "#/definitions/EceSecrets", + "description": "Secret name expected for Enterprise Cloud Engine (ECE) deployment." + }, + "secretLocation": { + "type": "string", + "format": "uri", + "description": "Secret URI stored in keyvault." + } + } + }, + "EceSecrets": { + "type": "string", + "description": "Secret names allowed for Enterprise Cloud Engine (ECE) deployment.", + "enum": [ + "AzureStackLCMUserCredential", + "DefaultARBApplication", + "LocalAdminCredential", + "WitnessStorageKey" + ], + "x-ms-enum": { + "name": "EceSecrets", + "modelAsString": true, + "values": [ + { + "name": "AzureStackLCMUserCredential", + "value": "AzureStackLCMUserCredential", + "description": "AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster." + }, + { + "name": "DefaultARBApplication", + "value": "DefaultARBApplication", + "description": "DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster." + }, + { + "name": "LocalAdminCredential", + "value": "LocalAdminCredential", + "description": "LocalAdminCredential used for admin operations for AzureStackHCI cluster." + }, + { + "name": "WitnessStorageKey", + "value": "WitnessStorageKey", + "description": "WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster." + } + ] + } + }, + "DeploymentStep": { + "type": "object", + "description": "The Step of AzureStackHCI Cluster.", + "properties": { + "name": { + "type": "string", + "description": "Name of step.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of step.", + "readOnly": true + }, + "fullStepIndex": { + "type": "string", + "description": "FullStepIndex of step.", + "readOnly": true + }, + "startTimeUtc": { + "type": "string", + "description": "Start time of step.", + "readOnly": true + }, + "endTimeUtc": { + "type": "string", + "description": "End time of step.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Status of step. Allowed values are 'Error', 'Success', 'InProgress'", + "readOnly": true + }, + "steps": { + "type": "array", + "description": "List of nested steps of AzureStackHCI Cluster Deployment.", + "items": { + "$ref": "#/definitions/DeploymentStep" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "exception": { + "type": "array", + "description": "List of exceptions in AzureStackHCI Cluster Deployment.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "PrecheckResult": { + "type": "object", + "properties": { + "name": { + "description": "Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer.", + "type": "string" + }, + "displayName": { + "description": "The health check DisplayName localized of the individual test executed.", + "type": "string" + }, + "tags": { + "description": "Key-value pairs that allow grouping/filtering individual tests.", + "type": "object", + "properties": { + "key": { + "description": "Key that allow grouping/filtering individual tests.", + "type": "string" + }, + "value": { + "description": "Value of the key that allow grouping/filtering individual tests.", + "type": "string" + } + } + }, + "healthCheckTags": { + "description": "Key-value pairs that allow grouping/filtering individual tests.", + "type": "object" + }, + "title": { + "description": "User-facing name; one or more sentences indicating the direct issue.", + "type": "string" + }, + "status": { + "description": "The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "severity": { + "description": "Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity.", + "type": "string", + "enum": [ + "Critical", + "Warning", + "Informational", + "Hidden" + ], + "x-ms-enum": { + "name": "severity", + "modelAsString": true + } + }, + "description": { + "description": "Detailed overview of the issue and what impact the issue has on the stamp.", + "type": "string" + }, + "remediation": { + "description": "Set of steps that can be taken to resolve the issue found.", + "type": "string" + }, + "targetResourceID": { + "description": "The unique identifier for the affected resource (such as a node or drive).", + "type": "string" + }, + "targetResourceName": { + "description": "The name of the affected resource.", + "type": "string" + }, + "targetResourceType": { + "description": "The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring).", + "type": "string" + }, + "timestamp": { + "description": "The time in which the HealthCheck was called.", + "type": "string", + "format": "date-time" + }, + "additionalData": { + "description": "Property bag of key value pairs for additional information.", + "type": "string" + }, + "healthCheckSource": { + "description": "The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster).", + "type": "string" + } + } + } + }, + "parameters": {} +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/offers.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/offers.json new file mode 100644 index 000000000000..625d8cc75503 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/offers.json @@ -0,0 +1,302 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers": { + "get": { + "operationId": "Offers_ListByPublisher", + "description": "List Offers available for a publisher within the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Offer resources by publisher for the HCI Cluster": { + "$ref": "./examples/ListOffersByPublisher.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/offers": { + "get": { + "operationId": "Offers_ListByCluster", + "description": "List Offers available across publishers for the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Offer resources by HCI Cluster": { + "$ref": "./examples/ListOffersByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}": { + "get": { + "operationId": "Offers_Get", + "description": "Get Offer resource details within a publisher of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "#/parameters/OfferNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Offer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Offer": { + "$ref": "./examples/GetOffer.json" + } + } + } + } + }, + "definitions": { + "OfferList": { + "description": "List of Offer proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of Offer proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Offer" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Offer": { + "description": "Offer details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Offer properties.", + "$ref": "#/definitions/OfferProperties", + "x-ms-client-flatten": true + } + } + }, + "OfferProperties": { + "description": "Publisher properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State", + "type": "string", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Identifier of the Publisher for the offer" + }, + "content": { + "type": "string", + "description": "JSON serialized catalog content of the offer" + }, + "contentVersion": { + "type": "string", + "description": "The API version of the catalog service used to serve the catalog content" + }, + "skuMappings": { + "type": "array", + "description": "Array of SKU mappings", + "items": { + "$ref": "#/definitions/SkuMappings" + }, + "x-ms-identifiers": [] + } + } + }, + "SkuMappings": { + "description": "SKU Mapping details.", + "type": "object", + "properties": { + "catalogPlanId": { + "type": "string", + "description": "Identifier of the CatalogPlan for the sku" + }, + "marketplaceSkuId": { + "type": "string", + "description": "Identifier for the sku" + }, + "marketplaceSkuVersions": { + "type": "array", + "description": "Array of SKU versions available", + "items": { + "type": "string" + } + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the publisher available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "OfferNameParameter": { + "name": "offerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the offer available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "ODataExpandParameter": { + "name": "$expand", + "in": "query", + "description": "Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/publishers.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/publishers.json new file mode 100644 index 000000000000..8d9d8c910e64 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/publishers.json @@ -0,0 +1,188 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/publishers": { + "get": { + "operationId": "Publishers_ListByCluster", + "description": "List Publishers available for the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublisherList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Publisher resources by HCI Cluster": { + "$ref": "./examples/ListPublishersByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}": { + "get": { + "operationId": "Publishers_Get", + "description": "Get Publisher resource details of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Publisher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Publisher": { + "$ref": "./examples/GetPublisher.json" + } + } + } + } + }, + "definitions": { + "PublisherList": { + "description": "List of Publisher proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of Publisher proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Publisher" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Publisher": { + "description": "Publisher details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Publisher properties.", + "$ref": "#/definitions/PublisherProperties", + "x-ms-client-flatten": true + } + } + }, + "PublisherProperties": { + "description": "Publisher properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the publisher available within HCI cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/securitySettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/securitySettings.json new file mode 100644 index 000000000000..9aa0e1f57b62 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/securitySettings.json @@ -0,0 +1,502 @@ +{ + "swagger": "2.0", + "info": { + "title": "AzureStackHCI", + "version": "2024-04-01", + "description": "Azure Stack HCI cluster security settings." + }, + "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": "SecuritySettings" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings": { + "get": { + "operationId": "SecuritySettings_ListByClusters", + "tags": [ + "SecuritySettings" + ], + "description": "List SecuritySetting resources by Clusters", + "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": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecuritySettingListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Security Settings": { + "$ref": "./examples/ListSecuritySettingsByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings/{securitySettingsName}": { + "get": { + "operationId": "SecuritySettings_Get", + "tags": [ + "SecuritySettings" + ], + "description": "Get a SecuritySetting", + "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": "#/parameters/ClusterNameParameter" + }, + { + "name": "securitySettingsName", + "in": "path", + "description": "Name of security setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecuritySetting" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Security Settings": { + "$ref": "./examples/GetSecuritySettings.json" + } + } + }, + "put": { + "operationId": "SecuritySettings_CreateOrUpdate", + "tags": [ + "SecuritySettings" + ], + "description": "Create a security setting", + "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": "#/parameters/ClusterNameParameter" + }, + { + "name": "securitySettingsName", + "in": "path", + "description": "Name of security setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SecuritySetting" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SecuritySetting' update operation succeeded", + "schema": { + "$ref": "#/definitions/SecuritySetting" + } + }, + "201": { + "description": "Resource 'SecuritySetting' create operation succeeded", + "schema": { + "$ref": "#/definitions/SecuritySetting" + }, + "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 Security Settings": { + "$ref": "./examples/PutSecuritySettings.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SecuritySettings_Delete", + "tags": [ + "SecuritySettings" + ], + "description": "Delete a SecuritySetting", + "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": "#/parameters/ClusterNameParameter" + }, + { + "name": "securitySettingsName", + "in": "path", + "description": "Name of security setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion 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." + } + } + }, + "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": { + "Delete Security Settings": { + "$ref": "./examples/DeleteSecuritySettings.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ComplianceAssignmentType": { + "type": "string", + "description": "Represents the compliance assignment type of a resource.", + "enum": [ + "Audit", + "ApplyAndAutoCorrect" + ], + "x-ms-enum": { + "name": "ComplianceAssignmentType", + "modelAsString": true, + "values": [ + { + "name": "Audit", + "value": "Audit", + "description": "Report on the state of the machine, but don't make changes." + }, + { + "name": "ApplyAndAutoCorrect", + "value": "ApplyAndAutoCorrect", + "description": "Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation." + } + ] + } + }, + "ComplianceStatus": { + "type": "string", + "description": "Represents the compliance status of a resource.", + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ], + "x-ms-enum": { + "name": "ComplianceStatus", + "modelAsString": true, + "values": [ + { + "name": "Compliant", + "value": "Compliant", + "description": "The resource is compliant" + }, + { + "name": "NonCompliant", + "value": "NonCompliant", + "description": "The resource is non-compliant" + }, + { + "name": "Pending", + "value": "Pending", + "description": "The resource compliance status is pending" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource.", + "readOnly": true, + "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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + } + }, + "SecurityComplianceStatus": { + "type": "object", + "description": "Security compliance properties of the resource", + "properties": { + "securedCoreCompliance": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Indicates whether HCI hosts meets secured-core server requirements.", + "readOnly": true + }, + "wdacCompliance": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Indicates whether HCI hosts have enforced consistent Windows Defender Application Control.", + "readOnly": true + }, + "dataAtRestEncrypted": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes.", + "readOnly": true + }, + "dataInTransitProtected": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Indicates whether HCI cluster has data in-transit protection.", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "Time in UTC when compliance status was last updated.", + "readOnly": true + } + } + }, + "SecurityProperties": { + "type": "object", + "description": "Security properties of the resource", + "properties": { + "securedCoreComplianceAssignment": { + "$ref": "#/definitions/ComplianceAssignmentType", + "description": "Secured Core Compliance Assignment", + "default": "Audit" + }, + "wdacComplianceAssignment": { + "$ref": "#/definitions/ComplianceAssignmentType", + "description": "WDAC Compliance Assignment", + "default": "Audit" + }, + "smbEncryptionForIntraClusterTrafficComplianceAssignment": { + "$ref": "#/definitions/ComplianceAssignmentType", + "description": "SMB encryption for intra-cluster traffic Compliance Assignment", + "default": "Audit" + }, + "securityComplianceStatus": { + "$ref": "#/definitions/SecurityComplianceStatus", + "description": "Security Compliance Status", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "SecuritySetting": { + "type": "object", + "description": "Security settings proxy resource", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityProperties", + "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" + } + ] + }, + "SecuritySettingListResult": { + "type": "object", + "description": "The response of a SecuritySetting list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SecuritySetting items on this page", + "items": { + "$ref": "#/definitions/SecuritySetting" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/skus.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/skus.json new file mode 100644 index 000000000000..52b4b78a094e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/skus.json @@ -0,0 +1,275 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus": { + "get": { + "operationId": "Skus_ListByOffer", + "description": "List Skus available for a offer within the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "#/parameters/OfferNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List SKU resources by offer for the HCI Cluster": { + "$ref": "./examples/ListSkusByOffer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}": { + "get": { + "operationId": "Skus_Get", + "description": "Get SKU resource details within a offer of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "#/parameters/OfferNameParameter" + }, + { + "$ref": "#/parameters/SkuNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Sku" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Sku": { + "$ref": "./examples/GetSku.json" + } + } + } + } + }, + "definitions": { + "SkuList": { + "description": "List of SKU proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of SKU proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Sku" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Sku": { + "description": "Sku details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SKU properties.", + "$ref": "#/definitions/SkuProperties", + "x-ms-client-flatten": true + } + } + }, + "SkuProperties": { + "description": "SKU properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State", + "type": "string", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Identifier of the Publisher for the offer" + }, + "offerId": { + "type": "string", + "description": "Identifier of the Offer for the sku" + }, + "content": { + "type": "string", + "description": "JSON serialized catalog content of the sku offer" + }, + "contentVersion": { + "type": "string", + "description": "The API version of the catalog service used to serve the catalog content" + }, + "skuMappings": { + "type": "array", + "description": "Array of SKU mappings", + "items": { + "$ref": "#/definitions/SkuMappings" + }, + "x-ms-identifiers": [] + } + } + }, + "SkuMappings": { + "description": "SKU Mapping details.", + "type": "object", + "properties": { + "catalogPlanId": { + "type": "string", + "description": "Identifier of the CatalogPlan for the sku" + }, + "marketplaceSkuId": { + "type": "string", + "description": "Identifier for the sku" + }, + "marketplaceSkuVersions": { + "type": "array", + "description": "Array of SKU versions available", + "items": { + "type": "string" + } + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the publisher available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "OfferNameParameter": { + "name": "offerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the offer available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "SkuNameParameter": { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SKU available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "ODataExpandParameter": { + "name": "$expand", + "in": "query", + "description": "Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/updateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/updateRuns.json new file mode 100644 index 000000000000..8fd1968a9c61 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/updateRuns.json @@ -0,0 +1,412 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns": { + "get": { + "operationId": "UpdateRuns_List", + "description": "List all Update runs for a specified update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateRunList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Update runs under cluster resource": { + "$ref": "./examples/ListUpdateRuns.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}": { + "delete": { + "operationId": "UpdateRuns_Delete", + "description": "Delete specified Update Run", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateRunNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/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": { + "Delete an Update": { + "$ref": "./examples/DeleteUpdateRuns.json" + } + } + }, + "put": { + "operationId": "UpdateRuns_Put", + "description": "Put Update runs for a specified update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateRunNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateRunsProperties", + "in": "body", + "description": "Properties of the updateRuns object", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateRun" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update runs under cluster resource": { + "$ref": "./examples/PutUpdateRuns.json" + } + } + }, + "get": { + "operationId": "UpdateRuns_Get", + "description": "Get the Update run for a specified update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateRunNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update runs under cluster resource": { + "$ref": "./examples/GetUpdateRuns.json" + } + } + } + } + }, + "definitions": { + "UpdateRunList": { + "description": "List of Update runs", + "type": "object", + "properties": { + "value": { + "description": "List of Update runs", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateRun" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateRun": { + "description": "Details of an Update run", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "description": "Describes Update Run Properties.", + "$ref": "#/definitions/UpdateRunProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateRunProperties": { + "description": "Details of an Update run", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the UpdateRuns proxy resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "timeStarted": { + "description": "Timestamp of the update run was started.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedTime": { + "description": "Timestamp of the most recently completed step in the update run.", + "type": "string", + "format": "date-time" + }, + "duration": { + "description": "Duration of the update run.", + "type": "string" + }, + "state": { + "description": "State of the update run.", + "type": "string", + "enum": [ + "Unknown", + "Succeeded", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "name": "updateRunPropertiesState", + "modelAsString": true + } + }, + "progress": { + "description": "Progress representation of the update run steps.", + "$ref": "#/definitions/Step", + "x-ms-client-flatten": true + } + } + }, + "Step": { + "description": "Progress representation of the update run steps.", + "type": "object", + "properties": { + "name": { + "description": "Name of the step.", + "type": "string" + }, + "description": { + "description": "More detailed description of the step.", + "type": "string" + }, + "errorMessage": { + "description": "Error message, specified if the step is in a failed state.", + "type": "string" + }, + "status": { + "description": "Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.", + "type": "string" + }, + "startTimeUtc": { + "description": "When the step started, or empty if it has not started executing.", + "type": "string", + "format": "date-time" + }, + "endTimeUtc": { + "description": "When the step reached a terminal state.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedTimeUtc": { + "description": "Completion time of this step or the last completed sub-step.", + "type": "string", + "format": "date-time" + }, + "expectedExecutionTime": { + "description": "Expected execution time of a given step. This is optionally authored in the update action plan and can be empty.", + "type": "string" + }, + "steps": { + "description": "Recursive model for child steps of this step.", + "type": "array", + "items": { + "$ref": "#/definitions/Step" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "UpdateNameParameter": { + "name": "updateName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Update", + "x-ms-parameter-location": "method" + }, + "UpdateRunNameParameter": { + "name": "updateRunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Update Run", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/updateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/updateSummaries.json new file mode 100644 index 000000000000..c928efca442f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/updateSummaries.json @@ -0,0 +1,408 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/updateSummaries": { + "get": { + "operationId": "UpdateSummaries_List", + "description": "List all Update summaries under the HCI cluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateSummariesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update summaries under cluster resource": { + "$ref": "./examples/ListUpdateSummaries.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries/default": { + "delete": { + "operationId": "UpdateSummaries_Delete", + "description": "Delete Update Summaries", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/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": { + "Delete an Update": { + "$ref": "./examples/DeleteUpdateSummaries.json" + } + } + }, + "put": { + "operationId": "UpdateSummaries_Put", + "description": "Put Update summaries under the HCI cluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateLocationProperties", + "in": "body", + "description": "Properties of the UpdateSummaries resource", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateSummaries" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateSummaries" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put Update summaries under cluster resource": { + "$ref": "./examples/PutUpdateSummaries.json" + } + } + }, + "get": { + "operationId": "UpdateSummaries_Get", + "description": "Get all Update summaries under the HCI cluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateSummaries" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update summaries under cluster resource": { + "$ref": "./examples/GetUpdateSummaries.json" + } + } + } + } + }, + "definitions": { + "UpdateSummariesList": { + "description": "List of Update Summaries", + "type": "object", + "properties": { + "value": { + "description": "List of Update Summaries", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateSummaries" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateSummaries": { + "description": "Get the update summaries for the cluster", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "description": "Update summaries properties", + "type": "object", + "$ref": "#/definitions/UpdateSummariesProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateSummariesProperties": { + "description": "Properties of Update summaries", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the UpdateSummaries proxy resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "oemFamily": { + "description": "OEM family name.", + "type": "string" + }, + "currentOemVersion": { + "description": "Current OEM Version.", + "type": "string" + }, + "hardwareModel": { + "description": "Name of the hardware model.", + "type": "string" + }, + "packageVersions": { + "description": "Current version of each updatable component.", + "type": "array", + "items": { + "$ref": "#/definitions/PackageVersionInfo" + }, + "x-ms-client-flatten": true, + "x-ms-identifiers": [ + "version" + ] + }, + "currentVersion": { + "description": "Current Solution Bundle version of the stamp.", + "type": "string" + }, + "currentSbeVersion": { + "description": "Current Sbe version of the stamp.", + "type": "string" + }, + "lastUpdated": { + "description": "Last time an update installation completed successfully.", + "type": "string", + "format": "date-time" + }, + "lastChecked": { + "description": "Last time the update service successfully checked for updates", + "type": "string", + "format": "date-time" + }, + "healthState": { + "description": "Overall health state for update-specific health checks.", + "type": "object", + "$ref": "#/definitions/HealthState", + "x-ms-client-flatten": true + }, + "healthCheckResult": { + "description": "An array of pre-check result objects.", + "type": "array", + "items": { + "$ref": "./hciCommon.json#/definitions/PrecheckResult" + }, + "x-ms-client-flatten": true, + "x-ms-identifiers": [ + "name" + ] + }, + "healthCheckDate": { + "description": "Last time the package-specific checks were run.", + "type": "string", + "format": "date-time" + }, + "state": { + "description": "Overall update state of the stamp.", + "type": "string", + "enum": [ + "Unknown", + "AppliedSuccessfully", + "UpdateAvailable", + "UpdateInProgress", + "UpdateFailed", + "NeedsAttention", + "PreparationInProgress", + "PreparationFailed" + ], + "x-ms-enum": { + "name": "updateSummariesPropertiesState", + "modelAsString": true + } + } + } + }, + "PackageVersionInfo": { + "description": "Current version of each updatable component.", + "type": "object", + "properties": { + "packageType": { + "description": "Package type", + "type": "string" + }, + "version": { + "description": "Package version", + "type": "string" + }, + "lastUpdated": { + "description": "Last time this component was updated.", + "type": "string", + "format": "date-time" + } + } + }, + "HealthState": { + "type": "string", + "enum": [ + "Unknown", + "Success", + "Failure", + "Warning", + "Error", + "InProgress" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/updates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/updates.json new file mode 100644 index 000000000000..785d0732d5a4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/updates.json @@ -0,0 +1,577 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/apply": { + "post": { + "operationId": "Updates_Post", + "description": "Apply Update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List available updates": { + "$ref": "./examples/PostUpdates.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.AzureStackHCI/clusters/{clusterName}/updates": { + "get": { + "operationId": "Updates_List", + "description": "List all Updates", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List available updates": { + "$ref": "./examples/ListUpdates.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}": { + "delete": { + "operationId": "Updates_Delete", + "description": "Delete specified Update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/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": { + "Delete an Update": { + "$ref": "./examples/DeleteUpdates.json" + } + } + }, + "put": { + "operationId": "Updates_Put", + "description": "Put specified Update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateProperties", + "in": "body", + "description": "Properties of the Updates object", + "required": true, + "schema": { + "$ref": "#/definitions/Update" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Update" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put a specific update": { + "$ref": "./examples/PutUpdates.json" + } + } + }, + "get": { + "operationId": "Updates_Get", + "description": "Get specified Update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Update" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a specific update": { + "$ref": "./examples/GetUpdates.json" + } + } + } + } + }, + "definitions": { + "UpdateList": { + "description": "List of Updates", + "type": "object", + "properties": { + "value": { + "description": "List of Updates", + "type": "array", + "items": { + "$ref": "#/definitions/Update" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdatePrerequisite": { + "description": "If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.", + "type": "object", + "properties": { + "updateType": { + "description": "Updatable component type.", + "type": "string" + }, + "version": { + "description": "Version of the prerequisite.", + "type": "string" + }, + "packageName": { + "description": "Friendly name of the prerequisite.", + "type": "string" + } + } + }, + "Update": { + "description": "Update details", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "description": "Update properties", + "type": "object", + "$ref": "#/definitions/UpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateProperties": { + "description": "Details of a singular Update in HCI Cluster", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Updates proxy resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "installedDate": { + "description": "Date that the update was installed.", + "type": "string", + "format": "date-time" + }, + "description": { + "description": "Description of the update.", + "type": "string" + }, + "minSbeVersionRequired": { + "description": "Minimum Sbe Version of the update.", + "type": "string" + }, + "state": { + "description": "State of the update as it relates to this stamp.", + "type": "string", + "enum": [ + "HasPrerequisite", + "Obsolete", + "Ready", + "NotApplicableBecauseAnotherUpdateIsInProgress", + "Preparing", + "Installing", + "Installed", + "PreparationFailed", + "InstallationFailed", + "Invalid", + "Recalled", + "Downloading", + "DownloadFailed", + "HealthChecking", + "HealthCheckFailed", + "ReadyToInstall", + "ScanInProgress", + "ScanFailed", + "AdditionalContentRequired" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "prerequisites": { + "description": "If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.", + "type": "array", + "items": { + "$ref": "#/definitions/UpdatePrerequisite" + }, + "x-ms-identifiers": [ + "packageName" + ] + }, + "componentVersions": { + "description": "An array of component versions for a Solution Bundle update, and an empty array otherwise. ", + "type": "array", + "items": { + "$ref": "#/definitions/PackageVersionInfo" + }, + "x-ms-client-flatten": true, + "x-ms-identifiers": [ + "version" + ] + }, + "rebootRequired": { + "type": "object", + "$ref": "#/definitions/RebootRequirement", + "x-ms-client-flatten": true + }, + "healthState": { + "description": "Overall health state for update-specific health checks.", + "type": "object", + "$ref": "#/definitions/HealthState", + "x-ms-client-flatten": true + }, + "healthCheckResult": { + "description": "An array of PrecheckResult objects.", + "type": "array", + "items": { + "$ref": "./hciCommon.json#/definitions/PrecheckResult" + }, + "x-ms-client-flatten": true + }, + "healthCheckDate": { + "description": "Last time the package-specific checks were run.", + "type": "string", + "format": "date-time" + }, + "packagePath": { + "description": "Path where the update package is available.", + "type": "string" + }, + "packageSizeInMb": { + "description": "Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.", + "type": "number" + }, + "displayName": { + "description": "Display name of the Update", + "type": "string" + }, + "version": { + "description": "Version of the update.", + "type": "string" + }, + "publisher": { + "description": "Publisher of the update package.", + "type": "string" + }, + "releaseLink": { + "description": "Link to release notes for the update.", + "type": "string" + }, + "availabilityType": { + "description": "Indicates the way the update content can be downloaded.", + "type": "string", + "enum": [ + "Local", + "Online", + "Notify" + ], + "x-ms-enum": { + "name": "availabilityType", + "modelAsString": true + } + }, + "packageType": { + "description": "Customer-visible type of the update.", + "type": "string" + }, + "additionalProperties": { + "description": "Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.", + "type": "string" + }, + "updateStateProperties": { + "description": "Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.", + "type": "object", + "$ref": "#/definitions/UpdateStateProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateStateProperties": { + "description": "Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.", + "type": "object", + "properties": { + "progressPercentage": { + "description": "Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.", + "type": "number" + }, + "notifyMessage": { + "description": "Brief message with instructions for updates of AvailabilityType Notify.", + "type": "string" + } + } + }, + "PackageVersionInfo": { + "description": "Current version of each updatable component.", + "type": "object", + "properties": { + "packageType": { + "description": "Package type", + "type": "string" + }, + "version": { + "description": "Package version", + "type": "string" + }, + "lastUpdated": { + "description": "Last time this component was updated.", + "type": "string", + "format": "date-time" + } + } + }, + "RebootRequirement": { + "type": "string", + "enum": [ + "Unknown", + "True", + "False" + ], + "x-ms-enum": { + "name": "RebootRequirement", + "modelAsString": true + } + }, + "HealthState": { + "type": "string", + "enum": [ + "Unknown", + "Success", + "Failure", + "Warning", + "Error", + "InProgress" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "UpdateNameParameter": { + "name": "updateName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Update", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/stable/2024-04-01/examples/ListOperations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/stable/2024-04-01/examples/ListOperations.json new file mode 100644 index 000000000000..701b440ef6de --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/stable/2024-04-01/examples/ListOperations.json @@ -0,0 +1,453 @@ +{ + "parameters": { + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureStackHCI/Register/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Register", + "operation": "Registers the Azure Stack HCI Resource Provider", + "description": "Registers the subscription for the Azure Stack HCI resource provider and enables the creation of Azure Stack HCI resources." + } + }, + { + "name": "Microsoft.AzureStackHCI/Unregister/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Unregister", + "operation": "Unregisters the Azure Stack HCI Resource Provider", + "description": "Unregisters the subscription for the Azure Stack HCI resource provider." + } + }, + { + "name": "Microsoft.AzureStackHCI/Operations/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Operations", + "operation": "Gets/List operations resources", + "description": "Gets operations" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters", + "operation": "Gets/List cluster resources", + "description": "Gets clusters" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters", + "operation": "Create/update cluster resources", + "description": "Creates or updates a cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters", + "operation": "Deletes cluster resource", + "description": "Deletes cluster resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings", + "operation": "Gets/List arc resources", + "description": "Gets arc resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings", + "operation": "Create/Update arc resources", + "description": "Create or updates arc resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings", + "operation": "Delete arc resources", + "description": "Delete arc resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings/Extensions", + "operation": "Gets/List extension resources of HCI cluster", + "description": "Gets extension resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings/Extensions", + "operation": "Create/Update extension resources of HCI cluster", + "description": "Create or update extension resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings/Extensions", + "operation": "Delete extension resources of HCI cluster", + "description": "Delete extension resources of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Restart/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Restarts virtual machine resource", + "description": "Restarts virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Start/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Starts virtual machine resource", + "description": "Starts virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Stop/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Stops virtual machine resource", + "description": "Stops virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Deletes virtual machine resource", + "description": "Deletes virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Creates/Updates virtual machine resource", + "description": "Creates/Updates virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Gets/Lists virtual machine resource", + "description": "Gets/Lists virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualNetworks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualNetworks", + "operation": "Deletes virtual networks resource", + "description": "Deletes virtual networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualNetworks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualNetworks", + "operation": "Creates/Updates virtual networks resource", + "description": "Creates/Updates virtual networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualNetworks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualNetworks", + "operation": "Gets/Lists virtual networks resource", + "description": "Gets/Lists virtual networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Deletes virtual hard disk resource", + "description": "Deletes virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Creates/Updates virtual hard disk resource", + "description": "Creates/Updates virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Gets/Lists virtual hard disk resource", + "description": "Gets/Lists virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Deletes network interfaces resource", + "description": "Deletes network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Creates/Updates network interfaces resource", + "description": "Creates/Updates network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Gets/Lists network interfaces resource", + "description": "Gets/Lists network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Deletes gallery images resource", + "description": "Deletes gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Creates/Updates gallery images resource", + "description": "Creates/Updates gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Gets/Lists gallery images resource", + "description": "Gets/Lists gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/HybridIdentityMetadata/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/HybridIdentityMetadata", + "operation": "Gets/Lists virtual machine hybrid identity metadata proxy resource", + "description": "Gets/Lists virtual machine hybrid identity metadata proxy resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/Extensions", + "operation": "Gets/Lists virtual machine extensions resource", + "description": "Gets/Lists virtual machine extensions resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/Extensions", + "operation": "Creates/Updates virtual machine extensions resource", + "description": "Creates/Updates virtual machine extensions resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/Extensions", + "operation": "Deletes virtual machine extensions resource", + "description": "Deletes virtual machine extensions resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/RegisteredSubscriptions/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "RegisteredSubscriptions", + "operation": "Gets/Lists registered subscriptions", + "description": "Reads registered subscriptions" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates", + "operation": "Gets/List available updates for HCI cluster", + "description": "Gets available updates for HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates", + "operation": "Create/Update updates resource of HCI cluster", + "description": "Create or update updates resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates", + "operation": "Delete updates resources of HCI cluster", + "description": "Delete updates resources of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/UpdateSummaries", + "operation": "Gets/List available update summaries for HCI cluster", + "description": "Gets available update summaries for HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/UpdateSummaries", + "operation": "Create/Update update summaries resource of HCI cluster", + "description": "Create or update update summaries resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/UpdateSummaries", + "operation": "Delete updates resource summaries of HCI cluster", + "description": "Delete update summaries resources of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates/UpdateRuns", + "operation": "Gets/List available update runs for HCI cluster", + "description": "Gets available update runs for HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates/UpdateRuns", + "operation": "Create/Update update runs resource of HCI cluster", + "description": "Create or update update runs resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates/UpdateRuns", + "operation": "Delete updates resource runs of HCI cluster", + "description": "Delete update runs resources of HCI cluster" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/stable/2024-04-01/operations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/stable/2024-04-01/operations.json new file mode 100644 index 000000000000..e29582543c48 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/stable/2024-04-01/operations.json @@ -0,0 +1,73 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "Create cluster": { + "$ref": "./examples/ListOperations.json" + } + }, + "description": "List all available Microsoft.AzureStackHCI provider operations", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "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" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/azurestackhci/resource-manager/sdk-suppressions.yaml b/specification/azurestackhci/resource-manager/sdk-suppressions.yaml index 90293c4514c7..f47703537f08 100644 --- a/specification/azurestackhci/resource-manager/sdk-suppressions.yaml +++ b/specification/azurestackhci/resource-manager/sdk-suppressions.yaml @@ -49,4 +49,4 @@ suppressions: - Interface Extension no longer has parameter lastModifiedBy - Interface Extension no longer has parameter lastModifiedByType - Operation Extensions.beginUpdate has a new signature - - Operation Extensions.beginUpdateAndWait has a new signature + - Operation Extensions.beginUpdateAndWait has a new signature \ No newline at end of file diff --git a/specification/azurestackhci/suppressions.yaml b/specification/azurestackhci/suppressions.yaml new file mode 100644 index 000000000000..b78f3f0d5e5b --- /dev/null +++ b/specification/azurestackhci/suppressions.yaml @@ -0,0 +1,7 @@ +- tool: TypeSpecRequirement + path: resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/**/*.json + reason: Part of brownfield service group + +- tool: TypeSpecRequirement + path: resource-manager/Microsoft.AzureStackHCI/operations/stable/2024-04-01/**/*.json + reason: Part of brownfield service group From f98d676317c7ff430241ce16ba8d99142be3581d Mon Sep 17 00:00:00 2001 From: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com> Date: Wed, 5 Jun 2024 22:38:52 -0400 Subject: [PATCH 44/49] Enable stream-stype serialization for Java Communication Job Router (#29328) --- .../Communication.JobRouter/models.tsp | 53 ++----------------- .../Communication.JobRouter/tspconfig.yaml | 3 +- 2 files changed, 5 insertions(+), 51 deletions(-) diff --git a/specification/communication/Communication.JobRouter/models.tsp b/specification/communication/Communication.JobRouter/models.tsp index 8632530e081b..66014395d3fd 100644 --- a/specification/communication/Communication.JobRouter/models.tsp +++ b/specification/communication/Communication.JobRouter/models.tsp @@ -353,7 +353,6 @@ union WorkerSelectorAttachmentKind { weightedAllocation: "weightedAllocation", } -@clientName("ClassificationPolicyInternal", "java") @resource("routing/classificationPolicies") @doc("A container for the rules that govern how jobs are classified.") model ClassificationPolicy { @@ -380,7 +379,6 @@ model ClassificationPolicy { workerSelectorAttachments?: WorkerSelectorAttachment[]; } -@clientName("RouterRuleInternal", "java") @doc(""" A rule of one of the following types: StaticRule: A rule providing static rules that always return the same result, regardless of input. @@ -395,7 +393,6 @@ model RouterRule { kind: RouterRuleKind; } -@clientName("DistributionPolicyInternal", "java") @resource("routing/distributionPolicies") @doc("Policy governing how jobs are distributed to workers") model DistributionPolicy { @@ -416,7 +413,6 @@ model DistributionPolicy { mode?: DistributionMode; } -@clientName("DistributionModeInternal", "java") @doc("Abstract base class for defining a distribution mode.") @discriminator("kind") model DistributionMode { @@ -433,7 +429,6 @@ model DistributionMode { kind: DistributionModeKind; } -@clientName("ExceptionPolicyInternal", "java") @resource("routing/exceptionPolicies") @doc("A policy that defines actions to execute when exception are triggered.") model ExceptionPolicy { @@ -451,7 +446,6 @@ model ExceptionPolicy { exceptionRules?: ExceptionRule[]; } -@clientName("ExceptionRuleInternal", "java") @doc("A rule that defines actions to execute upon a specific trigger.") model ExceptionRule { @doc("Id of an exception rule.") @@ -464,7 +458,6 @@ model ExceptionRule { actions: ExceptionAction[]; } -@clientName("ExceptionTriggerInternal", "java") @doc("Abstract base class for defining a trigger for exception rules.") @discriminator("kind") model ExceptionTrigger { @@ -481,7 +474,6 @@ model RouterJobNote { addedAt?: utcDateTime; } -@clientName("RouterJobInternal", "java") @resource("routing/jobs") @doc("A unit of work to be routed") model RouterJob { @@ -548,7 +540,6 @@ model RouterJob { matchingMode?: JobMatchingMode; } -@clientName("RouterWorkerSelectorInternal", "java") @doc("Describes a condition that must be met against a set of labels for worker selection.") model RouterWorkerSelector { @doc("The label key to query against.") @@ -598,7 +589,6 @@ model RouterJobAssignment { closedAt?: utcDateTime; } -@clientName("JobMatchingModeInternal", "java") @doc(""" A matching mode of one of the following types: QueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued. @@ -611,7 +601,6 @@ model JobMatchingMode { kind: JobMatchingModeKind; } -@clientName("ScheduleAndSuspendModeInternal", "java") @doc("Describes a matching mode used for scheduling jobs to be queued at a future time. At the specified time, matching worker to a job will not start automatically.") model ScheduleAndSuspendMode extends JobMatchingMode { @doc("Requested schedule time.") @@ -621,22 +610,20 @@ model ScheduleAndSuspendMode extends JobMatchingMode { kind: JobMatchingModeKind.scheduleAndSuspend; } -@clientName("QueueAndMatchModeInternal", "java") @doc("Describes a matching mode where matching worker to a job is automatically started after job is queued successfully.") model QueueAndMatchMode extends JobMatchingMode { @doc("The type discriminator describing QueueAndMatchMode") kind: JobMatchingModeKind.queueAndMatch; } -@clientName("SuspendModeInternal", "java") @doc("Describes a matching mode where matching worker to a job is suspended.") model SuspendMode extends JobMatchingMode { @doc("The type discriminator describing SuspendMode") kind: JobMatchingModeKind.suspend; } -@clientName("CancelJobOptionsInternal", "java") @access(Access.public, "python") +@access(Access.public, "java") @doc("Request payload for cancelling a job.") model CancelJobOptions { @doc("A note that will be appended to a job's Notes collection with the current timestamp.") @@ -646,16 +633,16 @@ model CancelJobOptions { dispositionCode?: string; } -@clientName("CompleteJobOptionsInternal", "java") @access(Access.public, "python") +@access(Access.public, "java") @doc("Request payload for completing jobs.") model CompleteJobOptions { @doc("A note that will be appended to a job's Notes collection with the current timestamp.") note?: string; } -@clientName("CloseJobOptionsInternal", "java") @access(Access.public, "python") +@access(Access.public, "java") @doc("Request payload for closing jobs") model CloseJobOptions { @doc("Indicates the outcome of a job, populate this field with your own custom values.") @@ -713,15 +700,14 @@ model AcceptJobOfferResult { workerId: string; } -@clientName("DeclineJobOfferOptionsInternal", "java") @access(Access.public, "python") +@access(Access.public, "java") @doc("Request payload for declining offers.") model DeclineJobOfferOptions { @doc("If the RetryOfferAt is not provided, then this job will not be offered again to the worker who declined this job unless the worker is de-registered and re-registered. If a RetryOfferAt time is provided, then the job will be re-matched to eligible workers at the retry time in UTC. The worker that declined the job will also be eligible for the job at that time.") retryOfferAt?: utcDateTime; } -@clientName("RouterQueueInternal", "java") @resource("routing/queues") @doc("A queue that can contain jobs to be routed.") model RouterQueue { @@ -746,7 +732,6 @@ model RouterQueue { exceptionPolicyId?: string; } -@clientName("RouterQueueStatisticsInternal", "java") @doc("Statistics for the queue.") model RouterQueueStatistics { @doc("Id of the queue these details are about.") @@ -762,7 +747,6 @@ model RouterQueueStatistics { longestJobWaitTimeMinutes?: float64; } -@clientName("RouterWorkerInternal", "java") @resource("routing/workers") @doc("An entity for jobs to be routed to.") model RouterWorker { @@ -863,7 +847,6 @@ model RouterWorkerAssignment { assignedAt: utcDateTime; } -@clientName("BestWorkerModeInternal", "java") @doc("Jobs are distributed to the worker with the strongest abilities available.") model BestWorkerMode extends DistributionMode { @doc("Define a scoring rule to use, when calculating a score to determine the best worker. If not set, will use a default scoring formula that uses the number of job labels that the worker labels match, as well as the number of label selectors the worker labels match and/or exceed using a logistic function (https://en.wikipedia.org/wiki/Logistic_function).") @@ -894,7 +877,6 @@ model ScoringRuleOptions { descendingOrder?: boolean = true; } -@clientName("CancelExceptionActionInternal", "java") @doc("An action that marks a job as cancelled.") model CancelExceptionAction extends ExceptionAction { @doc("A note that will be appended to a job's notes collection with the current timestamp.") @@ -907,7 +889,6 @@ model CancelExceptionAction extends ExceptionAction { kind: ExceptionActionKind.cancel; } -@clientName("ExceptionActionInternal", "java") @doc("The action to take when the exception is triggered.") @discriminator("kind") model ExceptionAction { @@ -918,7 +899,6 @@ model ExceptionAction { kind: ExceptionActionKind; } -@clientName("ConditionalQueueSelectorAttachmentInternal", "java") @doc("Describes a set of queue selectors that will be attached if the given condition resolves to true.") model ConditionalQueueSelectorAttachment extends QueueSelectorAttachment { @doc("The condition that must be true for the queue selectors to be attached.") @@ -931,7 +911,6 @@ model ConditionalQueueSelectorAttachment extends QueueSelectorAttachment { kind: QueueSelectorAttachmentKind.conditional; } -@clientName("RouterQueueSelectorInternal", "java") @doc("Describes a condition that must be met against a set of labels for queue selection.") model RouterQueueSelector { @doc("The label key to query against.") @@ -945,7 +924,6 @@ model RouterQueueSelector { value?: unknown; } -@clientName("QueueSelectorAttachmentInternal", "java") @doc("An attachment of queue selectors to resolve a queue to a job from a classification policy.") @discriminator("kind") model QueueSelectorAttachment { @@ -953,7 +931,6 @@ model QueueSelectorAttachment { kind: QueueSelectorAttachmentKind; } -@clientName("ConditionalWorkerSelectorAttachmentInternal", "java") @doc("Describes a set of worker selectors that will be attached if the given condition resolves to true.") model ConditionalWorkerSelectorAttachment extends WorkerSelectorAttachment { @doc("The condition that must be true for the worker selectors to be attached.") @@ -966,7 +943,6 @@ model ConditionalWorkerSelectorAttachment extends WorkerSelectorAttachment { kind: WorkerSelectorAttachmentKind.conditional; } -@clientName("WorkerSelectorAttachmentInternal", "java") @doc("An attachment which attaches worker selectors to a job.") @discriminator("kind") model WorkerSelectorAttachment { @@ -974,14 +950,12 @@ model WorkerSelectorAttachment { kind: WorkerSelectorAttachmentKind; } -@clientName("DirectMapRouterRuleInternal", "java") @doc("A rule that return the same labels as the input labels.") model DirectMapRouterRule extends RouterRule { @doc("The type discriminator describing a sub-type of Rule.") kind: RouterRuleKind.directMap; } -@clientName("ExpressionRouterRuleInternal", "java") @doc("A rule providing inline expression rules.") model ExpressionRouterRule extends RouterRule { @doc("The expression language to compile to and execute.") @@ -994,7 +968,6 @@ model ExpressionRouterRule extends RouterRule { kind: RouterRuleKind.expression; } -@clientName("FunctionRouterRuleInternal", "java") @doc("A rule providing a binding to an HTTP Triggered Azure Function.") model FunctionRouterRule extends RouterRule { @doc("URL for Azure Function.") @@ -1019,14 +992,12 @@ model FunctionRouterRuleCredential { clientId?: string; } -@clientName("LongestIdleModeInternal", "java") @doc("Jobs are directed to the worker who has been idle longest.") model LongestIdleMode extends DistributionMode { @doc("The type discriminator describing a sub-type of Mode.") kind: DistributionModeKind.longestIdle; } -@clientName("ManualReclassifyExceptionActionInternal", "java") @doc("An action that manually reclassifies a job by providing the queue, priority and worker selectors.") model ManualReclassifyExceptionAction extends ExceptionAction { @doc("Updated QueueId.") @@ -1052,7 +1023,6 @@ model OAuth2WebhookClientCredential { clientSecret?: string; } -@clientName("PassThroughQueueSelectorAttachmentInternal", "java") @doc("Attaches a queue selector where the value is passed through from a job's label with the same key.") model PassThroughQueueSelectorAttachment extends QueueSelectorAttachment { @doc("The label key to query against.") @@ -1065,7 +1035,6 @@ model PassThroughQueueSelectorAttachment extends QueueSelectorAttachment { kind: QueueSelectorAttachmentKind.passThrough; } -@clientName("PassThroughWorkerSelectorAttachmentInternal", "java") @doc("Attaches a worker selector where the value is passed through from a job's label with the same key.") model PassThroughWorkerSelectorAttachment extends WorkerSelectorAttachment { @doc("The label key to query against.") @@ -1081,7 +1050,6 @@ model PassThroughWorkerSelectorAttachment extends WorkerSelectorAttachment { kind: WorkerSelectorAttachmentKind.passThrough; } -@clientName("QueueLengthExceptionTriggerInternal", "java") @doc("Trigger for an exception action on exceeding queue length.") model QueueLengthExceptionTrigger extends ExceptionTrigger { @doc("Threshold of number of jobs ahead in the queue to for this trigger to fire.") @@ -1091,7 +1059,6 @@ model QueueLengthExceptionTrigger extends ExceptionTrigger { kind: ExceptionTriggerKind.queueLength; } -@clientName("QueueWeightedAllocationInternal", "java") @doc("Contains the weight percentage and queue selectors to be applied if selected for weighted distributions.") model QueueWeightedAllocation { @doc("The percentage of this weight, expressed as a fraction of 1.") @@ -1101,7 +1068,6 @@ model QueueWeightedAllocation { queueSelectors: RouterQueueSelector[]; } -@clientName("ReclassifyExceptionActionInternal", "java") @doc("An action that modifies labels on a job and then reclassifies it.") model ReclassifyExceptionAction extends ExceptionAction { @doc("The new classification policy that will determine queue, priority and worker selectors.") @@ -1115,14 +1081,12 @@ model ReclassifyExceptionAction extends ExceptionAction { kind: ExceptionActionKind.reclassify; } -@clientName("RoundRobinModeInternal", "java") @doc("Jobs are distributed in order to workers, starting with the worker that is after the last worker to receive a job.") model RoundRobinMode extends DistributionMode { @doc("The type discriminator describing a sub-type of Mode.") kind: DistributionModeKind.roundRobin; } -@clientName("RuleEngineQueueSelectorAttachmentInternal", "java") @doc("Attaches queue selectors to a job when the RouterRule is resolved.") model RuleEngineQueueSelectorAttachment extends QueueSelectorAttachment { @doc("A RouterRule that resolves a collection of queue selectors to attach.") @@ -1132,7 +1096,6 @@ model RuleEngineQueueSelectorAttachment extends QueueSelectorAttachment { kind: QueueSelectorAttachmentKind.ruleEngine; } -@clientName("RuleEngineWorkerSelectorAttachmentInternal", "java") @doc("Attaches worker selectors to a job when a RouterRule is resolved.") model RuleEngineWorkerSelectorAttachment extends WorkerSelectorAttachment { @doc("A RouterRule that resolves a collection of worker selectors to attach.") @@ -1142,7 +1105,6 @@ model RuleEngineWorkerSelectorAttachment extends WorkerSelectorAttachment { kind: WorkerSelectorAttachmentKind.ruleEngine; } -@clientName("StaticQueueSelectorAttachmentInternal", "java") @doc("Describes a queue selector that will be attached to a job.") model StaticQueueSelectorAttachment extends QueueSelectorAttachment { @doc("The queue selector to attach.") @@ -1152,7 +1114,6 @@ model StaticQueueSelectorAttachment extends QueueSelectorAttachment { kind: QueueSelectorAttachmentKind.static; } -@clientName("StaticRouterRuleInternal", "java") @doc("A rule providing static rules that always return the same result, regardless of input.") model StaticRouterRule extends RouterRule { #suppress "@azure-tools/typespec-azure-core/no-unknown" "Unions are currently not allowed in spec." @@ -1163,7 +1124,6 @@ model StaticRouterRule extends RouterRule { kind: RouterRuleKind.static; } -@clientName("StaticWorkerSelectorAttachmentInternal", "java") @doc("Describes a worker selector that will be attached to a job.") model StaticWorkerSelectorAttachment extends WorkerSelectorAttachment { @doc("The worker selector to attach.") @@ -1173,7 +1133,6 @@ model StaticWorkerSelectorAttachment extends WorkerSelectorAttachment { kind: WorkerSelectorAttachmentKind.static; } -@clientName("WaitTimeExceptionTriggerInternal", "java") @doc("Trigger for an exception action on exceeding wait time.") model WaitTimeExceptionTrigger extends ExceptionTrigger { @doc("Threshold for wait time for this trigger.") @@ -1183,7 +1142,6 @@ model WaitTimeExceptionTrigger extends ExceptionTrigger { kind: ExceptionTriggerKind.waitTime; } -@clientName("WebhookRouterRuleInternal", "java") @doc("A rule providing a binding to an external web server.") model WebhookRouterRule extends RouterRule { @doc("Uri for Authorization Server.") @@ -1199,7 +1157,6 @@ model WebhookRouterRule extends RouterRule { kind: RouterRuleKind.webhook; } -@clientName("WeightedAllocationQueueSelectorAttachmentInternal", "java") @doc("Describes multiple sets of queue selectors, of which one will be selected and attached according to a weighting.") model WeightedAllocationQueueSelectorAttachment extends QueueSelectorAttachment { @@ -1210,7 +1167,6 @@ model WeightedAllocationQueueSelectorAttachment kind: QueueSelectorAttachmentKind.weightedAllocation; } -@clientName("WeightedAllocationWorkerSelectorAttachmentInternal", "java") @doc("Describes multiple sets of worker selectors, of which one will be selected and attached according to a weighting.") model WeightedAllocationWorkerSelectorAttachment extends WorkerSelectorAttachment { @@ -1221,7 +1177,6 @@ model WeightedAllocationWorkerSelectorAttachment kind: WorkerSelectorAttachmentKind.weightedAllocation; } -@clientName("WorkerWeightedAllocationInternal", "java") @doc("Contains the weight percentage and worker selectors to be applied if selected for weighted distributions.") model WorkerWeightedAllocation { @doc("The percentage of this weight, expressed as a fraction of 1.") diff --git a/specification/communication/Communication.JobRouter/tspconfig.yaml b/specification/communication/Communication.JobRouter/tspconfig.yaml index 54372a371083..2b99d766d271 100644 --- a/specification/communication/Communication.JobRouter/tspconfig.yaml +++ b/specification/communication/Communication.JobRouter/tspconfig.yaml @@ -48,10 +48,9 @@ options: partial-update: true service-name: JobRouter custom-types-subpackage: "implementation.models" - custom-types: "BestWorkerModeInternal,CancelExceptionActionInternal,ClassificationPolicyInternal,ConditionalQueueSelectorAttachmentInternal,ConditionalWorkerSelectorAttachmentInternal,DirectMapRouterRuleInternal,DistributionModeInternal,DistributionPolicyInternal,ExceptionActionInternal,ExceptionPolicyInternal,ExceptionRuleInternal,ExceptionTriggerInternal,ExpressionRouterRuleInternal,FunctionRouterRuleInternal,LongestIdleModeInternal,ManualReclassifyExceptionActionInternal,PassThroughQueueSelectorAttachmentInternal,PassThroughWorkerSelectorAttachmentInternal,QueueLengthExceptionTriggerInternal,QueueSelectorAttachmentInternal,QueueWeightedAllocationInternal,ReclassifyExceptionActionInternal,RoundRobinModeInternal,RouterJobInternal,RouterQueueInternal,RouterQueueSelectorInternal,RouterQueueStatisticsInternal,RouterRuleInternal,RouterWorkerInternal,RouterWorkerSelectorInternal,RuleEngineQueueSelectorAttachmentInternal,RuleEngineWorkerSelectorAttachmentInternal,StaticQueueSelectorAttachmentInternal,StaticRouterRuleInternal,StaticWorkerSelectorAttachmentInternal,WaitTimeExceptionTriggerInternal,WebhookRouterRuleInternal,WeightedAllocationQueueSelectorAttachmentInternal,WeightedAllocationWorkerSelectorAttachmentInternal,WorkerSelectorAttachmentInternal,WorkerWeightedAllocationInternal,CancelJobOptionsInternal,CancelJobResultInternal,CloseJobOptionsInternal,CloseJobResultInternal,CompleteJobOptionsInternal,CompleteJobResultInternal,DeclineJobOfferOptionsInternal,DeclineJobOfferResultInternal,ReclassifyJobOptionsInternal,ReclassifyJobResultInternal,JobMatchingModeInternal,SuspendModeInternal,QueueAndMatchModeInternal,ScheduleAndSuspendModeInternal" + custom-types: "CancelJobResultInternal,CloseJobResultInternal,CompleteJobResultInternal,DeclineJobOfferResultInternal,ReclassifyJobOptionsInternal,ReclassifyJobResultInternal" customization-class: customization/src/main/java/JobRouterSdkCustomization.java flavor: azure - stream-style-serialization: false "@azure-tools/typespec-ts": emitter-output-dir: "{js-sdk-folder}/sdk/{service-directory-name}/communication-job-router-rest" package-dir: "communication-job-router-rest" From bf820efd61038a0f44f687d7dffba32b2a08da93 Mon Sep 17 00:00:00 2001 From: miaxzhitong <146033271+miaxzhitong@users.noreply.github.com> Date: Thu, 6 Jun 2024 08:25:30 -0700 Subject: [PATCH 45/49] Azure Map Rendering 20240401 (#27950) * Adds base for updating Render from version stable/2022-08-01 to version 2024-04-01 * Updates readme * Updates API version in new specs and examples * update static map API doc * small change on static map doc * update tilesetId section * add static map supported tilesetid and trafficLayer * update range table and static image example * fix typo * add additional static image example * error fix * run prettier on static image example json * set tilesetId as optional * update max/min latitude/longitude table * update Accept header for static image API * error fix * add explanation for Accept header * typo * add parameter limitation * improve wording * add path and pin parameter type * fix tables * improve on example * typo fix * run prettier * wording fix * map attribution description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * state tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map tileset description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright caption description change Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright bounding description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * weather radar tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * weather infrared tiles description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright world description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * remove pricing tiers applies * Adds base for updating Render from version stable/2022-08-01 to version 2024-04-01 * Updates readme * Updates API version in new specs and examples * update static map API doc * small change on static map doc * update tilesetId section * add static map supported tilesetid and trafficLayer * update range table and static image example * fix typo * add additional static image example * error fix * run prettier on static image example json * set tilesetId as optional * update max/min latitude/longitude table * update Accept header for static image API * error fix * add explanation for Accept header * typo * add parameter limitation * improve wording * add path and pin parameter type * fix tables * improve on example * typo fix * run prettier * wording fix * map attribution description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * state tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map tileset description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright caption description change Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright bounding description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * weather radar tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * weather infrared tiles description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright tile description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * map copyright world description update Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * remove pricing tiers applies * reduce get copyright example length * add summary for render 20240401 * remove summary from static image * remove please from language and view * add package-2024-04-01 to readme * revert back common change * revert changes in maps readme * \n fix Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * typo fix Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * typo fix for map copyright caption Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * typo fix for statetile Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> * typo fix for map copyright world Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> --------- Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> Co-authored-by: Joel Hendrix --- .../maps/data-plane/Render/readme.md | 15 +- .../examples/Render_GetCopyrightCaption.json | 14 + .../examples/Render_GetCopyrightForTile.json | 86 ++ .../examples/Render_GetCopyrightForWorld.json | 45 + .../Render_GetCopyrightFromBoundingBox.json | 59 + .../examples/Render_GetMapAttribution.json | 23 + .../examples/Render_GetMapStateTile.json | 17 + .../examples/Render_GetMapStaticImage.json | 19 + .../examples/Render_GetMapTile.json | 17 + .../examples/Render_GetMapTileset.json | 28 + .../Render/stable/2024-04-01/render.json | 1022 +++++++++++++++++ 11 files changed, 1342 insertions(+), 3 deletions(-) create mode 100644 specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightCaption.json create mode 100644 specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForTile.json create mode 100644 specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForWorld.json create mode 100644 specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightFromBoundingBox.json create mode 100644 specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapAttribution.json create mode 100644 specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStateTile.json create mode 100644 specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStaticImage.json create mode 100644 specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTile.json create mode 100644 specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTileset.json create mode 100644 specification/maps/data-plane/Render/stable/2024-04-01/render.json diff --git a/specification/maps/data-plane/Render/readme.md b/specification/maps/data-plane/Render/readme.md index 2df50d44fdd8..ff0ba8a3aa5f 100644 --- a/specification/maps/data-plane/Render/readme.md +++ b/specification/maps/data-plane/Render/readme.md @@ -27,11 +27,10 @@ These are the global settings for Render Client. ``` yaml title: RenderClient openapi-type: data-plane -tag: 2.1 # removed "preview" as it started causing validation errors from v0.26 of the Swagger Lintdiff. -# at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) +tag: package-2024-04-01 add-credentials: true credential-default-policy-type: BearerTokenCredentialPolicy -credential-scopes: https://atlas.microsoft.com/.default +credential-scopes: 'https://atlas.microsoft.com/.default' track2: true verbose: true sdk-integration: true @@ -48,9 +47,19 @@ directive: reason: false positive from oav is breaking our example validation. See azure/oav#1021. ``` + +### Tag: package-2024-04-01 + +These settings apply only when `--tag=package-2024-04-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-04-01' +input-file: + - stable/2024-04-01/render.json +``` ### Tag: 2022-08-01 These settings apply only when `--tag=2022-08-01` is specified on the command line. + ``` yaml $(tag) == '2022-08-01' input-file: - stable/2022-08-01/render.json diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightCaption.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightCaption.json new file mode 100644 index 000000000000..97ca0985da46 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightCaption.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "format": "json" + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "copyrightsCaption": "© 1992 - 2022 TomTom." + } + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForTile.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForTile.json new file mode 100644 index 000000000000..c4ff7adfa4c0 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForTile.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "format": "json", + "zoom": 6, + "x": 9, + "y": 22 + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "generalCopyrights": [ + "© 1992 - 2022 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", + "Data Source © 2022 TomTom", + "based on" + ], + "regions": [ + { + "country": { + "ISO3": "CAN", + "label": "Canada" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis).", + "© 1992 – 2021 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation. All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material.", + "The following copyright notice applies to the use of Post- FSA layer and 6-digit layer: © 1992 – 2021 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material. The following copyright notice applies to the use of Points of Interest: © 1992 – 2021 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze The following copyright notice applies to the use of Telecommunications: © 2021 Pitney Bowes Software Inc. All rights reserved. This product contains information and/or data of iconectiv, licensed to be included herein. Copyright © 2021 iconectiv. All rights reserved. The following copyright notice applies to the use of Logistics: © 1992 – 2021 TomTom. Truck Attribute Data © 2004 - 2021 ProMiles Software Development Corporation. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom.", + "The 6-digit alpha/numeric Canadian Postal Codes contained in any Licensed Product cannot be used for bulk mailing of items through the Canadian postal system. Furthermore, the 6-digit alpha/numeric Canadian Postal Codes must be wholly contained in the Authorized Application and shall not be extractable. Canadian Postal Codes cannot be displayed or used for postal code look-up on the Internet, nor can they be extracted or exported from any application to be utilized in the creation of any other data set or application. Notwithstanding the above, an End User may optionally correct or derive Canadian Postal Codes using the Authorized Application, but only as part of the address information for locations (e.g.: of delivery points and depots) that have been set up in the Authorized Application, and optionally extract data for fleet management purposes.", + "This product contains information adapted from Statistics Canada: Boundary Files, 2016 Census; Road Network File, 2018; and Census Population and Dwelling Count Highlight Tables, 2016 Census. This does not constitute an endorsement by Statistics Canada of this product.", + "Contains information licensed under Open Government Licence – Canada.", + "Contains data made available by GeoNames licensed under CC-BY 4.0. For more information visit http://www.geonames.org/.", + "Contains information provided by TransLink (South Coast British Columbia Transportation Authority) under the modified open GTFS Data Terms of Use Agreement. For specifics: https://developer.translink.ca/ServicesGtfs/GtfsData", + "Contains information licensed under Open Government Licence: * Vancouver * City of Victoria * British Columbia * City of Surrey * Kamloops * Nanaimo * City of Westminster * City of Prince George * Burnaby * City of Kelowna * Maple Ridge * North Vancouver" + ] + }, + { + "country": { + "ISO3": "OCP", + "label": "" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis)." + ] + }, + { + "country": { + "ISO3": "OUP", + "label": "" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis)." + ] + }, + { + "country": { + "ISO3": "USA", + "label": "United States" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis).", + "The following copyright notice applies to the use of Post- FSA layer and 6-digit layer: © 1992 – 2021 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material. The following copyright notice applies to the use of Points of Interest: © 1992 – 2021 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze The following copyright notice applies to the use of Telecommunications: © 2021 Pitney Bowes Software Inc. All rights reserved. This product contains information and/or data of iconectiv, licensed to be included herein. Copyright © 2021 iconectiv. All rights reserved. The following copyright notice applies to the use of Logistics: © 1992 – 2021 TomTom. Truck Attribute Data © 2004 - 2021 ProMiles Software Development Corporation. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom.", + "© United States Postal Service 2021", + "You shall not use the Municipal Boundary layer of the Administrative Areas product to create or derive applications which are used by third parties for the purpose of tariff, tax jurisdiction, or tax rate determination for a particular address or range of addresses.", + "This product is built on basis on the following elevation data: SRTM, GTOPO, NED data available from the US Geological Survey: https://lta.cr.usgs.gov/products_overview", + "This product is built on basis on the following elevation data: 2-minute Gridded Global Relief Data (ETOPO2v2) available from U.S. Department of Commerce, National Oceanic and Atmospheric Administration, National Geophysical Data Center: http://www.ngdc.noaa.gov/mgg/fliers/06mgg01.html", + "Contains data made available by City of Everett, WA with the following disclaimer:", + "\"The data made available here has been modified for use from its original source, which is the City of Everett. Neither the City of Everett nor the Information Technology Department makes any claims as to the completeness, timeliness, accuracy or content of any data contained in this application; makes any representation of any kind, including, but not limited to, warranty of the accuracy or fitness for a particular use; nor are any such warranties to be implied or inferred with respect to the information or data furnished herein. The data is subject to change as modifications and updates are complete. It is understood that the information contained in the web feed is being used at one's own risk.\" For specifics, please reference: https://data.everettwa.gov/" + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForWorld.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForWorld.json new file mode 100644 index 000000000000..7fb3b04be8be --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForWorld.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "format": "json" + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "generalCopyrights": [ + "© 1992 - 2022 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", + "Data Source © 2022 TomTom", + "based on" + ], + "regions": [ + { + "country": { + "ISO3": "ABW", + "label": "Aruba" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis)." + ] + }, + "......", + { + "country": { + "ISO3": "ZWE", + "label": "Zimbabwe" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis)." + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightFromBoundingBox.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightFromBoundingBox.json new file mode 100644 index 000000000000..6f1bcbfa9b43 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightFromBoundingBox.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "format": "json", + "mincoordinates": [ + 52.41064, + 4.84228 + ], + "maxcoordinates": [ + 52.41072, + 4.84239 + ], + "text": "yes" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "formatVersion": "0.0.1", + "generalCopyrights": [ + "© 1992 - 2022 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", + "Data Source © 2022 TomTom", + "based on" + ], + "regions": [ + { + "country": { + "ISO3": "NLD", + "label": "Netherlands" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis).", + "Contains data licensed under CC-BY 4.0. For more information visit: * Kadaster Top10NL http://nationaalgeoregister.nl/geonetwork/srv/dut/catalog.search#/metadata/29d5310f-dd0d-45ba-abad-b4ffc6b8785f?tab=general * Kadaster BGT http://nationaalgeoregister.nl/geonetwork/srv/dut/catalog.search#/metadata/2cb4769c-b56e-48fa-8685-c48f61b9a319?tab=general * CBS Bestand Bodemgebruik http://nationaalgeoregister.nl/geonetwork/srv/dut/catalog.search#/metadata/2d3dd6d2-2d2b-4b5f-9e30-86e19ed77a56?tab=general", + "Contains data licensed under CC-BY 2.0. For more information visit: * Municipality of Amsterdam Datasets Parkeergarages https://data.amsterdam.nl/index.html#?dte=https:%2F%2Fapi.datapunt.amsterdam.nl%2Fcatalogus%2Fapi%2F3%2Faction%2Fpackage_show%3Fid%3Df06f5a77-04f6-432f-9fd9-ce9d740631aa&dtfs=T&mpb=topografie&mpz=9&mpv=52.3719:4.9012", + "Contains data licensed under CC-BY 3.0. For more information visit: * Municipality of Amsterdam Multiple cat POI's https://data.amsterdam.nl/index.html#?dsd=dcatd&dsp=1&dsq=open%2520data&dsv=CATALOG&mpb=topografie&mpz=11&mpv=52.3731081:4.8932945", + "This product contains public transport stops data made available under 9292 Open Data framework as documented on March 2013. This is specified in their terms available here: http://9292opendata.org/sla", + "This product contains traffic incident information made available by NDW under open source data policy: https://www.ndw.nu/pagina/nl/103/datalevering/120/open_data/" + ] + }, + { + "country": { + "ISO3": "ONL", + "label": "" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis)." + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapAttribution.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapAttribution.json new file mode 100644 index 000000000000..a1b49814f030 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapAttribution.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "tilesetId": "microsoft.base", + "zoom": 6, + "bounds": [ + -122.414162, + 47.579490, + -122.247157, + 47.668372 + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "copyrights": [ + "©2022 TomTom" + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStateTile.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStateTile.json new file mode 100644 index 000000000000..950c34ed85da --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStateTile.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "statesetId": "[statesetId]", + "zoom": 6, + "x": 10, + "y": 22 + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.mapbox-vector-tile" + }, + "body": "{file}" + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStaticImage.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStaticImage.json new file mode 100644 index 000000000000..dc2cea39e287 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStaticImage.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "zoom": 10, + "center": [ + -122.177621, + 47.613079 + ], + "tilesetId": "microsoft.base.road" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "image/png" + }, + "body": "{file}" + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTile.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTile.json new file mode 100644 index 000000000000..0b6067d66de6 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTile.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "tilesetId": "microsoft.base", + "zoom": 6, + "x": 10, + "y": 22 + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.mapbox-vector-tile" + }, + "body": "binary image string" + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTileset.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTileset.json new file mode 100644 index 000000000000..e26ae31605d2 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTileset.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "tilesetId": "microsoft.base" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tilejson": "2.2.0", + "version": "1.0.0", + "attribution": "©2022 TomTom", + "scheme": "xyz", + "tiles": [ + "https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}" + ], + "minzoom": 0, + "maxzoom": 22, + "bounds": [ + -180.0, + -90.0, + 180.0, + 90.0 + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/render.json b/specification/maps/data-plane/Render/stable/2024-04-01/render.json new file mode 100644 index 000000000000..9ae21d4b91f8 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/render.json @@ -0,0 +1,1022 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Render Service", + "version": "2024-04-01", + "description": "Azure Maps Render REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Microsoft Entra OAuth 2.0](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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 2024-04-01.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "client" + }, + "BoundingBoxNorthEast": { + "name": "maxcoordinates", + "x-ms-client-name": "northEast", + "in": "query", + "description": "Maximum coordinates (north-east point) of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228", + "required": true, + "type": "array", + "items": { + "type": "number", + "format": "double" + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "BoundingBox" + } + }, + "BoundingBoxSouthWest": { + "name": "mincoordinates", + "x-ms-client-name": "southWest", + "in": "query", + "description": "Minimum coordinates (south-west point) of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228", + "required": true, + "type": "array", + "items": { + "type": "number", + "format": "double" + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "BoundingBox" + } + }, + "MapTileSize": { + "name": "tileSize", + "in": "query", + "description": "The size of the returned map tile in pixels.", + "type": "string", + "enum": [ + "256", + "512" + ], + "x-ms-enum": { + "name": "MapTileSize", + "modelAsString": true, + "values": [ + { + "value": "256", + "name": "size256", + "description": "Return a 256 by 256 pixel tile." + }, + { + "value": "512", + "name": "size512", + "description": "Return a 512 by 512 pixel tile." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TilesetId": { + "name": "tilesetId", + "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "microsoft.base", + "microsoft.base.labels", + "microsoft.base.hybrid", + "microsoft.terra.main", + "microsoft.base.road", + "microsoft.base.darkgrey", + "microsoft.base.labels.road", + "microsoft.base.labels.darkgrey", + "microsoft.base.hybrid.road", + "microsoft.base.hybrid.darkgrey", + "microsoft.imagery", + "microsoft.weather.radar.main", + "microsoft.weather.infrared.main", + "microsoft.traffic.absolute", + "microsoft.traffic.absolute.main", + "microsoft.traffic.relative", + "microsoft.traffic.relative.main", + "microsoft.traffic.relative.dark", + "microsoft.traffic.delay", + "microsoft.traffic.delay.main", + "microsoft.traffic.reduced.main", + "microsoft.traffic.incident" + ], + "x-ms-enum": { + "name": "TilesetID", + "modelAsString": true, + "values": [ + { + "value": "microsoft.base", + "description": "A base map is a standard map that displays roads, natural and artificial features along with the labels for those features in a vector tile.
\n\nSupports zoom levels 0 through 22. Format: vector (pbf)." + }, + { + "value": "microsoft.base.labels", + "description": "Displays labels for roads, natural and artificial features in a vector tile.
\n\nSupports zoom levels 0 through 22. Format: vector (pbf)." + }, + { + "value": "microsoft.base.hybrid", + "description": "Displays road, boundary and label data in a vector tile.
\n\nSupports zoom levels 0 through 22. Format: vector (pbf)." + }, + { + "value": "microsoft.terra.main", + "description": "Shaded relief and terra layers.
\n\nSupports zoom levels 0 through 6. Format: raster (png)." + }, + { + "value": "microsoft.base.road", + "description": "All layers with our main style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.darkgrey", + "description": "All layers with our dark grey style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.labels.road", + "description": "Label data in our main style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.labels.darkgrey", + "description": "Label data in our dark grey style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.hybrid.road", + "description": "Road, boundary and label data in our main style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.hybrid.darkgrey", + "description": "Road, boundary and label data in our dark grey style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.imagery", + "description": "A combination of satellite and aerial imagery. Only available in S1 pricing SKU.
\n\nSupports zoom levels 1 through 19. Format: raster (jpeg)." + }, + { + "value": "microsoft.weather.radar.main", + "description": "Weather radar tiles. Latest weather radar images including areas of rain, snow, ice and mixed conditions. For more information on the Azure Maps Weather service coverage, see [Azure Maps weather services coverage](/azure/azure-maps/weather-coverage). For more information on Radar data, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#radar-images).\n\nSupports zoom levels 0 through 15. Format: raster (png)." + }, + { + "value": "microsoft.weather.infrared.main", + "description": "Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. For more information, see [Azure Maps weather services coverage](/azure/azure-maps/weather-coverage). For more information about the satellite data returned, see [Weather services in Azure Maps](/azure-maps/weather-services-concepts#satellite-images).\n\nSupports zoom levels 0 through 15. Format: raster (png)." + }, + { + "value": "microsoft.traffic.absolute", + "description": "absolute traffic tiles in vector" + }, + { + "value": "microsoft.traffic.absolute.main", + "description": "absolute traffic tiles in raster in our main style." + }, + { + "value": "microsoft.traffic.relative", + "description": "relative traffic tiles in vector" + }, + { + "value": "microsoft.traffic.relative.main", + "description": "relative traffic tiles in raster in our main style." + }, + { + "value": "microsoft.traffic.relative.dark", + "description": "relative traffic tiles in raster in our dark style." + }, + { + "value": "microsoft.traffic.delay", + "description": "traffic tiles in vector" + }, + { + "value": "microsoft.traffic.delay.main", + "description": "traffic tiles in raster in our main style" + }, + { + "value": "microsoft.traffic.reduced.main", + "description": "reduced traffic tiles in raster in our main style" + }, + { + "value": "microsoft.traffic.incident", + "description": "incident tiles in vector" + } + ] + }, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/map/tile": { + "get": { + "summary": "Use to request map tiles in vector or raster format.", + "description": "\n\nThe `Get Map Tiles` API in an HTTP GET request that allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control ([Web SDK](/azure/azure-maps/about-azure-maps#web-sdk)) and [Android SDK](/azure/azure-maps/about-azure-maps#android-sdk).", + "operationId": "Render_GetMapTile", + "x-ms-client-name": "GetMapTile", + "x-ms-examples": { + "Successful Tile Request": { + "$ref": "./examples/Render_GetMapTile.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetId" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/zTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex" + }, + { + "name": "timeStamp", + "in": "query", + "format": "date-time", + "description": "The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below.\n \n* microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.\n* microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.", + "type": "string" + }, + { + "$ref": "#/parameters/MapTileSize" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/Language" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/View" + } + ], + "produces": [ + "application/json", + "image/jpeg", + "image/png", + "image/pbf", + "application/vnd.mapbox-vector-tile" + ], + "responses": { + "200": { + "description": "The tile returned from a successful API call.", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/tileset": { + "get": { + "summary": "Use to get metadata for a tileset.", + "description": "\n\nThe Get Map Tileset API allows users to request metadata for a tileset.", + "operationId": "Render_GetMapTileset", + "x-ms-examples": { + "Successful Tileset Request": { + "$ref": "./examples/Render_GetMapTileset.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetId" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapTileset" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/attribution": { + "get": { + "summary": "Use to get map copyright attribution information.", + "description": "\n\nThe `Get Map Attribution` API allows users to request map copyright attribution information for a section of a tileset.", + "operationId": "Render_GetMapAttribution", + "x-ms-examples": { + "Successful Attribution Request": { + "$ref": "./examples/Render_GetMapAttribution.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetId" + }, + { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired map attribution.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + { + "name": "bounds", + "in": "query", + "description": "The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`.", + "required": true, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "number", + "format": "double" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapAttribution" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/statetile": { + "get": { + "summary": "Use to get state tiles in vector format that can then be used to display feature state information in an indoor map.", + "description": "\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid).", + "operationId": "Render_GetMapStateTile", + "x-ms-examples": { + "Successful State Tile Request": { + "$ref": "./examples/Render_GetMapStateTile.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/zTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex" + }, + { + "name": "statesetId", + "in": "query", + "description": "The stateset id.", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/vnd.mapbox-vector-tile", + "application/json" + ], + "responses": { + "200": { + "description": "This tile is returned from a successful Get Map State Tile call", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/copyright/caption/{format}": { + "get": { + "summary": "Use to get copyright information to use when rendering a tile.", + "description": "\n\nThe `Get Copyright Caption` API is an HTTP GET request designed to serve copyright information to be used with tiles requested from the Render service. In addition to a basic copyright for the whole map, it can serve specific groups of copyrights for some countries/regions.\n\nAs an alternative to copyrights for map request, it can also return captions for displaying provider information on the map.", + "operationId": "Render_GetCopyrightCaption", + "x-ms-examples": { + "Successful Copyright Caption Request": { + "$ref": "./examples/Render_GetCopyrightCaption.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CopyrightCaption" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/static": { + "get": { + "description": "This rendering API produces static, rasterized map views of a user-defined area. It's suitable for lightweight web applications, when the desired user experience doesn't require interactive map controls, or when bandwidth is limited. This API is also useful for embedding maps in applications outside of the browser, in backend services, report generation, or desktop applications. \n\n This API includes parameters for basic data visualization: \n\n- Labeled pushpins in multiple styles.\n- Render circle, path, and polygon geometry types.\n\nFor more information and detailed examples, see [Render custom data on a raster map](/azure/azure-maps/how-to-render-custom-data).\n

\nThe dimensions of the bbox parameter are constrained, depending on the zoom level. This ensures the resulting image has an appropriate level of detail.\n

\n\n |Zoom Level | Min Lon Range | Max Lon Range | Min Lat Range| Max Lat Range|\n |:----------|:----------------|:----------------|:----------------|:-------------|\n |0 | 56.25 | 360.0 | 30.1105585173 | 180.0 | \n |1 | 28.125 | 360.0 | 14.87468995 | 180.0 |\n |2 | 14.063 | 351.5625 | 7.4130741851 | 137.9576312246 |\n |3 | 7.03125 | 175.78125 | 3.7034501005 | 73.6354071932 |\n |4 | 3.515625 | 87.890625 | 1.8513375155 | 35.4776115315 |\n |5 | 1.7578125 | 43.9453125 | 0.925620264 | 17.4589959239 |\n |6 | 0.87890625 | 21.97265625 | 0.4628040687 | 8.6907788223 |\n |7 | 0.439453125 | 10.986328125 | 0.2314012764 | 4.3404320789 |\n |8 | 0.2197265625 | 5.4931640625 | 0.1157005434 | 2.1695927024 |\n |9 | 0.1098632812 | 2.7465820312 | 0.0578502599 | 1.0847183194 |\n |10 | 0.0549316406 | 1.3732910156 | 0.0289251285 | 0.5423494021 |\n |11 | 0.0274658203 | 0.6866455078 | 0.014462564 | 0.2711734813 |\n |12 | 0.0137329102 | 0.3433227539 | 0.007231282 | 0.1355865882 |\n |13 | 0.0068664551 | 0.171661377 | 0.003615641 | 0.067793275 |\n |14 | 0.0034332275 | 0.0858306885 | 0.0018078205 | 0.0338966351 |\n |15 | 0.0017166138 | 0.0429153442 | 0.0009039102 | 0.0169483173 | \n |16 | 0.0008583069 | 0.0214576721 | 0.0004519551 | 0.0084741586 | \n |17 | 0.0004291534 | 0.0107288361 | 0.0002259776 | 0.0042370793 |\n |18 | 0.0002145767 | 0.005364418 | 0.0001129888 | 0.0021185396 |\n |19 | 0.0001072884 | 0.002682209 | 5.64944E-05 | 0.0010592698 |\n |20 | 5.36442E-05 | 0.0013411045 | 2.82472E-05 | 0.0005296349 | \n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the API.", + "operationId": "Render_GetMapStaticImage", + "x-ms-examples": { + "Successful Static Image Request": { + "$ref": "./examples/Render_GetMapStaticImage.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "tilesetId", + "in": "query", + "description": "Map style to be returned. Possible values are microsoft.base.road, microsoft.base.darkgrey, and microsoft.imagery. Default value is set to be microsoft.base.road. For more information, see [Render TilesetId](https://learn.microsoft.com/en-us/rest/api/maps/render/get-map-tileset?view=rest-maps-2023-06-01&tabs=HTTP#tilesetid).", + "type": "string", + "enum": [ + "microsoft.base.road", + "microsoft.base.darkgrey", + "microsoft.imagery" + ], + "x-ms-enum": { + "name": "TilesetId", + "modelAsString": true, + "values": [ + { + "value": "microsoft.base.road", + "description": "TilesetId contains all layers with rendering main style." + }, + { + "value": "microsoft.base.darkgrey", + "description": "TilesetId contains all layers with our dark grey style." + }, + { + "value": "microsoft.imagery", + "description": "TilesetId contains a combination of satellite and aerial imagery." + } + ] + } + }, + { + "name": "trafficLayer", + "in": "query", + "description": "Optional Value, indicating no traffic flow overlaid on the image result. Possible values are microsoft.traffic.relative.main and none. Default value is none, indicating no traffic flow returned. If traffic related tilesetId is provided, will return map image with corresponding traffic layer. For more information, see [Render TilesetId](https://learn.microsoft.com/en-us/rest/api/maps/render/get-map-tileset?view=rest-maps-2023-06-01&tabs=HTTP#tilesetid).", + "type": "string", + "enum": [ + "microsoft.traffic.relative.main", + "none" + ], + "x-ms-enum": { + "name": "TrafficTilesetId", + "modelAsString": true, + "values": [ + { + "value": "microsoft.traffic.relative.main", + "description": " Supported traffic related tilesetId." + }, + { + "value": "none", + "description": " Default value, no traffic flow overlay." + } + ] + } + }, + { + "name": "zoom", + "in": "query", + "description": "Desired zoom level of the map. Support zoom value range from 0-20 (inclusive) for tilesetId being microsoft.base.road or microsoft.base.darkgrey. Support zoom value range from 0-19 (inclusive) for tilesetId being microsoft.imagery. Default value is 12.

For more information, see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid).", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 20 + }, + { + "name": "center", + "in": "query", + "description": "Coordinates of the center point in double. Format: 'lon,lat'. Longitude range: -180 to 180. Latitude range: -90 to 90. \n\nNote: Either center or bbox are required parameters. They are\nmutually exclusive.", + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "number", + "format": "double" + } + }, + { + "name": "bbox", + "x-ms-client-name": "boundingBoxPrivate", + "in": "query", + "description": "A bounding box is defined by two latitudes and two longitudes that represent the four sides of a rectangular area on the Earth. Format : 'minLon, minLat,\nmaxLon, maxLat' (in double). \n\nNote: Either bbox or center are required\nparameters. They are mutually exclusive. bbox shouldn’t be used with\nheight or width.\n\nThe maximum and minimum allowed ranges for Lat and Lon are defined for each zoom level\nin the table at the top of this page.", + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "number", + "format": "double" + } + }, + { + "name": "height", + "in": "query", + "description": "Height of the resulting image in pixels. Range from 80 to 1500. Default\nis 512. It shouldn’t be used with bbox.", + "type": "integer", + "format": "int32", + "minimum": 80, + "maximum": 1500 + }, + { + "name": "width", + "in": "query", + "description": "Width of the resulting image in pixels. Range from 80 to 2000. Default is 512. It should not be used with bbox.", + "type": "integer", + "format": "int32", + "minimum": 80, + "maximum": 2000 + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/Language" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/View" + }, + { + "name": "pins", + "description": "Pushpin style and instances. Use this parameter to optionally add pushpins to the image.\nThe pushpin style describes the appearance of the pushpins, and the instances specify\nthe coordinates of the pushpins (in double) and optional labels for each pin. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nThe Azure Maps account S0 SKU only supports a single instance of the pins parameter. Other SKUs\nallow multiple instances of the pins parameter to specify multiple pin styles.\n\nTo render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the\nquerystring parameter \n\n`pins=default||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`pins=default%7C%7C-122+45`\n\nAll of the examples here show the pins\nparameter without URL encoding, for clarity.\n\nTo render a pin at multiple locations, separate each location with a pipe character. For example, use\n\n`pins=default||-122 45|-119.5 43.2|-121.67 47.12`\n\nThe S0 Azure Maps account SKU only allows five pushpins. Other account SKUs do not have this limitation.\n\n### Style Modifiers\n\nYou can modify the appearance of the pins by adding style modifiers. These are added after the style but before\nthe locations and labels. Style modifiers each have a two-letter name. These abbreviated names are used to help\nreduce the length of the URL.\n\nTo change the color of the pushpin, use the 'co' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`pins=default|coFF1493||-122 45`\n\n### Pushpin Labels\n\nTo add a label to the pins, put the label in single quotes just before the coordinates. Avoid using special character such as `|` or `||` in label. For example, to label\nthree pins with the values '1', '2', and '3', use\n\n`pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12`\n\nThere is a built-in pushpin style called 'none' that does not display a pushpin image. You can use this if\nyou want to display labels without any pin image. For example,\n\n`pins=none||'A'-122 45|'B'-119.5 43.2`\n\nTo change the color of the pushpin labels, use the 'lc' label color style modifier. For example, to use pink\npushpins with black labels, use\n\n`pins=default|coFF1493|lc000000||-122 45`\n\nTo change the size of the labels, use the 'ls' label size style modifier. The label size represents the approximate\nheight of the label text in pixels. For example, to increase the label size to 12, use\n\n`pins=default|ls12||'A'-122 45|'B'-119 43`\n\nThe labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and\nis at the top center of custom pushpins (see below). To override the label anchor, using the 'la' style modifier\nand provide X and Y pixel coordinates for the anchor. These coordinates are relative to the top left corner of the\npushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down. For example,\nto position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image,\nuse\n\n`pins=default|la10 -4||'A'-122 45|'B'-119 43`\n\n### Custom Pushpins\n\nTo use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the\nlocation and label information. The maximum allowed size for a customized label image is 65,536 pixels. Use two pipe characters to indicate that you're done specifying locations and are\nstarting the URL. For example,\n\n`pins=custom||-122 45||http://contoso.com/pushpins/red.png`\n\nAfter URL encoding, this would look like\n\n`pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png`\n\nBy default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures\nthe location that you're trying to highlight. To override the anchor location of the pin image, use the 'an'\nstyle modifier. This uses the same format as the 'la' label anchor style modifier. For example, if your custom\npin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by\nusing\n\n`pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png`\n\nNote: If you use the 'co' color modifier with a custom pushpin image, the specified color will replace the RGB \nchannels of the pixels in the image but will leave the alpha (opacity) channel unchanged. This would usually\nonly be done with a solid-color custom image.\n\n### Scale, Rotation, and Opacity\n\nYou can make pushpins and their labels larger or smaller by using the 'sc' scale style modifier. This is a\nvalue greater than zero. A value of 1 is the standard scale. Values larger than 1 will make the pins larger, and\nvalues smaller than 1 will make them smaller. For example, to draw the pushpins 50% larger than normal, use\n\n`pins=default|sc1.5||-122 45`\n\nYou can rotate pushpins and their labels by using the 'ro' rotation style modifier. This is a number of degrees\nof clockwise rotation. Use a negative number to rotate counter-clockwise. For example, to rotate the pushpins\n90 degrees clockwise and double their size, use\n\n`pins=default|ro90|sc2||-122 45`\n\nYou can make pushpins and their labels partially transparent by specifying the 'al' alpha style modifier.\nThis is a number between 0 and 1 indicating the opacity of the pushpins. Zero makes them completely transparent\n(and not visible) and 1 makes them completely opaque (which is the default). For example, to make pushpins\nand their labels only 67% opaque, use\n\n`pins=default|al.67||-122 45`\n\n### Style Modifier Summary\n\nModifier | Description | Type | Range \n:--------:|---------------|--------|----------\nal | Alpha (opacity) | float | 0 to 1 \nan | Pin anchor | | * \nco | Pin color | string | 000000 to FFFFFF \nla | Label anchor | | * \nlc | Label color | string | 000000 to FFFFFF \nls | Label size | float | Greater than 0 \nro | Rotation | float | -360 to 360 \nsc | Scale | float | Greater than 0 \n\n* X and Y coordinates can be anywhere within pin image or a margin around it.\nThe margin size is the minimum of the pin width and height.", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + } + }, + { + "name": "path", + "description": "Path style and locations (in double). Use this parameter to optionally add lines, polygons or circles to the image.\nThe path style describes the appearance of the line and fill. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nPath parameter is supported in Azure Maps account SKU starting with S1. Multiple instances of the path parameter \nallow to specify multiple geometries with their styles. Number of parameters per request is limited to 10 and\nnumber of locations is limited to 100 per path.\n\nTo render a circle with radius 100 meters and center point at latitude 45°N and longitude 122°W using the default style, add the\nquerystring parameter \n\n`path=ra100||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`path=ra100%7C%7C-122+45`\n\nAll of the examples here show the path parameter without URL encoding, for clarity.\n\nTo render a line, separate each location with a pipe character. For example, use\n\n`path=||-122 45|-119.5 43.2|-121.67 47.12`\n\nA polygon is specified with a closed path, where the first and last points are equal. For example, use\n\n`path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45`\n\nLongitude value for locations of lines and polygons can be in the range from -360 to 360 to allow for rendering of geometries crossing the anti-meridian.\n\n### Style Modifiers\n\nYou can modify the appearance of the path by adding style modifiers. These are added before the locations. \nStyle modifiers each have a two-letter name. These abbreviated names are used to help reduce the length\nof the URL.\n\nTo change the color of the outline, use the 'lc' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`path=lcFF1493||-122 45|-119.5 43.2`\n\nMultiple style modifiers may be combined to create a more complex visual style.\n\n`lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6`\n\n### Style Modifier Summary\n\nModifier | Description | Type | Range \n:--------:|---------------|--------|----------\nlc | Line color | string | 000000 to FFFFFF\nfc | Fill color | string | 000000 to FFFFFF\nla | Line alpha (opacity) | float | 0 to 1 \nfa | Fill alpha (opacity) | float | 0 to 1 \nlw | Line width |int32 | (0, 50] \nra | Circle radius (meters) | float | Greater than 0", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + } + }, + { + "name": "Accept", + "in": "header", + "description": "The Accept header field can be used to specify preferences regarding response media types. Allowed media types include image/jpeg and image/png. Return image in image/png if Accept header is not specified.", + "required": false, + "type": "string", + "items": { + "type": "string" + }, + "x-ms-parameter-location": "client", + "enum": [ + "image/png", + "image/jpeg" + ], + "x-ms-enum": { + "name": "MediaType", + "modelAsString": true, + "values": [ + { + "value": "image/png", + "description": "Return image in png format." + }, + { + "value": "image/jpeg", + "description": "Return image in jpeg format." + } + ] + } + } + ], + "produces": [ + "image/jpeg", + "image/png" + ], + "responses": { + "200": { + "description": "This image is returned from a successful Get Map Static Image call.", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/copyright/bounding/{format}": { + "get": { + "summary": "Use to get copyright information for the specified bounding box.", + "description": "\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", + "operationId": "Render_GetCopyrightFromBoundingBox", + "x-ms-examples": { + "Successful BoundingBox Copyright Request": { + "$ref": "./examples/Render_GetCopyrightFromBoundingBox.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/BoundingBoxSouthWest" + }, + { + "$ref": "#/parameters/BoundingBoxNorthEast" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/IncludeText" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Copyright" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/copyright/tile/{format}": { + "get": { + "summary": "Use to get copyright information.", + "description": "\n\nTo obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates. For more information, see [Zoom Levels and Tile Grid](/azure/azure-maps/zoom-levels-and-tile-grid).\n\nCopyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.", + "operationId": "Render_GetCopyrightForTile", + "x-ms-examples": { + "Successful Tile Copyright Request": { + "$ref": "./examples/Render_GetCopyrightForTile.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/zTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/IncludeText" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Copyright" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/copyright/world/{format}": { + "get": { + "summary": "Use to get copyright information for for the world.", + "description": "\n\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, don't specify a tile or bounding box. \n\nCopyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions. ", + "operationId": "Render_GetCopyrightForWorld", + "x-ms-examples": { + "Successful World Copyright Request": { + "$ref": "./examples/Render_GetCopyrightForWorld.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/IncludeText" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Copyright" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "Copyright": { + "description": "This object is returned from a successful copyright request", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "generalCopyrights": { + "description": "General Copyrights array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "regions": { + "description": "Regions array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RegionCopyrights" + } + } + } + }, + "CopyrightCaption": { + "description": "This object is returned from a successful copyright call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "copyrightsCaption": { + "description": "Copyrights Caption property", + "type": "string", + "readOnly": true + } + } + }, + "MapAttribution": { + "description": "Copyright attribution for the requested section of a tileset.", + "type": "object", + "readOnly": true, + "properties": { + "copyrights": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of copyright strings." + } + } + }, + "MapTileset": { + "description": "Metadata for a tileset in the TileJSON format.", + "type": "object", + "readOnly": true, + "properties": { + "tilejson": { + "type": "string", + "pattern": "\\d+\\.\\d+\\.\\d+\\w?[\\w\\d]*", + "description": "Describes the version of the TileJSON spec that is implemented by this JSON object." + }, + "name": { + "type": "string", + "description": "A name describing the tileset. The name can contain any legal character. Implementations SHOULD NOT interpret the name as HTML." + }, + "description": { + "type": "string", + "description": "Text description of the tileset. The description can contain any legal character. Implementations SHOULD NOT interpret the description as HTML." + }, + "version": { + "type": "string", + "pattern": "\\d+\\.\\d+\\.\\d+\\w?[\\w\\d]*", + "description": "A semver.org style version number for the tiles contained within the tileset. When changes across tiles are introduced, the minor version MUST change." + }, + "attribution": { + "type": "string", + "description": "Copyright attribution to be displayed on the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking." + }, + "template": { + "type": "string", + "description": "A mustache template to be used to format data from grids for interaction." + }, + "legend": { + "type": "string", + "description": "A legend to be displayed with the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking." + }, + "scheme": { + "type": "string", + "description": "Default: \"xyz\". Either \"xyz\" or \"tms\". Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed." + }, + "tiles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of tile endpoints. If multiple endpoints are specified, clients may use any combination of endpoints. All endpoints MUST return the same content for the same URL. The array MUST contain at least one endpoint." + }, + "grids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of interactivity endpoints." + }, + "data": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of data files in GeoJSON format." + }, + "minzoom": { + "x-ms-client-name": "minZoom", + "minimum": 0, + "maximum": 30, + "type": "integer", + "description": "The minimum zoom level." + }, + "maxzoom": { + "x-ms-client-name": "maxZoom", + "minimum": 0, + "maximum": 30, + "type": "integer", + "description": "The maximum zoom level." + }, + "bounds": { + "type": "array", + "items": { + "type": "number" + }, + "description": "The maximum extent of available map tiles. Bounds MUST define an area covered by all zoom levels. The bounds are represented in WGS:84 latitude and longitude values, in the order left, bottom, right, top. Values may be integers or floating point numbers." + }, + "center": { + "type": "array", + "items": { + "type": "number" + }, + "description": "The default location of the tileset in the form [longitude, latitude, zoom]. The zoom level MUST be between minzoom and maxzoom. Implementations can use this value to set the default location." + } + } + }, + "RegionCopyrights": { + "type": "object", + "properties": { + "copyrights": { + "description": "Copyrights array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "country": { + "description": "Country property", + "type": "object", + "readOnly": true, + "properties": { + "ISO3": { + "description": "ISO3 property", + "type": "string", + "readOnly": true + }, + "label": { + "description": "Label property", + "type": "string", + "readOnly": true + } + } + } + } + } + } +} From b22c642b361e6d6e7d72a2347a09b0bcf6075d70 Mon Sep 17 00:00:00 2001 From: Konrad Jamrozik Date: Thu, 6 Jun 2024 14:11:56 -0700 Subject: [PATCH 46/49] Update directory-structure.md: clarify service, service group, uniform versioning. (#28929) --- .markdownlint.jsonc | 7 +- cSpell.json | 12 +- documentation/directory-structure.md | 270 ++++++++---------- documentation/glossary.md | 83 ++++++ .../typespec-structure-guidelines.md | 8 +- documentation/uniform-versioning.md | 95 ++++++ 6 files changed, 314 insertions(+), 161 deletions(-) create mode 100644 documentation/glossary.md create mode 100644 documentation/uniform-versioning.md diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc index 98657b7eff01..f4856b9b8949 100644 --- a/.markdownlint.jsonc +++ b/.markdownlint.jsonc @@ -31,5 +31,10 @@ // https://github.com/DavidAnson/markdownlint/blob/main/doc/md034.md // // We allow bare URLs e.g. to link to GitHub issues. - "MD034": false + "MD034": false, + + // MD041 - First line in a file should be a top-level heading + // + // We sometimes use "short link" table as first line. + "MD041": false } diff --git a/cSpell.json b/cSpell.json index 0af01c9ee4c6..e72217ed3b24 100644 --- a/cSpell.json +++ b/cSpell.json @@ -3,6 +3,8 @@ "language": "en", "words": [ "authnotrequired", + "azsdk", + "confidentialledger", "Creds", "fixdate", "frontends", @@ -878,7 +880,6 @@ "unittype" ] }, - { "filename": "**/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/render.json", "words": [ @@ -1191,7 +1192,6 @@ "containerd" ] }, - { "filename": "**/specification/batch/data-plane/Microsoft.Batch/**/*.json", "words": [ @@ -1266,10 +1266,10 @@ { "filename": "**/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json", "words": [ - "Cisa", - "cisa", - "affected", - "AUTOCONFIRMED" + "Cisa", + "cisa", + "affected", + "AUTOCONFIRMED" ] }, { diff --git a/documentation/directory-structure.md b/documentation/directory-structure.md index c56b1a4e708a..d3564b6314b9 100644 --- a/documentation/directory-structure.md +++ b/documentation/directory-structure.md @@ -7,163 +7,142 @@ https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one --> - [`specification` directory structure](#specification-directory-structure) + - [Key concepts](#key-concepts) - [`specification` folder](#specification-folder) - - [`resource-manager` and `data-plane` folders](#resource-manager-and-data-plane-folders) - - [AutoRest configuration `README.md` files](#autorest-configuration-readmemd-files) - - [`stable` and `preview` folders](#stable-and-preview-folders) - - [A complete example directory structure of `specification/`](#a-complete-example-directory-structure-of-specificationazureteam) - - [Naming guidelines for `specification` folder contents](#naming-guidelines-for-specification-folder-contents) + - [`` folders](#typespecsrc-folders) + - [`resource-manager/` folder](#resource-managerrpns-folder) + - [`data-plane/` folders](#data-planegroupingdir-folders) + - [Service folder structure](#service-folder-structure) - [`specification/common-types`](#specificationcommon-types) - - [Advanced scenario: service group](#advanced-scenario-service-group) - - [Service group `common-types`](#service-group-common-types) - - [Versioning services in a service group](#versioning-services-in-a-service-group) - - [Deprecated structure and hand-written OpenAPI specs](#deprecated-structure-and-hand-written-openapi-specs) -# `specification` directory structure + - [Naming guidelines for `specification` folder contents](#naming-guidelines-for-specification-folder-contents) + - [About legacy, deprecated directory structure for services and service groups](#about-legacy-deprecated-directory-structure-for-services-and-service-groups) + - [Migrating from a singular service to service group in a legacy directory structure](#migrating-from-a-singular-service-to-service-group-in-a-legacy-directory-structure) + - [Deprecated directory structure and hand-written OpenAPI specs](#deprecated-directory-structure-and-hand-written-openapi-specs) +# `specification` directory structure This article describes the directory structure / folder layout of the `specification` folder. You may be also interested in following: + - [Specification index] - [Resource Provider list] > [!IMPORTANT] -> The structure described in this article is strictly enforced. There exist some exceptions for historical reasons. -> These exceptions are not allowed going forward. +> The structure described in this article is recommended. There exist some exceptions for historical reasons. +> These exceptions are strongly discouraged going forward. -## `specification` folder - -The `specification` folder is the root folder for all service specifications. - -Each child of the `specification` folder corresponds to a `service` specification for given Azure team. Here we denote such folder as ``. -In advanced cases for big teams the `` folder can host multiple services, known as `service group`. -Read [the relevant section](#advanced-scenario-service-group) for details. +## Key concepts -Given `` has following structure: +The directory structure is a reflection of a few key concepts. -- `/` (multiple folders) -- `/resource-manager` -- `/data-plane` - -The `/` folders contain the TypeSpec specification for the given `service` or `service group`. -You can find details on the name and contents of these folders in [TypeSpec directory structure]. -You can learn more about TypeSpec at [aka.ms/azsdk/typespec] and [aka.ms/typespec]. +Familiarize yourself with the concepts of `service`, `service group`, `grouping directory` and `uniform versioning` +as explained in the [glossary]. -## `resource-manager` and `data-plane` folders +## `specification` folder -The `/resource-manager` contains the ARM OpenAPI specifications emitted from TypeSpec in `/`. +The `specification` folder is the root folder for all `service` specifications. -The `resource-manager` folder has exactly one child folder whose name matches the **Resource Provider (RP) Namespace** (``), -such as `Microsoft.Automation` (full list of namespaces is [here][Resource Provider list]). -There is 1 to 1 correspondence between an RP and an RP namespace. -There must be **exactly one** RP namespace folder under given `resource-manager` folder. -We denote such folder as `resource-manager/`. +Each child of the `specification` folder corresponds to ``. +All the `service` (see [glossary]) specifications owned by that team are rooted in their `` folder. -The `/data-plane` contains the data-plane OpenAPI specifications emitted from TypeSpec in ``. -The `data-plane` folder has no child `` folder. However, it can have a set of `` folders. +Given `` folder has following structure: -## AutoRest configuration `README.md` files +- `/` (multiple `` folders are allowed) +- `/resource-manager/` (exactly one `` folder is allowed) +- `/data-plane/` (multiple `` folders are allowed) -Both the `/resource-manager` and `/data-plane` folders must contain an AutoRest configuration file, `README.md`. -Learn more about this file at [aka.ms/azsdk/autorest]. +### `` folders - +The `/` folders contain the TypeSpec specifications for the services owned by the team. -Each `README.md` describes a single `service` and is used as an SDK package and documentation for each version of the service. -Inside the `README.md` file there are lists of paths to OpenAPI spec `.json` files making up given service version. +The content of these folders is used as input to emit OpenAPI specifications +placed within `/resource-manager/` folder and `/data-plane/` folders. > [!NOTE] -> All OpenAPI specs for given service version (i.e. the list of paths in given `input-file:` block in the `README.md`) must have the same service version, -> which also means being in the same [API version lifecycle stage][aka.ms/azsdk/api-versions]. - -## `stable` and `preview` folders +> Some services may not have `` folders. In such case, these services OpenAPI specs are hand-written. +> This is legacy, deprecated practice and is not allowed going forward. -Both `/resource-manager/` and `/data-plane/` folders, in addition to containing `README.md`, also can contain -`stable` and `preview` folders. These folders contain OpenAPI specs in the `stable` and `preview` [lifecycle stages][aka.ms/azsdk/api-versions] -respectively, organized in `` subfolders for each service API version. For example, `/resource-manager//stable/` or -`/data-plane//preview/`. +You can find details on the name and contents of `` folders in [TypeSpec directory structure]. +You can learn more about TypeSpec at [aka.ms/azsdk/typespec] and [aka.ms/typespec]. -Each such API version folder directly contains a set of `.json` files containing OpenAPI specs emitted from TypeSpec, as well as an `examples` child folder -with `.json` files having the contents of [`x-ms-examples`] referenced from the OpenAPI specs. +### `resource-manager/` folder -## A complete example directory structure of `specification/` +The `/resource-manager/` is a folder corresponding to ARM **Resource Provider (RP) namespace**. -Putting everything together discussed, the directory structure of a singular `specification//` is as follows: +An example RPNS is `Microsoft.Automation`. A list of RPs can be found in the [Resource Provider list]. -``` yaml -/1/... -/2/... # multiple '' folders +This folder corresponds to a `service group` (see [glossary]) for all ARM services owned by the team. -/resource-manager/README.md -/resource-manager//stable//*.json -/resource-manager//stable//examples/*.json - // ... # multiple '' folders -/resource-manager//preview//*.json -/resource-manager//preview//examples/*.json - // ... # multiple '' folders +An `` folder has one or more child `` folders corresponding to the services belonging +to the `service group` represented by the `` folder. -/data-plane/README.md -/data-plane//stable//*.json -/data-plane//stable//examples/*.json - // ... # multiple '' folders -/data-plane//preview//*.json -/data-plane//preview//examples/*.json - // ... # multiple '' folders - // ... # multiple '' folders +For example, [`specification/containerservice/resource-manager/Microsoft.ContainerService/aks`] +is a folder for the `aks` service within the `Microsoft.ContainerService` ARM Resource Provider namespace. -``` +> [!NOTE] +> Many Azure teams that have one ARM service instead of rooting it in +> `specification//resource-manager//` root it in +> `specification//resource-manager`. +> This is legacy, deprecated structure and is strongly discouraged going forward. -As a specific example of the above, consider [`specification/confidentialledger`] `` which has the following structure: +In addition, the `` folder may contain `common-types` child folder that usually is of +form `common-types/v/common.json` and contains types shared across API versions. +E.g. [`Microsoft.Compute/common-types`]. -``` yaml +### `data-plane/` folders -# ===== s +The `/data-plane` folder is the equivalent +of `/resource-manager` but with following distinctions: -/Microsoft.CodeTransparency/ -/Microsoft.ManagedCcf/ +- `/data-plane` pertains to data-plane service APIs, not ARM service APIs. +- `/data-plane` has no concept of Resource Provider Namespace (``). + Instead, it has or more `` child folders (see also [glossary]). -# ===== data-plane +Each `` folder has one or more child `` folders corresponding to the services grouped +in given ``. -/data-plane/README.md +> [!NOTE] +> Many Azure teams that have one data-plane service instead of rooting it in +> `specification//data-plane//` root it in +> `specification//data-plane`. +> This is legacy, deprecated structure and is strongly discouraged going forward. -# ----- : Microsoft.CodeTransparency +## Service folder structure -/data-plane/Microsoft.CodeTransparency/preview/2024-01-11-preview -/data-plane/Microsoft.CodeTransparency/preview/2024-01-11-preview/examples +As described above, ARM service folder path is: -# ----- : Microsoft.ConfidentialLedger +`specification//resource-manager//` -/data-plane/Microsoft.ConfidentialLedger/stable -/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13 -/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13/examples +while data-plane service folder path is: -/data-plane/Microsoft.ConfidentialLedger/preview -/data-plane/Microsoft.ConfidentialLedger/preview/2023-01-18-preview -/data-plane/Microsoft.ConfidentialLedger/preview/2023-01-18-preview/examples -# ... more previews here +`specification//data-plane//`. -# ----- : Microsoft.ManagedCcf +A service folder has the following elements: -/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview -/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview/examples +- The [AutoRest config `README.md` file]. See also section about it in [uniform versioning article]. +- Additional AutoRest config `README.md` files specific to given language SDK. +- The `stable` and `preview` folders if applicable. -# ===== resource-manager +The `stable` and `preview` folders contain OpenAPI specs in the `stable` and `preview` [lifecycle stages][aka.ms/azsdk/api-versions] +respectively, organized in `` subfolders for each service API version. -/resource-manager/README.md +For example: -# ----- resource-manager RP Namespace (): Microsoft.ConfidentialLedger +- `/resource-manager///stable/` +- `/resource-manager///preview/` +- `/data-plane///stable/` +- `/data-plane///preview/` -/resource-manager/Microsoft.ConfidentialLedger/stable/2022-05-13 -/resource-manager/Microsoft.ConfidentialLedger/stable/2022-05-13/examples +Each such API version folder directly contains a set of `.json` files containing OpenAPI specs emitted from TypeSpec, +as well as an `examples` child folder with `.json` files having the contents of [`x-ms-examples`] referenced +from the OpenAPI specs. -/resource-manager/Microsoft.ConfidentialLedger/preview/2023-06-28-preview -/resource-manager/Microsoft.ConfidentialLedger/preview/2023-06-28-preview/examples -# ... more previews here -/resource-manager/Microsoft.ConfidentialLedger/preview/2020-12-01-preview -/resource-manager/Microsoft.ConfidentialLedger/preview/2020-12-01-preview/examples +Read [API versioning guidelines] to learn more. -``` +## `specification/common-types` -For another example, see [`specification/eventgrid`]. +The special directory of [`specification/common-types`] contains shared definitions that can be reused across all +Azure team services in their `specification` child folders. ## Naming guidelines for `specification` folder contents @@ -173,75 +152,66 @@ For another example, see [`specification/eventgrid`]. - For file names, any casing is allowed. - When in doubt, mimic naming of the examples provided in this article. -## `specification/common-types` - -The special directory of [`specification/common-types`] contains shared definitions that can be reused across all Azure team services in their -`specification` child folders. - -## Advanced scenario: service group +## About legacy, deprecated directory structure for services and service groups -In case of big Azure teams, their `specification/` hosts multiple services, together known as `service group`. -The main difference between one service and a service group is how they are presented to Azure customers: -One service has one SDK package and one documentation portal, while a service group has separate SDK package for each service and separate documentation. +Many teams follow a legacy, deprecated directory structure which usually has following differences: -For example, [`specification/containerservice`] is a `service group` for both `aks` and `fleet` services. +- If a team owns only one service, instead of rooting it in `specification//resource-manager//`, + it is rooted in`specification//resource-manager`. +- If a team first owned one service and then expanded to a service group, + it contains mixture of both the deprecated structure (for the first service) as well as the correct structure + (for the 2nd and following services). -The doc for `aks` is [Azure Kubernetes Service]. It points to aks REST reference e.g. for [API version `2024-01-01`][aks REST reference 2024-01-01], -which corresponds to [`specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-01-01`]. +This legacy structure is strongly discouraged going forward. -The doc for `fleet` is [Azure Kubernetes Fleet Manager]. It point to fleet REST reference, e.g. for [API version `2023-10-15`][fleet REST reference 2023-10-15], -which corresponds to [`specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15`]. +## Migrating from a singular service to service group in a legacy directory structure -Using our example, note the most important directory structure difference of a `service group` scenario as compared to singular `service`: +In case an Azure SDK team owns a singular service following the legacy, deprecated layout, and wants to expand to a full +service group, it can do the following: -- The `resource-manager/Microsoft.ContainerService` folder has multiple child service folders which contain `stable` and `preview` folders for each service, - instead of directly containing `stable` and `preview` folders. -- Each of the `aks` and `fleet` subfolders have their own `README.md` file, instead of there being one `README.md` in the `resource-manager` folder. - As a result, the SDKs of these services are separate. +- Keep the existing service as-is, without any changes. +- Introduce the new services using the new, correct structure. -### Service group `common-types` +## Deprecated directory structure and hand-written OpenAPI specs -A service group can also introduce its own set of `common-types` which are too general to be shared across all Azure teams but common enough to be -shared across all services in given service group. For an example, see [`Microsoft.Compute/common-types`]. - -### Versioning services in a service group - -The versioning policy for API and SDK packages applies independently to each service in the service group. -This means that each service in the service group must obey the same versioning rules as it were a singular service. -However, multiple separate services can have different versioning cycles, including different SDK packages. Refer to the aforementioned `aks` and `fleet` -services for examples of different versioning cycles in a service group. - -## Deprecated structure and hand-written OpenAPI specs - -As mentioned at the beginning of this article, for historical reasons, some `specification/` folders may +As mentioned multiple times in this article, for historical reasons, some `specification/` folders may violate some of the constraints presented in this article. This includes violations like: - More deeply nested subfolders than allowed. +- `README.md` placed in a wrong folder (thus incorrectly denoting it as a `service` folder). +- Lack of `` directory for given service path. - Incorrect lack of `-preview` suffix in `preview` API versions. +- Multiple `` subfolders of `resource-manager` folder. - Mixing of `stable` and `preview` API versions in the same folder subtree. - Mixing of multiple API versions in given `README.md` package, including mixing of multiple API version lifecycle stages. -In addition, some `` folders have OpenAPI specs that have been written manually instead of emitted from TypeSpec. -In some cases the folders have mixture of manually-written and TypeSpec-emitted OpenAPI specs. +In addition, some `` folders have OpenAPI specs that have been written manually instead of emitted from +TypeSpec. In some cases the folders have mixture of manually-written and TypeSpec-emitted OpenAPI specs. -All of the aforementioned cases are considered legacy and are not allowed going forward. +All of the aforementioned cases are considered legacy & deprecated, and are strongly discouraged going forward. [`Microsoft.Compute/common-types`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/compute/resource-manager/Microsoft.Compute/common-types/ [`specification/common-types`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/common-types +[`specification/containerservice/resource-manager/Microsoft.ContainerService/aks`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService/aks +[`x-ms-examples`]: https://azure.github.io/autorest/extensions/#x-ms-examples +[aka.ms/azsdk/api-versions]: https://aka.ms/azsdk/api-versions +[aka.ms/azsdk/typespec]: https://aka.ms/azsdk/typespec +[aka.ms/typespec]: https://aka.ms/typespec +[API versioning guidelines]: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#api-versioning +[AutoRest config `README.md` file]: https://aka.ms/azsdk/autorest +[glossary]: ./glossary.md +[Resource Provider list]: https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/azure-services-resource-providers#match-resource-provider-to-service +[Specification index]: https://azure.github.io/azure-sdk/releases/latest/all/specs.html +[TypeSpec directory structure]: https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/typespec-structure-guidelines.md +[uniform versioning article]: ./uniform-versioning.md + + [`specification/confidentialledger`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/confidentialledger [`specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-01-01`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-01-01 [`specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15 [`specification/containerservice`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice [`specification/eventgrid`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid -[`x-ms-examples`]: https://azure.github.io/autorest/extensions/#x-ms-examples -[aka.ms/azsdk/api-versions]: https://aka.ms/azsdk/api-versions [aka.ms/azsdk/autorest]: https://aka.ms/azsdk/autorest -[aka.ms/azsdk/typespec]: https://aka.ms/azsdk/typespec -[aka.ms/typespec]: https://aka.ms/typespec [aks REST reference 2024-01-01]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-01-01 [Azure Kubernetes Fleet Manager]: https://learn.microsoft.com/en-us/azure/kubernetes-fleet/ -[Azure Kubernetes Service]: https://learn.microsoft.com/en-us/azure/aks/ [fleet REST reference 2023-10-15]: https://learn.microsoft.com/en-us/rest/api/fleet/operation-groups?view=rest-fleet-2023-10-15 -[Resource Provider list]: https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/azure-services-resource-providers#match-resource-provider-to-service -[Specification index]: https://azure.github.io/azure-sdk/releases/latest/all/specs.html -[TypeSpec directory structure]: https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/typespec-structure-guidelines.md diff --git a/documentation/glossary.md b/documentation/glossary.md new file mode 100644 index 000000000000..d55bbf11b9ff --- /dev/null +++ b/documentation/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +This article defines some of the terms used in the articles under `documentation` directory. + +## Grouping directory + +A `grouping directory`, denoted as `` in the [directory structure article], is a root folder for +a set of data-plane `service` folders. It is a subfolder of `data-plane` folder. + +Each `service` in given `grouping directory` must [**version uniformly**][uniform versioning article] but each `service` +within a `grouping directory` can version independently of each other. + +A `grouping directory` can be seen as a more free-form equivalent of the ARM `service group`, but for data-plane services. + +Specifically, all services grouped in given `groping directory` do not share any ARM **Resource Provider (RP) namespace** +and are not related to ARM in any way. + +## Resource type + +In case of ARM, a `service` is a collection of `resource types` or `resource type groups`. + +## Service + +A `service` is a set of operation endpoints (typically HTTP REST API endpoints) +that [**version uniformly**][uniform versioning article]. + +A `service` corresponds to a cohesive, uniformly versioned experience for the customer with HTTP REST API surface, +documentation portal and language SDKs. For example, [Azure Kubernetes Service]. + +In this repository, an ARM service has a path of form: + +`specification//resource-manager//` + +where `` stands for ARM **Resource Provider (RP) namespace**. + +A data-plane service has a path of form: + +`specification//data-plane//` + +> [!NOTE] +> Some existing services follow different directory structure layouts. +> All such layouts are legacy, deprecated, and not allowed going forward. + +For example, [`specification/containerservice/resource-manager/Microsoft.ContainerService/aks`] +is a folder for the `aks` service within the `Microsoft.ContainerService` ARM Resource Provider namespace. + +You can learn more about how a `service` maps to its directory in the [directory structure article]. + +## Service group + +A `service group` is a set of services that share a common ARM **Resource Provider (RP) namespace**, `RPNS`. + +Each `service` in given `service group` must [**version uniformly**][uniform versioning article] but each `service` +within a `service group` can version independently of each other. + +A `service group` has a path of form: + +`specification//resource-manager/` + +as such, it corresponds to ARM Resource Provider Namespace. + +Example service group: + +[`specification/containerservice/resource-manager/Microsoft.ContainerService`] + +which is composed of two services, [`aks`] and [`fleet`]. + +> [!NOTE] +> Previously `service group` was erroneously used in reference to services like `aks`. This is incorrect. + +You can learn more about how a `service group` maps to its directory in the [directory structure article]. + +## Uniform versioning + +See [uniform versioning article]. + +[`aks`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService/aks +[`fleet`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet +[`specification/containerservice/resource-manager/Microsoft.ContainerService/aks`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService/aks +[`specification/containerservice/resource-manager/Microsoft.ContainerService`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService +[Azure Kubernetes Service]: https://learn.microsoft.com/en-us/azure/aks/ +[directory structure article]: ./directory-structure.md +[uniform versioning article]: ./uniform-versioning.md diff --git a/documentation/typespec-structure-guidelines.md b/documentation/typespec-structure-guidelines.md index 92ee3450ea70..f7ff9359f922 100644 --- a/documentation/typespec-structure-guidelines.md +++ b/documentation/typespec-structure-guidelines.md @@ -4,9 +4,9 @@ - [Service folder structure](#service-folder-structure) - [Libraries for service groups](#libraries-for-service-groups) - [Specification versioning](#specification-versioning) - - [Organizing services in folders](#organizing-services-in-folders) - - [Utilizing feature branches](#utilizing-feature-branches) - - [Publishing specifications](#publishing-specifications) + - [Organizing services in folders](#organizing-services-in-folders) + - [Utilizing feature branches](#utilizing-feature-branches) + - [Publishing specifications](#publishing-specifications) # Guidelines for TypeSpec project repositories @@ -18,7 +18,7 @@ This document provides guidelines for managing TypeSpec projects for Azure. It o The structure of TypeSpec project repositories starts with the [specification](https://aka.ms/azsdk/spec-dirs) folder, serving as the root for all service specifications. Each child folder, denoted as ``, corresponds to a service specification for a specific Azure team. In more complex scenarios, such as larger teams, the `` folder can host multiple services, forming what is known as a service group. -The `` folder can include multiple ``s, each containing the TypeSpec specification for a given service or service group. +The `` folder can include multiple `` folders, each containing the TypeSpec specification for a given service or service group. A given TypeSpec project folder can represent various scenarios: diff --git a/documentation/uniform-versioning.md b/documentation/uniform-versioning.md new file mode 100644 index 000000000000..923e8c2c0ed4 --- /dev/null +++ b/documentation/uniform-versioning.md @@ -0,0 +1,95 @@ +# Uniform versioning + +> [!NOTE] +> This article uses terminology defined in the [glossary], like `service` or `service group`. + +A `service` **must version uniformly**. + +In brief, it means: + +> The service, its set of operation endpoints (typically HTTP REST API endpoints), its documentation, and any SDK referencing it, all must version in lockstep. +> If a new service API version is released, also a new documentation reference must be released to describe it. +> Similarly, a new version of given SDK package must be released to refer to the new service version. + +Each `service` within a `service group` can version independently of each other. + +## Uniform versioning rules + +All of the rules listed here apply both for OpenAPI specs emitted from TypeSpec as well as for hand-written OpenAPI specs. + +**Uniform versioning** prescribes the following + +1. Any deployed service operation endpoint must belong to an API version. An API version once deployed is immutable. + Its behavior or constituent operations cannot be changed. +2. Any given service API version can be composed only of HTTP API operations and ARM resource types (if applicable) + that have the same API version. +3. Any documentation pertaining to the service and any SDKs generated from the service must pertain to only + one service version. +4. The service version must be always represented in its entirety; any SDK or documentation referring to the service + must encompass all of it. +5. The `common-types` OpenAPI definition shared across multiple services can version independently of the service. + However, the rule that API version is immutable still must be observed. + As such, when versioning `common-types`, previous API versions will remain immutable because new API versions must be created. + +## Uniform versioning implications + +The **uniform versioning** has several implications and implementation decisions supporting it. + +### API versions + +- The service is effectively defined as a series of consecutive API versions. +- Each API version is represented by a pair of folders representing its lifecycle stage and a date, + like `stable/2024-03-05` or `preview/2024-05-15-preview`. +- Each API version date must be later than the previous date. +- `stable` and `preview` API versions cannot have the same date. This would prevent API users from knowing + which one is later one. +- Moving to `stable` from `preview` by removing `-preview` suffix is not allowed. + In such case, at least one day must be added to the `stable` API version. + +### Directory structure + +- The entirety of given API service specification must be placed inside its folder, e.g. `stable/2024-03-05`. + The service consists of operation endpoints defined in OpenAPI spec `.json` files placed in its API version folder. +- Learn more in [directory structure article]. + +### No API version mixing within a service + +- Nowhere within a service, documentation for it, or SDK referencing it, + can multiple service API versions be mixed. as such: + - `preview` API versions cannot be mixed with `stable` API versions. + - No HTTP API endpoint for given API version can have any kind of dependency on service endpoint from any other API version. + - The above apply to a stand-alone service as well as to a service that is a member of a `service group`. + +### API version mixing across services in a service group + +- Each `service` within a `service group` can version independently of each other. +- Each `service` within a `service group` must observe the **uniform versioning rules** within its own scope. + +### AutoRest configuration for SDK generation (`README.md` files) + +- Any [AutoRest config `README.md` file] definition for the service must have tags corresponding to the API versions + present in the directory structure. +- Each of the API version tags must include **all** OpenAPI spec `.json` files for given API version. +- Each of the API version tags must include **only** OpenAPI spec `.json` files for given API version. +- Each `README.md` describes a single `service` and is used as an SDK package and documentation for each version of the service. +- All OpenAPI specs for given `service` API version (i.e. the list of paths in given `input-file:` block for given API version tag in the `README.md`) + must have the same service version, which also means being in the same [API version lifecycle stage]. + +### Versioning of `common-types` + +- All the shared OpenAPI definitions (i.e. `common-types`) the service depends on must have the same version, + [e.g. `v6`][common-types v6], but it can be different from the version of the service. +- Updating `common-types` version requires updating the API version. + For example, if `common-types` published an updated version of `v7`, + then if the service wants to take dependency on it, it can only do it in + a new version. For example, `2024-04-17`. + Because the service version is now `2024-04-17`, all the OpenAPI specification `.json` files the service is composed + of must have the same version of `2024-04-17` and the `info.version` property must say `2024-04-17`. + In addition, a new SDK must be generated from the service, and new documentation published, both tagged with + service version `2024-04-17`. + +[API version lifecycle stage]: https://aka.ms/azsdk/api-versions +[AutoRest config `README.md` file]: https://aka.ms/azsdk/autorest +[common-types v6]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/common-types/resource-management/ +[directory structure article]: ./directory-structure.md +[glossary]: ./glossary.md From 0d5a4226bcd5966d15e2335a976c239431b0d414 Mon Sep 17 00:00:00 2001 From: Jim Chou <77021369+jimchou-dev@users.noreply.github.com> Date: Fri, 7 Jun 2024 08:52:52 -0700 Subject: [PATCH 47/49] [ACS][Communication][Chat] 2024-06-05-preview public preview API spec (#28875) --- .../communicationserviceschat.json | 2209 +++++++++++++++++ ...ions_ListChatReadReceiptsWithPageSize.json | 69 + .../Conversations_SendChatReadReceipt.json | 45 + .../examples/Images_DeleteChatImage.json | 11 + .../examples/Images_GetChatImage.json | 17 + .../examples/Images_UploadChatImage.json | 21 + .../examples/Messages_DeleteChatMessage.json | 43 + .../examples/Messages_GetChatMessage.json | 65 + ...Messages_ListChatMessagesWithPageSize.json | 189 ++ .../examples/Messages_SendChatMessage.json | 57 + .../Messages_SendTypingNotification.json | 45 + .../examples/Messages_UpdateChatMessage.json | 51 + .../Participants_AddChatParticipants.json | 91 + ...ants_ListChatParticipantsWithPageSize.json | 69 + .../Participants_RemoveChatParticipant.json | 48 + .../examples/Threads_CreateChatThread.json | 111 + ..._CreateChatThreadWithIdempotencyToken.json | 112 + .../examples/Threads_DeleteChatThread.json | 42 + .../examples/Threads_GetChatThread.json | 57 + .../Threads_ListChatThreadsWithPageSize.json | 74 + .../Threads_UpdateChatThreadTopic.json | 46 + .../communication/data-plane/Chat/readme.md | 11 + 22 files changed, 3483 insertions(+) create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/communicationserviceschat.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Conversations_ListChatReadReceiptsWithPageSize.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Conversations_SendChatReadReceipt.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_DeleteChatImage.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_GetChatImage.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_UploadChatImage.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_DeleteChatMessage.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_GetChatMessage.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_ListChatMessagesWithPageSize.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendChatMessage.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendTypingNotification.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_UpdateChatMessage.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_AddChatParticipants.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_ListChatParticipantsWithPageSize.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_RemoveChatParticipant.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThread.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThreadWithIdempotencyToken.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_DeleteChatThread.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_GetChatThread.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_ListChatThreadsWithPageSize.json create mode 100644 specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_UpdateChatThreadTopic.json diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/communicationserviceschat.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/communicationserviceschat.json new file mode 100644 index 000000000000..a10260e6a30d --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/communicationserviceschat.json @@ -0,0 +1,2209 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Communication Chat Service", + "description": "Azure Communication Chat Service", + "version": "2024-06-05-preview" + }, + "paths": { + "/chat/threads/{chatThreadId}/readReceipts": { + "get": { + "tags": [ + "Threads" + ], + "summary": "Gets chat message read receipts for a thread.", + "operationId": "ChatThread_ListChatReadReceipts", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to get the chat message read receipts for.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of chat message read receipts to be returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skip", + "description": "Skips chat message read receipts up to a specified position in response.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns the requested `ChatMessageReadReceipt` resources.", + "schema": { + "$ref": "#/definitions/ChatMessageReadReceiptsCollection" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get thread read receipts with pagination (max page size)": { + "$ref": "./examples/Conversations_ListChatReadReceiptsWithPageSize.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + }, + "post": { + "tags": [ + "Threads" + ], + "summary": "Sends a read receipt event to a thread, on behalf of a user.", + "operationId": "ChatThread_SendChatReadReceipt", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to send the read receipt event to.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "sendReadReceiptRequest", + "description": "Read receipt details.", + "required": true, + "schema": { + "$ref": "#/definitions/SendReadReceiptRequest" + } + } + ], + "responses": { + "200": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Send read receipt": { + "$ref": "./examples/Conversations_SendChatReadReceipt.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/messages": { + "post": { + "tags": [ + "Messages" + ], + "summary": "Sends a message to a thread.", + "operationId": "ChatThread_SendChatMessage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to send the message to.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "sendChatMessageRequest", + "description": "Details of the message to send.", + "required": true, + "schema": { + "$ref": "#/definitions/SendChatMessageRequest" + } + } + ], + "responses": { + "201": { + "description": "Message sent, the `Location` header contains the URL for the newly sent message.", + "schema": { + "$ref": "#/definitions/SendChatMessageResult" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Send Message": { + "$ref": "./examples/Messages_SendChatMessage.json" + } + } + }, + "get": { + "tags": [ + "Messages" + ], + "summary": "Gets a list of messages from a thread.", + "operationId": "ChatThread_ListChatMessages", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id of the message.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of messages to be returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "startTime", + "description": "The earliest point in time to get messages after. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ChatMessagesCollection" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get messages with pagination (max page size)": { + "$ref": "./examples/Messages_ListChatMessagesWithPageSize.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/chat/threads/{chatThreadId}/messages/{chatMessageId}": { + "get": { + "tags": [ + "Messages" + ], + "summary": "Gets a message by id.", + "operationId": "ChatThread_GetChatMessage", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMessageId", + "description": "The message id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns a `Message` resource.", + "schema": { + "$ref": "#/definitions/ChatMessage" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Message": { + "$ref": "./examples/Messages_GetChatMessage.json" + } + } + }, + "patch": { + "tags": [ + "Messages" + ], + "summary": "Updates a message.", + "operationId": "ChatThread_UpdateChatMessage", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMessageId", + "description": "The message id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "updateChatMessageRequest", + "description": "Details of the request to update the message.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateChatMessageRequest" + } + } + ], + "responses": { + "204": { + "description": "Message is successfully updated." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Update message content": { + "$ref": "./examples/Messages_UpdateChatMessage.json" + } + } + }, + "delete": { + "tags": [ + "Messages" + ], + "summary": "Deletes a message.", + "operationId": "ChatThread_DeleteChatMessage", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMessageId", + "description": "The message id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Delete message": { + "$ref": "./examples/Messages_DeleteChatMessage.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/participants": { + "get": { + "tags": [ + "Participants" + ], + "summary": "Gets the participants of a thread.", + "operationId": "ChatThread_ListChatParticipants", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to get participants for.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of participants to be returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skip", + "description": "Skips participants up to a specified position in response.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns the participants of a thread.", + "schema": { + "$ref": "#/definitions/ChatParticipantsCollection" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get participants with pagination (max page size)": { + "$ref": "./examples/Participants_ListChatParticipantsWithPageSize.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/chat/threads/{chatThreadId}/participants/:remove": { + "post": { + "tags": [ + "Participants" + ], + "summary": "Remove a participant from a thread.", + "operationId": "ChatThread_RemoveChatParticipant", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to remove the participant from.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "participantCommunicationIdentifier", + "description": "Id of the thread participant to remove from the thread.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Remove participant": { + "$ref": "./examples/Participants_RemoveChatParticipant.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/participants/:add": { + "post": { + "tags": [ + "Participants" + ], + "summary": "Adds thread participants to a thread. If participants already exist, no change occurs.", + "operationId": "ChatThread_AddChatParticipants", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Id of the thread to add participants to.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "addChatParticipantsRequest", + "description": "Thread participants to be added to the thread.", + "required": true, + "schema": { + "$ref": "#/definitions/AddChatParticipantsRequest" + } + } + ], + "responses": { + "201": { + "description": "The participants were successfully added.", + "schema": { + "$ref": "#/definitions/AddChatParticipantsResult" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Add participants": { + "$ref": "./examples/Participants_AddChatParticipants.json" + } + } + } + }, + "/chat/threads": { + "post": { + "tags": [ + "Threads" + ], + "summary": "Creates a chat thread.", + "operationId": "Chat_CreateChatThread", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "repeatability-request-id", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.", + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "createChatThreadRequest", + "description": "Request payload for creating a chat thread.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateChatThreadRequest" + } + } + ], + "responses": { + "201": { + "description": "Thread created, the `Location` header would contain the URL for the newly created thread.", + "schema": { + "$ref": "#/definitions/CreateChatThreadResult" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Create chat thread": { + "$ref": "./examples/Threads_CreateChatThread.json" + }, + "Create chat thread with repeatability request id header": { + "$ref": "./examples/Threads_CreateChatThreadWithIdempotencyToken.json" + } + } + }, + "get": { + "tags": [ + "Threads" + ], + "summary": "Gets the list of chat threads of a user.", + "operationId": "Chat_ListChatThreads", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of chat threads returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "startTime", + "description": "The earliest point in time to get chat threads up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns a `GetThreadsResponse` resource.", + "schema": { + "$ref": "#/definitions/ChatThreadsItemCollection" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get threads with pagination (Max Page Size)": { + "$ref": "./examples/Threads_ListChatThreadsWithPageSize.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/chat/threads/{chatThreadId}": { + "patch": { + "tags": [ + "Threads" + ], + "summary": "Updates a thread's properties.", + "operationId": "ChatThread_UpdateChatThreadProperties", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The id of the thread to update.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "updateChatThreadRequest", + "description": "Request payload for updating a chat thread.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateChatThreadRequest" + } + } + ], + "responses": { + "204": { + "description": "Thread was successfully updated." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Update chat thread topic": { + "$ref": "./examples/Threads_UpdateChatThreadTopic.json" + } + } + }, + "get": { + "tags": [ + "Threads" + ], + "summary": "Gets a chat thread's properties.", + "operationId": "ChatThread_GetChatThreadProperties", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Id of the thread.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns a chat thread.", + "schema": { + "$ref": "#/definitions/ChatThreadProperties" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get chat thread": { + "$ref": "./examples/Threads_GetChatThread.json" + } + } + }, + "delete": { + "tags": [ + "Threads" + ], + "summary": "Deletes a thread.", + "operationId": "Chat_DeleteChatThread", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Id of the thread to be deleted.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Delete chat thread": { + "$ref": "./examples/Threads_DeleteChatThread.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/typing": { + "post": { + "tags": [ + "TypingNotifications" + ], + "summary": "Posts a typing event to a thread, on behalf of a user.", + "operationId": "ChatThread_SendTypingNotification", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Id of the thread.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "sendTypingNotificationRequest", + "description": "Details of the typing notification request.", + "schema": { + "$ref": "#/definitions/SendTypingNotificationRequest" + } + } + ], + "responses": { + "200": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Post typing event to a thread": { + "$ref": "./examples/Messages_SendTypingNotification.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/images": { + "post": { + "tags": [ + "Images" + ], + "summary": "Upload an image in a thread, on behalf of a user.", + "operationId": "ChatThread_UploadChatImage", + "consumes": [ + "application/octet-stream" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "image-filename", + "description": "The file name of the image.", + "required": false, + "type": "string" + }, + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id where the uploaded image belongs to. (Teams meeting only)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "chatImageFile", + "description": "Image binary data, allowed image formats: jpeg, png, gif, heic, webp", + "required": true, + "schema": { + "$ref": "#/definitions/ChatImageFile" + } + } + ], + "responses": { + "201": { + "description": "Uploaded successfully, the `Location` header contains the URL for the newly uploaded image.", + "schema": { + "$ref": "#/definitions/UploadChatImageResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upload Image": { + "$ref": "./examples/Images_UploadChatImage.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/images/{imageId}/view/{imageViewType}": { + "get": { + "tags": [ + "Images" + ], + "summary": "Get an image by view type.", + "operationId": "ChatThread_GetChatImage", + "produces": [ + "application/json", + "image/gif", + "image/jpeg", + "image/png", + "image/bmp", + "image/tiff" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "imageId", + "description": "The image id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "imageViewType", + "description": "The view type of image.", + "required": true, + "enum": [ + "original", + "small" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageViewType", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Image binary data", + "schema": { + "$ref": "#/definitions/ChatImageFile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete message": { + "$ref": "./examples/Images_GetChatImage.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/images/{imageId}": { + "delete": { + "tags": [ + "Images" + ], + "summary": "Deletes a image.", + "operationId": "ChatThread_DeleteChatImage", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "imageId", + "description": "The image id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete message": { + "$ref": "./examples/Images_DeleteChatImage.json" + } + } + } + } + }, + "definitions": { + "CommunicationUserIdentifierModel": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationUserIdentifierModel" + }, + "CommunicationCloudEnvironment": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationCloudEnvironmentModel" + }, + "MicrosoftTeamsUserIdentifierModel": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/MicrosoftTeamsUserIdentifierModel" + }, + "MicrosoftTeamsAppIdentifierModel": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/MicrosoftTeamsAppIdentifierModel" + }, + "CommunicationIdentifierModel": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" + }, + "ChatMessageReadReceipt": { + "description": "A chat message read receipt indicates the time a chat message was read by a recipient.", + "required": [ + "chatMessageId", + "readOn", + "senderCommunicationIdentifier" + ], + "type": "object", + "properties": { + "senderCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "chatMessageId": { + "description": "Id of the chat message that has been read. This id is generated by the server.", + "type": "string", + "example": "1591137790240" + }, + "readOn": { + "format": "date-time", + "description": "The time at which the message was read. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ChatMessageReadReceiptsCollection": { + "description": "A paged collection of chat message read receipts.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of chat message read receipts.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatMessageReadReceipt" + } + }, + "nextLink": { + "description": "If there are more chat message read receipts that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "CommunicationError": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationError" + }, + "CommunicationErrorResponse": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationErrorResponse" + }, + "ErrorResponse": { + "type": "object", + "description": "Wrapper for error response to follow ARM guidelines.", + "properties": { + "error": { + "description": "The error response.", + "$ref": "#/definitions/Error" + } + } + }, + "Error": { + "type": "object", + "description": "Error response information.", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "array", + "description": "An array of error detail objects.", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-identifiers": [ + "code" + ] + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorDetail": { + "type": "object", + "description": "Error detail information.", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + } + }, + "required": [ + "code", + "message" + ] + }, + "SendReadReceiptRequest": { + "description": "Request payload for sending a read receipt.", + "required": [ + "chatMessageId" + ], + "type": "object", + "properties": { + "chatMessageId": { + "description": "Id of the latest chat message read by the user.", + "type": "string", + "example": "1592435762364" + } + } + }, + "ChatMessageType": { + "description": "The chat message type.", + "enum": [ + "text", + "html", + "topicUpdated", + "participantAdded", + "participantRemoved" + ], + "type": "string", + "x-ms-enum": { + "name": "ChatMessageType", + "modelAsString": true + }, + "example": "html" + }, + "SendChatMessageRequest": { + "description": "Details of the message to send.", + "required": [ + "content" + ], + "type": "object", + "properties": { + "content": { + "description": "Chat message content.", + "type": "string", + "example": "

Come one guys, lets go for lunch together.

" + }, + "senderDisplayName": { + "description": "The display name of the chat message sender. This property is used to populate sender name for push notifications.", + "type": "string", + "example": "Bob Admin" + }, + "type": { + "$ref": "#/definitions/ChatMessageType" + }, + "metadata": { + "description": "Message metadata.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "attachments": { + "description": "The array of attachments", + "type": "array", + "items": { + "$ref": "#/definitions/ChatAttachment" + } + } + } + }, + "SendChatMessageResult": { + "description": "Result of the send message operation.", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "A server-generated message id.", + "type": "string", + "example": "123456789" + } + } + }, + "ChatParticipant": { + "description": "A participant of the chat thread.", + "required": [ + "communicationIdentifier" + ], + "type": "object", + "properties": { + "communicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "displayName": { + "description": "Display name for the chat participant.", + "type": "string", + "example": "Bob" + }, + "shareHistoryTime": { + "format": "date-time", + "description": "Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "metadata": { + "description": "Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ChatAttachmentType": { + "description": "The type of attachment.", + "enum": [ + "image", + "file" + ], + "type": "string", + "x-ms-enum": { + "name": "ChatAttachmentType", + "modelAsString": true + } + }, + "ChatAttachment": { + "description": "An attachment in a chat message. Currently only supported in Teams Interop scenarios.", + "required": [ + "id", + "attachmentType" + ], + "type": "object", + "properties": { + "id": { + "description": "Id of the attachment", + "type": "string", + "example": "f508ce15-e878-431f-b871-f530cac5331d" + }, + "attachmentType": { + "$ref": "#/definitions/ChatAttachmentType" + }, + "name": { + "description": "The name of the attachment content.", + "type": "string", + "example": "SomeImage.png" + }, + "url": { + "description": "The URL where the attachment can be downloaded", + "type": "string", + "format": "uri", + "example": "https://{geoChatGW}/threads/{chatThreadId}/images/{imageId}/views/original" + }, + "previewUrl": { + "description": "The URL where the preview of attachment can be downloaded", + "type": "string", + "format": "uri", + "example": "https://{geoChatGW}/threads/{chatThreadId}/images/{imageId}/views/small" + } + } + }, + "ChatMessageContent": { + "description": "Content of a chat message.", + "type": "object", + "properties": { + "message": { + "description": "Chat message content for messages of types text or html.", + "type": "string", + "example": "

Come one guys, lets go for lunch together.

" + }, + "topic": { + "description": "Chat message content for messages of type topicUpdated.", + "type": "string", + "example": "Lunch Chat thread" + }, + "participants": { + "description": "Chat message content for messages of types participantAdded or participantRemoved.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + }, + "attachments": { + "description": "List of attachments for this message", + "type": "array", + "items": { + "$ref": "#/definitions/ChatAttachment" + } + }, + "initiatorCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + } + }, + "ChatMessage": { + "description": "Chat message.", + "required": [ + "createdOn", + "id", + "sequenceId", + "type", + "version" + ], + "type": "object", + "properties": { + "id": { + "description": "The id of the chat message. This id is server generated.", + "type": "string", + "example": "123456789" + }, + "type": { + "$ref": "#/definitions/ChatMessageType" + }, + "sequenceId": { + "description": "Sequence of the chat message in the conversation.", + "type": "string" + }, + "version": { + "description": "Version of the chat message.", + "type": "string" + }, + "content": { + "$ref": "#/definitions/ChatMessageContent" + }, + "senderDisplayName": { + "description": "The display name of the chat message sender. This property is used to populate sender name for push notifications.", + "type": "string", + "example": "Jane" + }, + "createdOn": { + "format": "date-time", + "description": "The timestamp when the chat message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "senderCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "deletedOn": { + "format": "date-time", + "description": "The timestamp (if applicable) when the message was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "editedOn": { + "format": "date-time", + "description": "The last timestamp (if applicable) when the message was edited. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "metadata": { + "description": "Message metadata.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "policyViolation": { + "$ref": "#/definitions/PolicyViolation" + } + } + }, + "ChatMessagesCollection": { + "description": "Collection of chat messages for a particular chat thread.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of chat messages.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatMessage" + } + }, + "nextLink": { + "description": "If there are more chat messages that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateChatMessageRequest": { + "description": "Request payload for updating a chat message.", + "type": "object", + "properties": { + "content": { + "description": "Chat message content.", + "type": "string", + "example": "Let's go for lunch together." + }, + "metadata": { + "description": "Message metadata.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "attachments": { + "description": "The array of attachments", + "type": "array", + "items": { + "$ref": "#/definitions/ChatAttachment" + } + } + } + }, + "ChatParticipantsCollection": { + "description": "Collection of participants belong to a particular thread.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Chat participants.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + }, + "nextLink": { + "description": "If there are more chat participants that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "AddChatParticipantsRequest": { + "description": "Participants to be added to the thread.", + "required": [ + "participants" + ], + "type": "object", + "properties": { + "participants": { + "description": "Participants to add to a chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + } + } + }, + "AddChatParticipantsResult": { + "description": "Result of the add chat participants operation.", + "type": "object", + "properties": { + "invalidParticipants": { + "description": "The participants that failed to be added to the chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationError" + }, + "readOnly": true + } + } + }, + "CreateChatThreadRequest": { + "description": "Request payload for creating a chat thread.", + "required": [ + "topic" + ], + "type": "object", + "properties": { + "topic": { + "description": "The chat thread topic.", + "type": "string", + "example": "Lunch Thread" + }, + "participants": { + "description": "Participants to be added to the chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + }, + "metadata": { + "description": "Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "retentionPolicy": { + "$ref": "#/definitions/ChatRetentionPolicy" + } + } + }, + "ChatThreadProperties": { + "description": "Chat thread.", + "required": [ + "createdByCommunicationIdentifier", + "createdOn", + "id", + "topic" + ], + "type": "object", + "properties": { + "id": { + "description": "Chat thread id.", + "type": "string", + "example": "19:uni01_uy5ucb66ugp3lrhe7pxso6xx4hsmm3dl6eyjfefv2n6x3rrurpea@thread.v2" + }, + "topic": { + "description": "Chat thread topic.", + "type": "string", + "example": "Lunch Chat thread" + }, + "createdOn": { + "format": "date-time", + "description": "The timestamp when the chat thread was created. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "createdByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "deletedOn": { + "format": "date-time", + "description": "The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "metadata": { + "description": "Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "retentionPolicy": { + "$ref": "#/definitions/ChatRetentionPolicy" + }, + "messagingPolicy": { + "$ref": "#/definitions/MessagingPolicy" + } + } + }, + "CreateChatThreadResult": { + "description": "Result of the create chat thread operation.", + "type": "object", + "properties": { + "chatThread": { + "$ref": "#/definitions/ChatThreadProperties" + }, + "invalidParticipants": { + "description": "The participants that failed to be added to the chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationError" + }, + "readOnly": true + } + } + }, + "ChatThreadItem": { + "description": "Summary information of a chat thread.", + "required": [ + "id", + "topic" + ], + "type": "object", + "properties": { + "id": { + "description": "Chat thread id.", + "type": "string", + "example": "19:uni01_uy5ucb66ugp3lrhe7pxso6xx4hsmm3dl6eyjfefv2n6x3rrurpea@thread.v2" + }, + "topic": { + "description": "Chat thread topic.", + "type": "string", + "example": "Lunch Chat thread" + }, + "deletedOn": { + "format": "date-time", + "description": "The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "lastMessageReceivedOn": { + "format": "date-time", + "description": "The timestamp when the last message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "readOnly": true, + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ChatThreadsItemCollection": { + "description": "Collection of chat threads.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of chat threads.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatThreadItem" + } + }, + "nextLink": { + "description": "If there are more chat threads that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateChatThreadRequest": { + "description": "Request payload for updating a chat thread.", + "type": "object", + "properties": { + "topic": { + "description": "Chat thread topic.", + "type": "string", + "example": "Lunch Thread" + }, + "metadata": { + "description": "Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "retentionPolicy": { + "$ref": "#/definitions/ChatRetentionPolicy" + } + } + }, + "SendTypingNotificationRequest": { + "description": "Request payload for typing notifications.", + "type": "object", + "properties": { + "senderDisplayName": { + "description": "The display name of the typing notification sender. This property is used to populate sender name for push notifications.", + "type": "string", + "example": "Bob Admin" + } + } + }, + "ChatRetentionPolicy": { + "description": "Data retention policy for auto deletion.", + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "description": "Retention Policy Type", + "enum": [ + "threadCreationDate", + "none" + ], + "type": "string", + "x-ms-enum": { + "name": "RetentionPolicyKind", + "modelAsString": true, + "values": [ + { + "value": "threadCreationDate", + "description": "Thread retention policy based on thread creation date." + }, + { + "value": "none", + "description": "No thread retention policy" + } + ] + } + } + }, + "required": [ + "kind" + ] + }, + "ThreadCreationDateRetentionPolicy": { + "description": "Thread retention policy based on thread creation date.", + "type": "object", + "x-ms-discriminator-value": "threadCreationDate", + "allOf": [ + { + "$ref": "#/definitions/ChatRetentionPolicy" + } + ], + "properties": { + "deleteThreadAfterDays": { + "type": "integer", + "format": "int32", + "description": "Indicates how many days after the thread creation the thread will be deleted." + } + }, + "required": [ + "deleteThreadAfterDays" + ] + }, + "NoneRetentionPolicy": { + "description": "No thread retention policy.", + "type": "object", + "x-ms-discriminator-value": "none", + "allOf": [ + { + "$ref": "#/definitions/ChatRetentionPolicy" + } + ] + }, + "ChatImageFile": { + "description": "The image binary data.", + "type": "string", + "format": "binary", + "x-ms-media-kind": "image" + }, + "UploadChatImageResult": { + "description": "Result payload for uploading an image.", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "A server-generated image id.", + "type": "string", + "example": "0-eus-d2-fb42e272282ebb6ef76a3aedd1974433" + }, + "attachmentType": { + "$ref": "#/definitions/ChatAttachmentType" + }, + "name": { + "description": "The name including file extension type of the attachment.", + "type": "string", + "example": "SomeImage.png" + } + } + }, + "PolicyViolationMessageState": { + "description": "The policy violation state.", + "enum": [ + "contentBlocked", + "warning" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyViolationMessageState", + "modelAsString": true + }, + "example": "contentBlocked" + }, + "PolicyViolation": { + "description": "Policy violation of a message.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/PolicyViolationMessageState" + } + } + }, + "MessagingPolicy": { + "description": "Messaging policy for a chat thread.", + "type": "object", + "properties": { + "textOnlyChat": { + "description": "Allow text only chat with no message with attachment, if `textOnlyChat` is undefined assumed `false`.", + "type": "boolean", + "example": true + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "in": "query", + "name": "api-version", + "description": "Version of API to invoke.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Endpoint": { + "in": "path", + "name": "endpoint", + "description": "The endpoint of the Azure Communication resource.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "Authorization": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "An ACS (Azure Communication Services) user access token." + } + }, + "security": [ + { + "Authorization": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Conversations_ListChatReadReceiptsWithPageSize.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Conversations_ListChatReadReceiptsWithPageSize.json new file mode 100644 index 000000000000..0a9e16ffe410 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Conversations_ListChatReadReceiptsWithPageSize.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "maxPageSize": 2 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "chatMessageId": "1591137790240", + "readOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "chatMessageId": "1591768249318", + "readOn": "2020-06-06T05:55:41.6460000Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/readReceipts?skip=2&maxPageSize=2&api-version=2024-06-05-preview" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Conversations_SendChatReadReceipt.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Conversations_SendChatReadReceipt.json new file mode 100644 index 000000000000..31d0c6054169 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Conversations_SendChatReadReceipt.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "sendReadReceiptRequest": { + "chatMessageId": "1591137790240" + } + }, + "responses": { + "200": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_DeleteChatImage.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_DeleteChatImage.json new file mode 100644 index 000000000000..c93d9493a51c --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_DeleteChatImage.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", + "imageId": "0-eus-d2-fb42e272282ebb6ef76a3aedd1974433" + }, + "responses": { + "204": {} + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_GetChatImage.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_GetChatImage.json new file mode 100644 index 000000000000..cf975548dd7e --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_GetChatImage.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", + "imageId": "0-eus-d2-fb42e272282ebb6ef76a3aedd1974433", + "imageViewType": "original" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "image/png" + }, + "body": "{binary}" + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_UploadChatImage.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_UploadChatImage.json new file mode 100644 index 000000000000..1500a00a6092 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_UploadChatImage.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", + "chatImageFile": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVQYV2P4DwABAQEAWk1v8QAAAABJRU5ErkJggg==", + "image-filename": "sample.png" + }, + "responses": { + "201": { + "headers": { + "Location": "/chat/threads/19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2/images/0-eus-d2-fb42e272282ebb6ef76a3aedd1974433" + }, + "body": { + "id": "0-eus-d2-fb42e272282ebb6ef76a3aedd1974433", + "attachmentType": "inlineImage", + "name": "sample.png" + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_DeleteChatMessage.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_DeleteChatMessage.json new file mode 100644 index 000000000000..74e649da8c80 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_DeleteChatMessage.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "chatMessageId": "1591768249318" + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_GetChatMessage.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_GetChatMessage.json new file mode 100644 index 000000000000..60b096952cbc --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_GetChatMessage.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "chatMessageId": "1591768249318" + }, + "responses": { + "200": { + "body": { + "id": "1591768249318", + "sequenceId": "1", + "type": "text", + "version": "1599016601134", + "content": { + "message": "Let's head out for lunch in 15 minutes." + }, + "senderDisplayName": "Jane", + "createdOn": "2020-06-10T05:50:49.3180000Z", + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "metadata": { + "someKey1": "someValue1", + "someKey2": "someValue2" + } + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_ListChatMessagesWithPageSize.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_ListChatMessagesWithPageSize.json new file mode 100644 index 000000000000..e144e71b0f97 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_ListChatMessagesWithPageSize.json @@ -0,0 +1,189 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2", + "maxPageSize": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "1593108077690", + "type": "text", + "sequenceId": "6", + "version": "1593108077690", + "content": { + "message": "" + }, + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T18:01:17.6900000Z", + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "policyViolation": { + "state": "contentBlocked" + } + }, + { + "id": "1593107077690", + "type": "html", + "version": "1593107077683", + "sequenceId": "5", + "content": { + "message": "

This place for lunch? 

\r\n

\"image\"

", + "attachments": [ + { + "id": "0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73", + "attachmentType": "image", + "name": "image", + "url": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/images/0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73/views/original?api-version=2023-07-01-preview", + "previewUrl": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages/1700844519132/teamsInterop/images/0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73/views/small?api-version=2023-07-01-preview" + } + ] + }, + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T17:44:37.6830000Z", + "metadata": { + "amsreferences": "[\"0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73\"]" + }, + "senderCommunicationIdentifier": { + "rawId": "8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + { + "id": "1593107077683", + "type": "text", + "sequenceId": "4", + "version": "1593107077683", + "content": { + "message": "Let's use this chat to decide what to get for lunch today." + }, + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T17:44:37.6830000Z", + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + { + "id": "1593107046498", + "type": "text", + "sequenceId": "3", + "version": "1593107046498", + "content": { + "message": "Good morning everyone!" + }, + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T17:44:06.4980000Z", + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + { + "id": "1593106976785", + "type": "topicUpdated", + "sequenceId": "2", + "version": "1593106976785", + "content": { + "initiatorCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "topic": "Lunch" + }, + "createdOn": "2020-06-25T17:42:56.7850000Z" + }, + { + "id": "1593106976753", + "type": "participantAdded", + "version": "1593106976753", + "sequenceId": "1", + "content": { + "initiatorCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "participants": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + } + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce" + } + } + } + ] + }, + "createdOn": "2020-06-25T17:42:56.7530000Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2024-06-05-preview" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendChatMessage.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendChatMessage.json new file mode 100644 index 000000000000..be79e19effb5 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendChatMessage.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "sendChatMessageRequest": { + "content": "Let's head out for lunch in 15 minutes.", + "senderDisplayName": "Jane", + "metadata": { + "someKey1": "someValue1", + "someKey2": "someValue2" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1593072104708" + }, + "body": { + "id": "1593072104708" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendTypingNotification.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendTypingNotification.json new file mode 100644 index 000000000000..be6bf22f627d --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_SendTypingNotification.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "sendTypingNotificationRequest": { + "senderDisplayName": "Jane" + } + }, + "responses": { + "200": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_UpdateChatMessage.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_UpdateChatMessage.json new file mode 100644 index 000000000000..92fa7dcfeae9 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_UpdateChatMessage.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "content-type": "application/merge-patch+json", + "api-version": "2024-06-05-preview", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "chatMessageId": "1591768249318", + "updateChatMessageRequest": { + "content": "Updated message content", + "metadata": { + "someKey1": "someValue1", + "someKey2": "someValue2" + } + } + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_AddChatParticipants.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_AddChatParticipants.json new file mode 100644 index 000000000000..b1a48b3138f9 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_AddChatParticipants.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "addChatParticipantsRequest": { + "participants": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "displayName": "Peter", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce" + } + }, + "displayName": "Rama", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ] + } + }, + "responses": { + "201": { + "body": { + "invalidParticipants": [ + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "code": "404", + "message": "Not found" + } + ] + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_ListChatParticipantsWithPageSize.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_ListChatParticipantsWithPageSize.json new file mode 100644 index 000000000000..959dd3a631d7 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_ListChatParticipantsWithPageSize.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "maxPageSize": 2 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "displayName": "Jane", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/participants?skip=2&maxPageSize=2&api-version=2024-06-05-preview" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_RemoveChatParticipant.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_RemoveChatParticipant.json new file mode 100644 index 000000000000..fdeadcf66d7e --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Participants_RemoveChatParticipant.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "participantCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThread.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThread.json new file mode 100644 index 000000000000..a0115eebeac8 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThread.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "createChatThreadRequest": { + "topic": "Lunch", + "participants": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "displayName": "Jane" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "displayName": "Alex" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a" + } + }, + "displayName": "Bob" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b" + } + }, + "displayName": "Peter" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "body": { + "chatThread": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdByCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + } + }, + "invalidParticipants": [ + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "code": "404", + "message": "Not found" + } + ] + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThreadWithIdempotencyToken.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThreadWithIdempotencyToken.json new file mode 100644 index 000000000000..51011449d4b1 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_CreateChatThreadWithIdempotencyToken.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "idempotency-token": "35dd6e71-251b-5e29-8376-ba93d09c3fbf", + "createChatThreadRequest": { + "topic": "Lunch", + "participants": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "displayName": "Jane" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "displayName": "Alex" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a" + } + }, + "displayName": "Bob" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b" + } + }, + "displayName": "Peter" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "body": { + "chatThread": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdByCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + } + }, + "invalidParticipants": [ + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "code": "404", + "message": "Not found" + } + ] + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_DeleteChatThread.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_DeleteChatThread.json new file mode 100644 index 000000000000..243167721b3a --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_DeleteChatThread.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:9525281ac1f947fc884bcee1a9f983c2@thread.v2" + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_GetChatThread.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_GetChatThread.json new file mode 100644 index 000000000000..d3a96dbcee19 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_GetChatThread.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "responses": { + "200": { + "body": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdByCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "messagingPolicy": { + "textOnlyChat": false + } + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_ListChatThreadsWithPageSize.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_ListChatThreadsWithPageSize.json new file mode 100644 index 000000000000..c74d16378e31 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_ListChatThreadsWithPageSize.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2024-06-05-preview", + "maxPageSize": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Chat with Samantha", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:a0dfe5fc10e04a7f8d8a64d455f4196d@thread.v2", + "topic": "Presentation Brainstorming", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:uni01_n242d2bzammtwxiib7pbjtozeevjqzavzn654ku3dajocexfo2na@thread.v2", + "topic": "Chat with Alex", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:0062022a28be4e0983734f7e45cd8566@thread.v2", + "topic": "Lunch", + "deletedOn": "2020-07-07T05:55:41.6460000Z", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpe@thread.v2", + "topic": "Chat with Bob", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads?syncState=W3sic3RhcnQiOiIyMDIwLTA2LTIzVDIzOjMyOjQ3LjMwNSswMDowMCIsImVuZCI6IjIwMjAtMDYtMjVUMDY6NTY6MjMuNjk2KzAwOjAwIn0seyJzdGFydCI6IjE5NzAtMDEtMDFUMDA6MDA6MDArMDA6MDAiLCJlbmQiOiIxOTcwLTAxLTAxVDAwOjAwOjAwKzAwOjAwIn1d&api-version=2024-06-05-preview&maxPageSize=5" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_UpdateChatThreadTopic.json b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_UpdateChatThreadTopic.json new file mode 100644 index 000000000000..822393251639 --- /dev/null +++ b/specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Threads_UpdateChatThreadTopic.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "content-type": "application/merge-patch+json", + "api-version": "2024-06-05-preview", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "updateChatThreadRequest": { + "topic": "Updated Thread Topic" + } + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/readme.md b/specification/communication/data-plane/Chat/readme.md index 76da29a67609..273da7ea5e61 100644 --- a/specification/communication/data-plane/Chat/readme.md +++ b/specification/communication/data-plane/Chat/readme.md @@ -194,6 +194,17 @@ title: Azure Communication Services ``` +### Tag: package-2024-06-05-preview + +These settings apply only when `--tag=package-2024-06-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-06-05-preview' +input-file: + - preview/2024-06-05-preview/communicationserviceschat.json +title: + Azure Communication Services +``` + --- # Code Generation From 86b70ce378f0005c26b58ba0bcf96907bfa3a966 Mon Sep 17 00:00:00 2001 From: pjohari-ms <84465928+pjohari-ms@users.noreply.github.com> Date: Fri, 7 Jun 2024 15:56:05 -0500 Subject: [PATCH 48/49] [Microsoft.DocumentDB] Bug fix for preview API Version 2024-05-15-preview (#29344) * Bug fix for version 05-15-preview * Renamed models for better naming --- .../preview/2024-05-15-preview/services.json | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-05-15-preview/services.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-05-15-preview/services.json index 242e5ea9b239..34b08bbbc4f8 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-05-15-preview/services.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-05-15-preview/services.json @@ -310,7 +310,6 @@ "type": "object", "properties": { "properties": { - "x-ms-client-flatten": true, "$ref": "#/definitions/ServiceResourceCreateUpdateProperties" } } @@ -396,8 +395,8 @@ } } }, - "DataTransferServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update request for DataTransferServiceResource", + "DataTransferServiceResourceCreateUpdateProperties": { + "description": "Properties for Create or Update request for DataTransferServiceResource", "type": "object", "x-ms-discriminator-value": "DataTransfer", "allOf": [ @@ -406,8 +405,8 @@ } ] }, - "SqlDedicatedGatewayServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update request for SqlDedicatedGatewayServiceResource", + "SqlDedicatedGatewayServiceResourceCreateUpdateProperties": { + "description": "Properties for Create or Update request for SqlDedicatedGatewayServiceResource", "type": "object", "x-ms-discriminator-value": "SqlDedicatedGateway", "allOf": [ @@ -504,8 +503,8 @@ } } }, - "GraphAPIComputeServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update request for GraphAPIComputeServiceResource", + "GraphAPIComputeServiceResourceCreateUpdateProperties": { + "description": "Properties for Create or Update request for GraphAPIComputeServiceResource", "type": "object", "x-ms-discriminator-value": "GraphAPICompute", "allOf": [ @@ -544,8 +543,8 @@ } } }, - "MaterializedViewsBuilderServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update request for MaterializedViewsBuilderServiceResource", + "MaterializedViewsBuilderServiceResourceCreateUpdateProperties": { + "description": "Properties for Create or Update request for MaterializedViewsBuilderServiceResource", "type": "object", "x-ms-discriminator-value": "MaterializedViewsBuilder", "allOf": [ From e90dc8b10a5721c156af287729e41263b15ac379 Mon Sep 17 00:00:00 2001 From: Konrad Jamrozik Date: Fri, 7 Jun 2024 14:26:15 -0700 Subject: [PATCH 49/49] Update uniform-versioning.md and glossary.md: minor fixups (#29368) * Update uniform-versioning.md * Update glossary.md --- documentation/glossary.md | 2 +- documentation/uniform-versioning.md | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/documentation/glossary.md b/documentation/glossary.md index d55bbf11b9ff..84810756d853 100644 --- a/documentation/glossary.md +++ b/documentation/glossary.md @@ -39,7 +39,7 @@ A data-plane service has a path of form: > [!NOTE] > Some existing services follow different directory structure layouts. -> All such layouts are legacy, deprecated, and not allowed going forward. +> All such layouts are legacy, deprecated, and strongly discouraged going forward. For example, [`specification/containerservice/resource-manager/Microsoft.ContainerService/aks`] is a folder for the `aks` service within the `Microsoft.ContainerService` ARM Resource Provider namespace. diff --git a/documentation/uniform-versioning.md b/documentation/uniform-versioning.md index 923e8c2c0ed4..7a085b44b857 100644 --- a/documentation/uniform-versioning.md +++ b/documentation/uniform-versioning.md @@ -1,3 +1,6 @@ +| Short Link: | [aka.ms/azsdk/uniform-versioning](https://aka.ms/azsdk/uniform-versioning) | +|--|--| + # Uniform versioning > [!NOTE] @@ -11,7 +14,7 @@ In brief, it means: > If a new service API version is released, also a new documentation reference must be released to describe it. > Similarly, a new version of given SDK package must be released to refer to the new service version. -Each `service` within a `service group` can version independently of each other. +Each `service` within a `service group` or `grouping directory` can version independently of each other. ## Uniform versioning rules @@ -55,7 +58,7 @@ The **uniform versioning** has several implications and implementation decisions ### No API version mixing within a service - Nowhere within a service, documentation for it, or SDK referencing it, - can multiple service API versions be mixed. as such: + can multiple service API versions be mixed. As such: - `preview` API versions cannot be mixed with `stable` API versions. - No HTTP API endpoint for given API version can have any kind of dependency on service endpoint from any other API version. - The above apply to a stand-alone service as well as to a service that is a member of a `service group`.